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::send_monotonic_counter to metrics::sums::cumulative_monotonic_mode #8489

Closed
Tracked by #8372
mx-psi opened this issue Mar 15, 2022 · 1 comment · Fixed by #12110
Labels
data:metrics Metric related issues exporter/datadog Datadog components

Comments

@mx-psi
Copy link
Member

mx-psi commented Mar 15, 2022

What will change?

The metrics::send_monotonic_counter setting from the Datadog exporter will be renamed to metrics::sums::cumulative_monotonic_mode, which will hold an enum. The setting name was taken from the Datadog OpenMetrics integration, but its meaning is confusing and it's not in a dedicated section for the metric name.

Who is affected?

You are affected if you explicitly set metrics::send_monotonic_counter 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::send_monotonic_counter" has been deprecated in favor of "metrics::sums::cumulative_monotonic_mode" and will be removed in v0.50.0. See github.com/open-telemetry/opentelemetry-collector-contrib/issues/8489 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::send_monotonic_counter from your configuration and set metrics::sums::cumulative_monotonic_mode instead.

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

If using:

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

You can replace it by

# ...
exporters:
  datadog:
    api:
      key: ${DD_API_KEY}
    metrics:
      sums:
        cumulative_monotonic_mode: to_delta
# ...
Example with metrics::send_monotonic_counter: false (click to expand)

If using:

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

You can replace it by

# ...
exporters:
  datadog:
    api:
      key: ${DD_API_KEY}
    metrics:
      sums:
        cumulative_monotonic_mode: raw_value
# ...

When will it change?

To be filled when this happens

Change description Version of deprecation Version of removal
Renaming of metrics::send_monotonic_counter v0.48.0 v0.56.0
@mx-psi mx-psi added the exporter/datadog Datadog components label Mar 15, 2022
@mx-psi mx-psi changed the title [exporter/datadog] Rename metrics::send_monotonic_counter to metrics::sum::mode [exporter/datadog] Rename metrics::send_monotonic_counter to metrics::sum::cumulative_monotonic_mode Mar 16, 2022
@mx-psi
Copy link
Member Author

mx-psi commented Mar 16, 2022

After internal discussion, we have decided to rename to cumulative_monotonic_mode instead of mode to be explicit. I have updated the name and description accordingly

@mx-psi mx-psi changed the title [exporter/datadog] Rename metrics::send_monotonic_counter to metrics::sum::cumulative_monotonic_mode [exporter/datadog] Rename metrics::send_monotonic_counter to metrics::sums::cumulative_monotonic_mode Mar 18, 2022
@mx-psi mx-psi added the data:metrics Metric related issues label Mar 22, 2022
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