temporalio / temporalio/temporal
CLI/WebUI option to list out dynamic configs
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 23.2k
- Forks
- 1.9k
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 228
Description
Is your feature request related to a problem? Please describe.
Getting a list of dynamic configs could be simpler, the current way as described in the doc is to check the code. But one needs to
- identify version of the code they're running
- identify the corresponding git sha of that version
- Then get the https://github.com/temporalio/temporal/blob//common/dynamicconfig/constants.go .
For the complete list of dynamic configuration keys, see https://github.com/temporalio/temporal/blob/main/common/dynamicconfig/constants.go. Ensure that you check server release notes for any changes to these keys and values.
This is a cumbersome process.
Describe the solution you'd like
A CLI/Web UI option that prints out all dynamic configs KV pairs would make things much easier.
Describe alternatives you've considered
Alternatives is doing what the doc recommends. i'e cross referencing against release notes.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with common/dynamicconfig/constants.go and the linked dynamic configuration documentation to understand the existing keys and values. Then identify the current CLI and WebUI entry points for exposing server configuration. Done means users can retrieve the complete dynamic configuration key-value list without manually matching a server version to source and release notes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- backend, cli, frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100