Correction of misleading help text(#5142) #7231
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
Fixes #5142 Signed-off-by: arthursens <arthursens2005@gmail.com>
brian-brazil
reviewed
May 9, 2020
cmd/prometheus/main.go
Outdated
| @@ -204,7 +204,7 @@ func main() { | |||
| a.Flag("storage.tsdb.retention.time", "How long to retain samples in storage. When this flag is set it overrides \"storage.tsdb.retention\". If neither this flag nor \"storage.tsdb.retention\" nor \"storage.tsdb.retention.size\" is set, the retention time defaults to "+defaultRetentionString+". Units Supported: y, w, d, h, m, s, ms."). | |||
| SetValue(&newFlagRetentionDuration) | |||
|
|
|||
| a.Flag("storage.tsdb.retention.size", "[EXPERIMENTAL] Maximum number of bytes that can be stored for blocks. Units supported: KB, MB, GB, TB, PB. This flag is experimental and can be changed in future releases."). | |||
| a.Flag("storage.tsdb.retention.size", "[EXPERIMENTAL] Maximum number of bytes that can be stored for blocks. Make sure to specify the unit suffix. Ex: \"512MB\". Units supported: KB, MB, GB, TB, PB. This flag is experimental and can be changed in future releases."). | |||
There was a problem hiding this comment.
B is also supported.
The new text doesn't feel right. Maybe something like A unit is required, supported units:
There was a problem hiding this comment.
Be aware that a unit is required, supported units: B, KB, MB, GB, TB, PB. Ex: "512MB"
Is that ok?
Signed-off-by: arthursens <arthursens2005@gmail.com>
cmd/prometheus/main.go
Outdated
| @@ -204,7 +204,7 @@ func main() { | |||
| a.Flag("storage.tsdb.retention.time", "How long to retain samples in storage. When this flag is set it overrides \"storage.tsdb.retention\". If neither this flag nor \"storage.tsdb.retention\" nor \"storage.tsdb.retention.size\" is set, the retention time defaults to "+defaultRetentionString+". Units Supported: y, w, d, h, m, s, ms."). | |||
| SetValue(&newFlagRetentionDuration) | |||
|
|
|||
| a.Flag("storage.tsdb.retention.size", "[EXPERIMENTAL] Maximum number of bytes that can be stored for blocks. Make sure to specify the unit suffix. Ex: \"512MB\". Units supported: KB, MB, GB, TB, PB. This flag is experimental and can be changed in future releases."). | |||
| a.Flag("storage.tsdb.retention.size", "[EXPERIMENTAL] Maximum number of bytes that can be stored for blocks. Be aware that a unit is required, supported units: B, KB, MB, GB, TB, PB. Ex: \"512MB\". This flag is experimental and can be changed in future releases."). | |||
There was a problem hiding this comment.
No need for "Be aware that", it doesn't add anything.
|
Should we add EB too? |
|
If it's supported but missing, we should add it. |
|
And is EB supported? I am reading the code but can't seem to find anything on that If someone could show me where this flag is used on tsdb just so I can better understand the code... I would really appreciate it 😅 |
|
This handling all comes from upstream, which does have it: https://github.com/alecthomas/units/blob/master/bytes.go |
Added EB as supported unit in 'storage.tsdb.retention.size' help text, also com storage documentation Signed-off-by: arthursens <arthursens2005@gmail.com>
|
Thanks! |
|
thank you for your help in this pr |
kakkoyun
pushed a commit
to kakkoyun/prometheus
that referenced
this pull request
Jun 8, 2020
* Correction of misleading help text(prometheus#5142) Signed-off-by: arthursens <arthursens2005@gmail.com>
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.
It's my first PR to prometheus, so if I did anything wrong please tell me and I will be glad to fix any problem
Fixes #5142