Add command to dump dynamic config values (#421) #8676
Conversation
vaibhavyadav-dev
changed the title
…tps://github.com/vaibhavyadav-dev/temporal into added-tdbg-command-to-dump-dynamic-config-values
dnr
left a comment
dnr
left a comment
There was a problem hiding this comment.
please regenerate with the correct versions of protoc/protoc-gen-go to avoid the unrelated generated file changes
| } | ||
| } | ||
|
|
||
| func (c *Collection) GetClient() Client { |
There was a problem hiding this comment.
is this used anywhere? I'd prefer not exposing the underlying Client if we don't really need to
| return err | ||
| } | ||
| func (s {{$P.Name}}TypedConstrainedDefaultSetting[T]) DefaultValue() any { | ||
| return s.cdef |
There was a problem hiding this comment.
this feels weird, s.cdef is a []TypedConstrainedValue[T], which is a type that's going to be pretty hard/awkward for any client code to use. I suppose you're only using it serialize to json or something, so it doesn't really matter what the type is?
| hasDefaultConstraint = true | ||
| } | ||
| } | ||
| // add default value if not present |
There was a problem hiding this comment.
this feels kind of weird. why do we need to insert the default values here? first of all, it doesn't work for settings with multiple constrained defaults. second, it's using more memory for something we don't actually need for looking up settings. why can't the code to retrieve settings just have logic to get the default from the registry instead of doing it here? it needs that anyway to get the default for a setting that's not preset in the file at all, right?
| globalRegistry registry | ||
| ) | ||
|
|
||
| func GetDefaultValueForKey(k Key) ConstrainedValue { |
There was a problem hiding this comment.
as above, this just doesn't make any sense for settings with constrained default values, there is no single default.
| - value: true | ||
| history.hostLevelCacheMaxSize: | ||
| - value: 8192 | ||
| - value: 8000 |
There was a problem hiding this comment.
My bad, I did this to test my changes and forgot revert it.
|
|
||
| message ConstrainedValue { | ||
| Constraints constraints = 1; | ||
| google.protobuf.Struct value = 2; |
There was a problem hiding this comment.
hmm, shouldn't it be a google.protobuf.Value instead? most configs are scalars, there are structs and lists but they're not the majority.
There was a problem hiding this comment.
I'm not sure it should be Value, should we just dump the struct as JSON? It could be simpler. But Value would be better than Struct, agree.
| "go.temporal.io/server/api/adminservice/v1" | ||
| clusterspb "go.temporal.io/server/api/cluster/v1" | ||
| commonspb "go.temporal.io/server/api/common/v1" | ||
| dc "go.temporal.io/server/api/dynamicconfig/v1" |
There was a problem hiding this comment.
import should be named dynamicconfigspb ("spb" for "server proto buf")
| } | ||
|
|
||
| protoValues := make([]*dc.ConstrainedValue, 0) | ||
| for _, ConstrainedValue := range dcEntry { |
There was a problem hiding this comment.
use lowercase for variable names
| for _, ConstrainedValue := range dcEntry { | |
| for _, cv := range dcEntry { |
| dcEntry = append(dcEntry, defaultValue) | ||
| } | ||
|
|
||
| protoValues := make([]*dc.ConstrainedValue, 0) |
There was a problem hiding this comment.
| protoValues := make([]*dc.ConstrainedValue, 0) | |
| protoValues := make([]*dc.ConstrainedValue, 0, len(dcEntry)) |
or assign to specific indexes. or use util.MapSlice.
| } | ||
|
|
||
| message GetDynamicConfigurationsResponse { | ||
| repeated HostConfig host_config = 1; |
There was a problem hiding this comment.
why repeated? do we allow querying multiple hosts at once?
There was a problem hiding this comment.
Not now, but do have plan to make so.
There was a problem hiding this comment.
This was my idea, so you can compare dynamic configs across hosts. This will be a future capability though.
|
Thanks for the review @dnr I'm considering two alternatives.
Which approach would you prefer? I'm leaning toward first one as it's simpler and provides value for operators troubleshooting config issues. |
3 participants
What changed?
Added an admin command that dump all frontend dynamic config values,
Why?
Operators currently cannot easily inspect frontend runtime dynamic configuration, dumping values aids troubleshooting, incident response, and verification after config changes.
How did you test it?
Closes #421