Repository navigation
Conversation
A counter without the _total suffix is written with type unknown, but the encoder still wrote its exemplar and, with WithCreatedLines, a _created line. OpenMetrics 1.0 allows neither for an unknown metric, and the OpenMetrics 1.0 parser in this package rejects that output. Skip both when the counter is exposed as unknown, and say so in the MetricFamilyToOpenMetrics documentation. Signed-off-by: Ismail Tarim <ismailtarim7@gmail.com>
This file contains hidden or 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
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.
MetricFamilyToOpenMetricsexposes a counter without the_totalsuffix asunknown, "to avoid invalid OpenMetrics output" (godoc). It still writes the counter-only parts next to the unknown sample: the exemplar and, withWithCreatedLines(), a<name>_createdline.Both are invalid for an unknown metric in OpenMetrics 1.0: the spec says the sample name of an Unknown MetricPoint "MUST NOT have a suffix", and it only describes exemplars on a counter's
_totalsample and on histogram buckets. The OpenMetrics 1.0 parser in this package rejects the output (counter namedrequests):exemplar not allowed on untyped metric "requests"interleaved metric family "requests"With this change, a counter exposed as unknown gets neither of them:
Counters with the
_totalsuffix are unchanged. TheMetricFamilyToOpenMetricsdocumentation now also mentions that the exemplar and created line are omitted.Test: a new
TestCreateOpenMetricscase, which fails without the fix.go test -race ./expfmt/passes, and after the change the output parses with the OpenMetrics 1.0 parser in all three cases.@roidelapluie