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

Prometheus exporters: graduate pkg.translator.prometheus.NormalizeName feature gate #26488

Open
dashpole opened this issue Sep 6, 2023 · 7 comments
Labels

Comments

@dashpole
Copy link
Contributor

dashpole commented Sep 6, 2023

Component(s)

exporter/prometheus

Description

Second try at #20518.

We have addressed issues that arose from the initial implementation:

It is still possible for users to disable normalization in exporters by setting the add_metric_suffixes configuration option to false.

@dashpole dashpole added enhancement New feature or request needs triage New item requiring triage labels Sep 6, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Sep 6, 2023

Pinging code owners:

See Adding Labels via Comments if you do not have permissions to add labels yourself.

@bryan-aguilar
Copy link
Contributor

bryan-aguilar commented Sep 6, 2023

This requires new configuration options in the prometheus components based on this comment right?

Disregard: I missed the last sentence in the issue where the configuration option is now present.

@crobert-1
Copy link
Member

crobert-1 commented Sep 13, 2023

@dashpole Is there anything left to do for this issue, or was it completed by #26489?

@dashpole
Copy link
Contributor Author

I believe this issue will track the feature gate until it graduates to stable

jorgeancal pushed a commit to jorgeancal/opentelemetry-collector-contrib that referenced this issue Sep 18, 2023
Copy link
Contributor

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

Pinging code owners:

See Adding Labels via Comments if you do not have permissions to add labels yourself.

@github-actions github-actions bot added the Stale label Nov 13, 2023
@dashpole dashpole removed the Stale label Nov 13, 2023
yurishkuro pushed a commit to jaegertracing/documentation that referenced this issue 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 pushed a commit to jaegertracing/jaeger that referenced this issue Nov 18, 2023
## Which problem is this PR solving?
[OpenTelemetry Collector Contrib
v0.85.0](https://github.com/open-telemetry/opentelemetry-collector-contrib/releases/tag/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](https://cloud-native.slack.com/archives/CGG7NFUJ3/p1699539239671519).

## 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.

<img width="1709" alt="Screenshot 2023-11-18 at 12 31 16 pm"
src="https://github.com/jaegertracing/jaeger/assets/26584478/d36bc6bc-e99f-4858-903b-30da9aedda67">


## 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>
Copy link
Contributor

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

Pinging code owners:

See Adding Labels via Comments if you do not have permissions to add labels yourself.

@github-actions github-actions bot added the Stale label Jan 15, 2024
@dashpole dashpole removed the Stale label Jan 16, 2024
Copy link
Contributor

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

Pinging code owners:

See Adding Labels via Comments if you do not have permissions to add labels yourself.

@github-actions github-actions bot added the Stale label Mar 18, 2024
@dashpole dashpole removed the Stale label Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants