Skip to content

Commit

Permalink
change gprc server defaults
Browse files Browse the repository at this point in the history
Signed-off-by: Trevor Whitney <trevorjwhitney@gmail.com>
  • Loading branch information
trevorwhitney committed Oct 12, 2021
1 parent 2e1279d commit acaf417
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 1 deletion.
23 changes: 22 additions & 1 deletion pkg/loki/loki.go
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ func (c *Config) RegisterFlags(f *flag.FlagSet) {
"The alias 'all' can be used in the list to load a number of core modules and will enable single-binary mode. ")
f.BoolVar(&c.AuthEnabled, "auth.enabled", true, "Set to false to disable auth.")

c.Server.RegisterFlags(f)
c.registerServerFlagsWithChangedDefaultValues(f)
c.Distributor.RegisterFlags(f)
c.Querier.RegisterFlags(f)
c.IngesterClient.RegisterFlags(f)
Expand All @@ -108,6 +108,27 @@ func (c *Config) RegisterFlags(f *flag.FlagSet) {
c.QueryScheduler.RegisterFlags(f)
}

func (c *Config) registerServerFlagsWithChangedDefaultValues(fs *flag.FlagSet) {
throwaway := flag.NewFlagSet("throwaway", flag.PanicOnError)

// Register to throwaway flags first. Default values are remembered during registration and cannot be changed,
// but we can take values from throwaway flag set and reregister into supplied flags with new default values.
c.Server.RegisterFlags(throwaway)

throwaway.VisitAll(func(f *flag.Flag) {
// Ignore errors when setting new values. We have a test to verify that it works.
switch f.Name {
case "server.grpc.keepalive.min-time-between-pings":
_ = f.Value.Set("10s")

case "server.grpc.keepalive.ping-without-stream-allowed":
_ = f.Value.Set("true")
}

fs.Var(f.Value, f.Name, f.Usage)
})
}

// Clone takes advantage of pass-by-value semantics to return a distinct *Config.
// This is primarily used to parse a different flag set without mutating the original *Config.
func (c *Config) Clone() flagext.Registerer {
Expand Down
58 changes: 58 additions & 0 deletions pkg/loki/loki_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
package loki

import (
"bytes"
"flag"
"io"
"strings"
"testing"
"time"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func TestFlagDefaults(t *testing.T) {
c := Config{}

f := flag.NewFlagSet("test", flag.PanicOnError)
c.RegisterFlags(f)

buf := bytes.Buffer{}

f.SetOutput(&buf)
f.PrintDefaults()

const delim = '\n'

minTimeChecked := false
pingWithoutStreamChecked := false
for {
line, err := buf.ReadString(delim)
if err == io.EOF {
break
}

require.NoError(t, err)

if strings.Contains(line, "-server.grpc.keepalive.min-time-between-pings") {
nextLine, err := buf.ReadString(delim)
require.NoError(t, err)
assert.Contains(t, nextLine, "(default 10s)")
minTimeChecked = true
}

if strings.Contains(line, "-server.grpc.keepalive.ping-without-stream-allowed") {
nextLine, err := buf.ReadString(delim)
require.NoError(t, err)
assert.Contains(t, nextLine, "(default true)")
pingWithoutStreamChecked = true
}
}

require.True(t, minTimeChecked)
require.True(t, pingWithoutStreamChecked)

require.Equal(t, true, c.Server.GRPCServerPingWithoutStreamAllowed)
require.Equal(t, 10*time.Second, c.Server.GRPCServerMinTimeBetweenPings)
}

0 comments on commit acaf417

Please sign in to comment.