Only output config parameters that differ from the defaults for /config endpoint
#3645
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This is the example output for using auth_enabled: false
blocks_storage:
backend: filesystem
bucket_store:
sync_dir: /tmp/cortex/tsdb-sync
filesystem:
dir: ./data/tsdb
tsdb:
dir: /tmp/cortex/tsdb
compactor:
data_dir: /tmp/cortex/compactor
sharding_ring:
kvstore:
store: inmemory
distributor:
shard_by_all_labels: true
frontend_worker:
match_max_concurrent: true
ingester:
lifecycler:
address: 127.0.0.1
final_sleep: 0s
min_ready_duration: 0s
num_tokens: 512
ring:
kvstore:
store: inmemory
replication_factor: 1
ingester_client:
grpc_client_config:
grpc_compression: gzip
max_send_msg_size: 104857600
ruler:
enable_api: true
storage:
local:
directory: /tmp/cortex/rules
type: local
server:
grpc_server_max_concurrent_streams: 1000
grpc_server_max_recv_msg_size: 104857600
grpc_server_max_send_msg_size: 104857600
http_listen_port: 9009
storage:
engine: blocks |
|
@simonswine I see a value in this change, but what do you think about enabling this logic via a query string parameter passed to the |
pstibrany
reviewed
Jan 6, 2021
simonswine
force-pushed
the
20210105_show_only_config_diff_towards_default
branch
2 times, most recently
from
9e55df7 to
55662d5
Compare
pstibrany
reviewed
Jan 6, 2021
simonswine
force-pushed
the
20210105_show_only_config_diff_towards_default
branch
from
55662d5 to
24cef90
Compare
simonswine
changed the title
/config endpoint/config endpoint
pstibrany
approved these changes
Jan 6, 2021
3 tasks
This adds a `mode` query parameter for the config endpoint: - `/config?mode=diff`: Shows the YAML configuration with all values that differ from the defaults. - `/config?mode=defaults`: Shows the YAML configuration with all the default values. Signed-off-by: Christian Simon <simon@swine.de>
simonswine
force-pushed
the
20210105_show_only_config_diff_towards_default
branch
from
24cef90 to
cf080b9
Compare
pracucci
approved these changes
Jan 8, 2021
Comment on lines
+86
to
+87
| defaultFS := flag.NewFlagSet("", flag.PanicOnError) | ||
| defaultConfig.RegisterFlags(defaultFS) |
There was a problem hiding this comment.
[non blocking, just FYI] You can achieve the same with flagext.DefaultValues().
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does:
This changes the behaviour of the config endpoint to only show the config values that have really changed towards the default config.
I personally get lost quite often in the very verbose output of the user's configuration that includes the defaults. This tries to solve that by only show values that differ from the defaults.
Which issue(s) this PR fixes:
Fixes #
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]