[exporter/prometheus] fix: validate metric types and help/descriptions #36356
+192
−32
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
kristinapathak
force-pushed
the
prometheus-metric-types-help
branch
from
8ad2967 to
94be2f5
Compare
kristinapathak
force-pushed
the
prometheus-metric-types-help
branch
from
94be2f5 to
c7af22a
Compare
kristinapathak
changed the title
dashpole
reviewed
Nov 13, 2024
kristinapathak
force-pushed
the
prometheus-metric-types-help
branch
from
a3e03fa to
544dc23
Compare
kristinapathak
force-pushed
the
prometheus-metric-types-help
branch
from
544dc23 to
a540704
Compare
dashpole
approved these changes
Nov 14, 2024
dashpole
added
the
ready to merge
mwear
approved these changes
Nov 15, 2024
atoulme
reviewed
Nov 18, 2024
| c.metricFamilies.Range(func(key, value any) bool { | ||
| v := value.(metricFamily) | ||
| if expirationTime.After(v.lastSeen) { | ||
| c.logger.Debug(fmt.Sprintf("metric expired: %s", key)) |
There was a problem hiding this comment.
any way to avoid calling fmt.Sprintf here
codeboten
reviewed
Nov 18, 2024
Co-authored-by: Alex Boten <223565+codeboten@users.noreply.github.com>
codeboten
reviewed
Nov 18, 2024
| @@ -403,4 +428,50 @@ func (c *collector) Collect(ch chan<- prometheus.Metric) { | |||
| ch <- m | |||
| c.logger.Debug(fmt.Sprintf("metric served: %s", m.Desc().String())) | |||
There was a problem hiding this comment.
Doesn't need to be in this PR but as a followup would be good to clean up this sprintf as well
codeboten
approved these changes
Nov 18, 2024
RutvikS-crest
pushed a commit
to RutvikS-crest/opentelemetry-collector-contrib
that referenced
this pull request
Dec 9, 2024
open-telemetry#36356) #### Description Fixes bug where exporting fails due to different help messages for the same metric. With this solution, the exporter will always export metrics of the same name with the first description it receives. This also rejects metrics whose types have changed. These changes follow the [spec](https://opentelemetry.io/docs/specs/otel/compatibility/prometheus_and_openmetrics/#metric-metadata-1): >Exporters MUST drop entire metrics to prevent conflicting TYPE comments, but SHOULD NOT drop metric points as a result of conflicting UNIT or HELP comments. Instead, all but one of the conflicting UNIT and HELP comments (but not metric points) SHOULD be dropped. If dropping a comment or metric points, the exporter SHOULD warn the user through error logging. Based on open-telemetry/opentelemetry-go#3469 #### Link to tracking issue Fixes open-telemetry#28617 <!--Describe what testing was performed and which tests were added.--> #### Testing Unit test cases added. --------- Co-authored-by: David Ashpole <dashpole@google.com> Co-authored-by: Alex Boten <223565+codeboten@users.noreply.github.com>
sbylica-splunk
pushed a commit
to sbylica-splunk/opentelemetry-collector-contrib
that referenced
this pull request
Dec 17, 2024
open-telemetry#36356) #### Description Fixes bug where exporting fails due to different help messages for the same metric. With this solution, the exporter will always export metrics of the same name with the first description it receives. This also rejects metrics whose types have changed. These changes follow the [spec](https://opentelemetry.io/docs/specs/otel/compatibility/prometheus_and_openmetrics/#metric-metadata-1): >Exporters MUST drop entire metrics to prevent conflicting TYPE comments, but SHOULD NOT drop metric points as a result of conflicting UNIT or HELP comments. Instead, all but one of the conflicting UNIT and HELP comments (but not metric points) SHOULD be dropped. If dropping a comment or metric points, the exporter SHOULD warn the user through error logging. Based on open-telemetry/opentelemetry-go#3469 #### Link to tracking issue Fixes open-telemetry#28617 <!--Describe what testing was performed and which tests were added.--> #### Testing Unit test cases added. --------- Co-authored-by: David Ashpole <dashpole@google.com> Co-authored-by: Alex Boten <223565+codeboten@users.noreply.github.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.
Description
Fixes bug where exporting fails due to different help messages for the same metric. With this solution, the exporter will always export metrics of the same name with the first description it receives. This also rejects metrics whose types have changed. These changes follow the spec:
Based on open-telemetry/opentelemetry-go#3469
Link to tracking issue
Fixes #28617
Testing
Unit test cases added.