Consider adding data transformation information when `debug` level logging is enabled.

open-telemetry / opentelemetry-collector-contrib

Contrib repository for the OpenTelemetry Collector

https://opentelemetry.io

Apache License 2.0

2.83k stars 2.22k forks source link

Consider adding data transformation information when `debug` level logging is enabled. #33009

Open bixu opened 3 months ago

bixu commented 3 months ago

Component(s)

exporter/prometheusremotewrite

Is your feature request related to a problem? Please describe.

Metric name suffixes are added automatically by default, but enabling debug level logging or the debug exporter does not show the final, Prometheus metric name in logs. This makes troubleshooting difficult in environments with very large numbers of metric names. In our case, we were stumped by this for a couple of days.

Describe the solution you'd like

For debug level logging only, it would be helpful to see the Prometheus payload in the log, or at least any data properties that have been mutated but he exporter, similar to how the OTLP debug exporter works when verbosity is set to detailed.

Describe alternatives you've considered

No response

Additional context

No response

github-actions[bot] commented 3 months ago

Pinging code owners:

exporter/prometheusremotewrite: @Aneurysm9 @rapphil

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

crobert-1 commented 3 months ago

It may end up being excessive logging, but I guess that's generally acceptable with debug logging level. I'll remove needs triage for now, but code owners or others may have more thoughts.

bixu commented 3 months ago

It may end up being excessive logging

I definitely understand the concern here. Since the debug Exporter is so verbose, it was surprising that the prometheusremotewrite exporter was not. This led to a couple of days of head-scratching in my team, even though we've been running Collectors in production for about 3 years. I'm guessing for newer users this could be even more puzzling.

github-actions[bot] commented 1 month ago

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:

exporter/prometheusremotewrite: @Aneurysm9 @rapphil

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