Adds HELP and TYPE to prometheus metrics #311
Merged
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.
Resolves #308 by adding
HELP
andTYPE
comments to the Prometheus outputs. An example is included below.There is no help text provided by the health check framework. I considered using the instance docstrings, but no luck there either. I added the fully qualified plugin name as an alternative. This way we at least know where to go digging when there is a problem. I don't love this solution, so I could be easily convinced to do something else.