Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Normalize metric names due to breaking change #4957

Merged
merged 1 commit into from
Nov 18, 2023

Conversation

albertteoh
Copy link
Contributor

@albertteoh albertteoh commented Nov 18, 2023

Which problem is this PR solving?

OpenTelemetry Collector Contrib v0.85.0 introduces a breaking change to enable normalized metric names by default:

prometheusexporters: Append prometheus type and unit suffixes by default in prometheus exporters. (open-telemetry/opentelemetry-collector-contrib#26488)
Suffixes can be disabled by setting add_metric_suffixes to false on the exporter.

Motivated by this support question.

Description of the changes

  • Updates the otel version in the example to the latest v0.89.0 release, which includes this breaking change.
  • Enable normalized metric name support.
  • Jaeger documentation/troubleshooting tips relating to this problem will added in another PR.

How was this change tested?

  • Ran locally before the change to confirm no metrics appeared in the Monitor tab after only version bump of OTEL image to v0.89.0.
  • Added the PROMETHEUS_QUERY_NORMALIZE_CALLS=true and PROMETHEUS_QUERY_NORMALIZE_DURATION=true env vars to confirm metrics appear again.
Screenshot 2023-11-18 at 12 31 16 pm

Checklist

Signed-off-by: Albert Teoh <albert@packsmith.io>
Copy link

codecov bot commented Nov 18, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a32b34e) 96.44% compared to head (296c32a) 96.47%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4957      +/-   ##
==========================================
+ Coverage   96.44%   96.47%   +0.02%     
==========================================
  Files         304      304              
  Lines       18049    18049              
==========================================
+ Hits        17408    17413       +5     
+ Misses        508      504       -4     
+ Partials      133      132       -1     
Flag Coverage Δ
unittests 96.47% <ø> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

yurishkuro pushed a commit to jaegertracing/documentation that referenced this pull request Nov 18, 2023
## Which problem is this PR solving?

Document the troubleshooting steps taken while investigating [this
support
question](https://cloud-native.slack.com/archives/CGG7NFUJ3/p1699539239671519).

One of the problems faced by users was caused by [OpenTelemetry
Collector Contrib
v0.85.0](https://github.com/open-telemetry/opentelemetry-collector-contrib/releases/tag/v0.85.0)
introducing a breaking change to enable normalized metric names by
default:

> `prometheusexporters`: Append prometheus type and unit suffixes by
default in prometheus exporters.
(open-telemetry/opentelemetry-collector-contrib#26488)
Suffixes can be disabled by setting add_metric_suffixes to false on the
exporter.

Relates to: jaegertracing/jaeger#4957

## Description of the changes
- Adds the following troubleshooting guides:
- Inspecting the Prometheus queries that Jaeger makes to fetch data for
the Monitor tab.
- Inspecting OpenTelemetry config to troubleshoot a possible cause for
missing error metrics.
- Updates only made from when SPM defaulted to supporting the
spanmetrics connector, which was
[v1.49.0](https://github.com/jaegertracing/jaeger/releases/tag/v1.49.0).

## Checklist
- [x] I have read
https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md
- [x] I have signed all commits
~- [ ] I have added unit tests for the new functionality~
~- [ ] I have run lint and test steps successfully~

---------

Signed-off-by: Albert Teoh <albert@packsmith.io>
Co-authored-by: Albert Teoh <albert@packsmith.io>
@yurishkuro yurishkuro merged commit e54337e into jaegertracing:main Nov 18, 2023
35 of 36 checks passed
@albertteoh albertteoh deleted the normalize-metric-names branch November 18, 2023 10:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants