[datadog_metric_metadata] correct consistency of type #2222
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Motivation --------- It appears that metric API has enable the distribution type on metric metadata but the result between the `PUT` and the `GET` method is not consistent: ```bash export metric_name=name_of_metric_distribution curl -X PUT "https://api.datadoghq.com/api/v1/metrics/${metric_name}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ***" \ -H "DD-APPLICATION-KEY: ***" \ -d @- << EOF {"type":"gauge"} EOF {"description":null,"short_name":null,"type":"gauge","unit":null,"per_unit":null,"statsd_interval":null,"integration":null} and then the get: $ curl -X GET "https://api.datadoghq.com/api/v1/metrics/${metric_name}" \ -H "Accept: application/json" \ -H "DD-API-KEY: ***" \ -H "DD-APPLICATION-KEY: ***" \ {"description":null,"short_name":null,"type":"distribution","unit":null,"per_unit":null,"statsd_interval":null,"integration":null} ``` this make metric type always being marked has a diff: ``` terraform plan ~ resource "datadog_metric_metadata" "metric_name" { id = "metric_name" ~ type = "distribution" -> "gauge" # (5 unchanged attributes hidden) } ``` Scope ---- Set metric type to gauge in terraform state when type return by API is distribution Test ---- Test no diff locally ```bash make build cd terraformdir terraform plan ... No changes. Your infrastructure matches the configuration. ```
fl0Lec
force-pushed
the
fl/metric-metadata-type-consistency
branch
from
1755dbc to
99b3209
Compare
jmfurlott
previously approved these changes
Jan 4, 2024
nkzou
previously approved these changes
Jan 10, 2024
maycmlee
reviewed
Jan 10, 2024
docs/resources/metric_metadata.md
Outdated
| @@ -36,7 +36,7 @@ resource "datadog_metric_metadata" "request_time" { | |||
| - `per_unit` (String) Per unit of the metric such as `second` in `bytes per second`. | |||
| - `short_name` (String) A short name of the metric. | |||
| - `statsd_interval` (Number) If applicable, statsd flush interval in seconds for the metric. | |||
| - `type` (String) Metric type such as `gauge` or `rate`. | |||
| - `type` (String) Metric type such as `count`, `gauge`, or `rate`. Updating a metric of type `distribution` is not supported. If you would like to see the `distribution` type returned, please contact Datadog support. | |||
There was a problem hiding this comment.
Suggested change
| - `type` (String) Metric type such as `count`, `gauge`, or `rate`. Updating a metric of type `distribution` is not supported. If you would like to see the `distribution` type returned, please contact Datadog support. | |
| - `type` (String) Metric type such as `count`, `gauge`, or `rate`. Updating a metric of type `distribution` is not supported. If you would like to see the `distribution` type returned, contact Datadog support. |
There was a problem hiding this comment.
It might be helpful to link "Datadog support" to https://docs.datadoghq.com/help/.
Also, since you mention contacting support, could you also add an entry to this doc so Support knows how to handle the request? https://datadoghq.atlassian.net/wiki/spaces/TS/pages/328404964/The+Public+Docs+say+Contact+Support
nkzou
approved these changes
Jan 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
It appears that metric API has enable the distribution type on metric metadata but the result between the
PUTand theGETmethod is not consistent:this make metric type always being marked has a diff:
Scope
Set metric type to gauge in terraform state when type return by API is distribution
Test
Test no diff locally
make build cd terraformdir terraform plan ... No changes. Your infrastructure matches the configuration.