Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename CLI flag: --storage.trace.maintenance-cycle to --storage.trace.blocklist_poll #862

Closed
yvrhdn opened this issue Aug 11, 2021 · 2 comments · Fixed by #897
Closed

Rename CLI flag: --storage.trace.maintenance-cycle to --storage.trace.blocklist_poll #862

yvrhdn opened this issue Aug 11, 2021 · 2 comments · Fixed by #897
Labels
good first issue Good for newcomers

Comments

@yvrhdn
Copy link
Member

yvrhdn commented Aug 11, 2021

Describe the bug
The CLI has a flag --storage.trace.maintenance-cycle

f.DurationVar(&cfg.Trace.BlocklistPoll, util.PrefixConfig(prefix, "trace.maintenance-cycle"), DefaultBlocklistPoll, "Period at which to run the maintenance cycle.")

But in the YAML config this flag corresponds with storage.trace.blocklist_poll

tempo/tempodb/config.go

Lines 30 to 31 in 9485f96

BlocklistPoll time.Duration `yaml:"blocklist_poll"`
BlocklistPollConcurrency uint `yaml:"blocklist_poll_concurrency"`

Changing this will be a breaking change.

Expected behavior
Name of YAML config options and CLI flags match with each other.

@yvrhdn yvrhdn mentioned this issue Aug 11, 2021
3 tasks
@joe-elliott
Copy link
Member

I'd prefer going the other way and rename the cli option. It will cause less headache and I think the name makes more sense.

@yvrhdn
Copy link
Member Author

yvrhdn commented Aug 11, 2021

Sure, I must have misread your comment. Agree blocklist_poll is better since this is the only thing we do.

@yvrhdn yvrhdn changed the title Rename yaml config: storage.trace.blocklist_poll to maintenance_cycle Rename CLI flag: --storage.trace.maintenance-cycle to --storage.trace.blocklist_poll Aug 11, 2021
@yvrhdn yvrhdn added the good first issue Good for newcomers label Aug 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
2 participants