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

Change default values for local directories #1072

Merged
merged 2 commits into from
Feb 8, 2022

Conversation

pracucci
Copy link
Collaborator

@pracucci pracucci commented Feb 8, 2022

What this PR does:
As agreed in #1059, in this PR I'm changing default values for local directories so that they're all based on the CWD and not conflicting each other.

Some notes:

  • Changes to -blocks-storage.tsdb.dir and -blocks-storage.bucket-store.sync-dir are not reported in the CHANGELOG because they're not breaking changed (but we decided to adjust them to make it more clear)
  • Change to -activity-tracker.filepath is not reported in the CHANGELOG because it's a new feature since last release
  • Added -ruler.rule-path=/rules to our jsonnet to not introduce a breaking change there. Other settings I've changed are already overridden in the jsonnet.

Which issue(s) this PR fixes:
Fixes #1059

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

Copy link
Member

@pstibrany pstibrany left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should improve on flag descriptions:

  • file path to store temporary rule files for the prometheus rule managers
  • Data directory in which to cache blocks and process compactions
  • Base path for data storage.

Once it's "file path" then "data directory" and finally "Base path". I think all three should say roughly the same, that it's a local directory used by given component to store files. We should also be clear about which directories have temporary files only and can be cleaned up, and which have files that need to persist between restarts.

operations/mimir/ruler.libsonnet Show resolved Hide resolved
@@ -104,7 +104,7 @@ const (

// RegisterFlags adds the flags required to config this to the given FlagSet.
func (cfg *MultitenantAlertmanagerConfig) RegisterFlags(f *flag.FlagSet) {
f.StringVar(&cfg.DataDir, "alertmanager.storage.path", "data/", "Base path for data storage.")
f.StringVar(&cfg.DataDir, "alertmanager.storage.path", "./data-alertmanager/", "Base path for data storage.")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How exactly is -alertmanager.storage.path used? Is it for local temporary files only? I think this description could improve to say that.

pkg/ruler/ruler.go Outdated Show resolved Hide resolved
@pracucci
Copy link
Collaborator Author

pracucci commented Feb 8, 2022

I think we should improve on flag descriptions:

Good idea! I revisited all involved descriptions. Can you take another look, please?

Copy link
Member

@pstibrany pstibrany left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is much improved! Thank you!

cmd/mimir/help-all.txt.tmpl Outdated Show resolved Hide resolved
Copy link
Contributor

@osg-grafana osg-grafana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix typo.

@pracucci pracucci merged commit 5a0c400 into main Feb 8, 2022
@pracucci pracucci deleted the change-local-dirs-defaults branch February 8, 2022 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Proposal: change default local directories
3 participants