Detect invalid Descs in const metrics, but also allow empty Help strings. #460
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
added 2 commits
September 17, 2018 11:50
The error of the invalid Desc is returned in that case. Signed-off-by: beorn7 <beorn@soundcloud.com>
This is in line with https://prometheus.io/docs/instrumenting/writing_clientlibs/#metric-description-and-help Since the zero value of a string in Go is `""`, we cannot distinguish between a Help string not set and an empty Help string. Thus, we just make it formally optional here with an encouragement to set it in the doc comment. In v0.10, the Help string will probably become a "normal" argument of the constructor rather than a field in an Opts struct. Signed-off-by: beorn7 <beorn@soundcloud.com>
|
LGTM 👍 |
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.
Fixes #459 .
@carlpett @brian-brazil