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

[exporter/datadog] Rename metrics::report_quantiles to metrics::summaries::mode #8845

Closed
Tracked by #8372
mx-psi opened this issue Mar 25, 2022 · 0 comments · Fixed by #12110
Closed
Tracked by #8372

[exporter/datadog] Rename metrics::report_quantiles to metrics::summaries::mode #8845

mx-psi opened this issue Mar 25, 2022 · 0 comments · Fixed by #12110
Labels
data:metrics Metric related issues exporter/datadog Datadog components

Comments

@mx-psi
Copy link
Member

mx-psi commented Mar 25, 2022

What will change?

The metrics::report_quantiles setting from the Datadog exporter will be renamed to metrics::summaries::mode, which will hold an enum. The setting name was taken from the Datadog OpenMetrics integration, but it limits future modes and it's not in a dedicated section for the metric type.

Who is affected?

You are affected if you explicitly set metrics::report_quantiles on your Datadog exporter configuration. If you are affected, a warning will be logged stating that you are using it, together with a link to this issue.

Example warning:

Deprecated: "metrics::report_quantiles" has been deprecated in favor of "metrics::summaries::mode" and will be removed in v0.50.0. See github.com/open-telemetry/opentelemetry-collector-contrib/issues/8845 for details

The default behavior of the Datadog exporter will not change.

What should I do if I am affected?

Remove any references to metrics::report_quantiles from your configuration and set metrics::summaries::mode instead.

Example with metrics::report_quantiles: true (click to expand)

If using:

# ...
exporters:
  datadog:
    api:
      key: ${DD_API_KEY}
    metrics:
      report_quantiles: true
# ...

You can replace it by

# ...
exporters:
  datadog:
    api:
      key: ${DD_API_KEY}
    metrics:
      summaries:
        mode: gauges
# ...
Example with metrics::report_quantiles: false (click to expand)

If using:

# ...
exporters:
  datadog:
    api:
      key: ${DD_API_KEY}
    metrics:
      report_quantiles: false
# ...

You can replace it by

# ...
exporters:
  datadog:
    api:
      key: ${DD_API_KEY}
    metrics:
      summaries:
        mode: noquantiles
# ...

When will it change?

To be filled when this happens

Change description Version of deprecation Version of removal
Renaming of metrics::report_quantiles v0.50.0 v0.56.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data:metrics Metric related issues exporter/datadog Datadog components
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant