Add RegisterFlagsWithPrefix to config structs #2414
Merged
Conversation
This file contains 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
All config structs now have a RegisterFlagsWithPrefix function that allows specifying a prefixed string to append to all flag names. This may be used by clients to namespace support for Promtail in a larger application (e.g., grafana/agent). When implementing this PR, I noticed a few config structs were incorrectly registering to the global flagset rather than the flagset passed to RegisterFlags. This PR also includes a fix for that and ensures every option is registered to the flagset in the parameter. Related to grafana#2405.
Codecov Report
@@ Coverage Diff @@
## master #2414 +/- ##
==========================================
+ Coverage 61.58% 61.66% +0.07%
==========================================
Files 160 160
Lines 13590 13596 +6
==========================================
+ Hits 8370 8384 +14
+ Misses 4597 4586 -11
- Partials 623 626 +3
|
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.
All config structs now have a
RegisterFlagsWithPrefixfunction that allows specifying a prefixed string to append to all flag names. This may be used by clients to namespace support for Promtail in a larger application (e.g.,grafana/agent).One exception to this is the Weaveworks server which doesn't currently have a RegisterFlagsWithPrefix function. This might be a problem down the line, but it's not a problem for my particular use case (I expose a subset of the Promtail config which doesn't include the weaveworks server).
I noticed a few config structs were incorrectly registering to the global FlagSet rather than the FlagSet passed to
RegisterFlags. This PR also includes a fix for that.Related to #2405.