Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 25 additions & 11 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -88786,8 +88786,8 @@ components:
type: boolean
include_percentiles:
description: |-
Toggle to include or exclude percentile aggregations for distribution metrics.
Only present when the `metric_type` is `distribution`.
Whether percentile aggregations are enabled for a `distribution`, `exponential_histogram`,
or `explicit_histogram` metric.
example: true
type: boolean
metric_type:
Expand Down Expand Up @@ -88818,8 +88818,8 @@ components:
type: boolean
include_percentiles:
description: |-
Toggle to include/exclude percentiles for a distribution metric.
Defaults to false. Can only be applied to metrics that have a `metric_type` of `distribution`.
Include percentile aggregations for metric types `distribution`, `exponential_histogram`,
and `explicit_histogram`. Omit this field to keep the current setting.
example: true
type: boolean
metric_type:
Expand Down Expand Up @@ -88881,19 +88881,23 @@ components:
- EXPLICIT_HISTOGRAM
MetricTagConfigurationMetricTypes:
default: gauge
description: The metric's type.
description: The metric's type. Contact your Customer Success Manager for instructions on using native histogram types.
enum:
- gauge
- count
- rate
- distribution
- exponential_histogram
- explicit_histogram
example: count
type: string
x-enum-varnames:
- GAUGE
- COUNT
- RATE
- DISTRIBUTION
- EXPONENTIAL_HISTOGRAM
- EXPLICIT_HISTOGRAM
MetricTagConfigurationResponse:
description: Response object which includes a single metric's tag configuration.
properties:
Expand Down Expand Up @@ -88923,8 +88927,8 @@ components:
type: boolean
include_percentiles:
description: |-
Toggle to include/exclude percentiles for a distribution metric.
Defaults to false. Can only be applied to metrics that have a `metric_type` of `distribution`.
Include percentile aggregations for metric types `distribution`, `exponential_histogram`,
and `explicit_histogram`. Omit this field to keep the current setting.
example: true
type: boolean
tags:
Expand Down Expand Up @@ -217178,6 +217182,16 @@ paths:
- datacenter
id: http.endpoint.request
type: manage_tags
explicit_histogram:
value:
data:
attributes:
include_percentiles: true
metric_type: explicit_histogram
tags:
- service
id: example.request.duration
type: manage_tags
schema:
$ref: "#/components/schemas/MetricTagConfigurationResponse"
description: Success
Expand Down Expand Up @@ -217213,8 +217227,8 @@ paths:
- metrics_read
patch:
description: |-
Update the tag configuration of a metric or percentile aggregations of a distribution metric or custom aggregations
of a count, rate, or gauge metric. By setting `exclude_tags_mode` to true the behavior is changed
Update the tag configuration of a metric, percentile aggregations of a distribution or native histogram metric,
or custom aggregations of a count, rate, or gauge metric. By setting `exclude_tags_mode` to true, the behavior changes
from an allow-list to a deny-list, and tags in the defined list will not be queryable.
Can only be used with application keys from users with the `Manage Tags for Metrics` permission. This endpoint requires
a tag configuration to be created first.
Expand Down Expand Up @@ -217290,8 +217304,8 @@ paths:
- metric_tags_write
post:
description: |-
Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.
Optionally, include percentile aggregations on any distribution metric. By setting `exclude_tags_mode`
Define queryable tag keys for an existing count, gauge, rate, distribution, or native histogram metric.
Distribution and native histogram metrics support percentile aggregations. By setting `exclude_tags_mode`
to true, the behavior is changed from an allow-list to a deny-list, and tags in the defined list are
not queryable. Can only be used with application keys of users with the `Manage Tags for Metrics`
permission.
Expand Down
8 changes: 4 additions & 4 deletions src/datadog_api_client/v2/api/metrics_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -1099,8 +1099,8 @@ def create_tag_configuration(
) -> MetricTagConfigurationResponse:
"""Create a tag configuration.

Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.
Optionally, include percentile aggregations on any distribution metric. By setting ``exclude_tags_mode``
Define queryable tag keys for an existing count, gauge, rate, distribution, or native histogram metric.
Distribution and native histogram metrics support percentile aggregations. By setting ``exclude_tags_mode``
to true, the behavior is changed from an allow-list to a deny-list, and tags in the defined list are
not queryable. Can only be used with application keys of users with the ``Manage Tags for Metrics``
permission.
Expand Down Expand Up @@ -2201,8 +2201,8 @@ def update_tag_configuration(
) -> MetricTagConfigurationResponse:
"""Update a tag configuration.

Update the tag configuration of a metric or percentile aggregations of a distribution metric or custom aggregations
of a count, rate, or gauge metric. By setting ``exclude_tags_mode`` to true the behavior is changed
Update the tag configuration of a metric, percentile aggregations of a distribution or native histogram metric,
or custom aggregations of a count, rate, or gauge metric. By setting ``exclude_tags_mode`` to true, the behavior changes
from an allow-list to a deny-list, and tags in the defined list will not be queryable.
Can only be used with application keys from users with the ``Manage Tags for Metrics`` permission. This endpoint requires
a tag configuration to be created first.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,11 @@ def __init__(
Defaults to false. Requires ``tags`` property.
:type exclude_tags_mode: bool, optional

:param include_percentiles: Toggle to include or exclude percentile aggregations for distribution metrics.
Only present when the ``metric_type`` is ``distribution``.
:param include_percentiles: Whether percentile aggregations are enabled for a ``distribution`` , ``exponential_histogram`` ,
or ``explicit_histogram`` metric.
:type include_percentiles: bool, optional

:param metric_type: The metric's type.
:param metric_type: The metric's type. Contact your Customer Success Manager for instructions on using native histogram types.
:type metric_type: MetricTagConfigurationMetricTypes, optional

:param modified_at: Timestamp when the tag configuration was last modified.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,11 @@ def __init__(
Defaults to false. Requires ``tags`` property.
:type exclude_tags_mode: bool, optional

:param include_percentiles: Toggle to include/exclude percentiles for a distribution metric.
Defaults to false. Can only be applied to metrics that have a ``metric_type`` of ``distribution``.
:param include_percentiles: Include percentile aggregations for metric types ``distribution`` , ``exponential_histogram`` ,
and ``explicit_histogram``. Omit this field to keep the current setting.
:type include_percentiles: bool, optional

:param metric_type: The metric's type.
:param metric_type: The metric's type. Contact your Customer Success Manager for instructions on using native histogram types.
:type metric_type: MetricTagConfigurationMetricTypes

:param tags: A list of tag keys that will be queryable for your metric.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@

class MetricTagConfigurationMetricTypes(ModelSimple):
"""
The metric's type.
The metric's type. Contact your Customer Success Manager for instructions on using native histogram types.

:param value: If omitted defaults to "gauge". Must be one of ["gauge", "count", "rate", "distribution"].
:param value: If omitted defaults to "gauge". Must be one of ["gauge", "count", "rate", "distribution", "exponential_histogram", "explicit_histogram"].
:type value: str
"""

Expand All @@ -25,11 +25,15 @@ class MetricTagConfigurationMetricTypes(ModelSimple):
"count",
"rate",
"distribution",
"exponential_histogram",
"explicit_histogram",
}
GAUGE: ClassVar["MetricTagConfigurationMetricTypes"]
COUNT: ClassVar["MetricTagConfigurationMetricTypes"]
RATE: ClassVar["MetricTagConfigurationMetricTypes"]
DISTRIBUTION: ClassVar["MetricTagConfigurationMetricTypes"]
EXPONENTIAL_HISTOGRAM: ClassVar["MetricTagConfigurationMetricTypes"]
EXPLICIT_HISTOGRAM: ClassVar["MetricTagConfigurationMetricTypes"]

@cached_property
def openapi_types(_):
Expand All @@ -42,3 +46,5 @@ def openapi_types(_):
MetricTagConfigurationMetricTypes.COUNT = MetricTagConfigurationMetricTypes("count")
MetricTagConfigurationMetricTypes.RATE = MetricTagConfigurationMetricTypes("rate")
MetricTagConfigurationMetricTypes.DISTRIBUTION = MetricTagConfigurationMetricTypes("distribution")
MetricTagConfigurationMetricTypes.EXPONENTIAL_HISTOGRAM = MetricTagConfigurationMetricTypes("exponential_histogram")
MetricTagConfigurationMetricTypes.EXPLICIT_HISTOGRAM = MetricTagConfigurationMetricTypes("explicit_histogram")
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ def __init__(
Defaults to false. Requires ``tags`` property.
:type exclude_tags_mode: bool, optional

:param include_percentiles: Toggle to include/exclude percentiles for a distribution metric.
Defaults to false. Can only be applied to metrics that have a ``metric_type`` of ``distribution``.
:param include_percentiles: Include percentile aggregations for metric types ``distribution`` , ``exponential_histogram`` ,
and ``explicit_histogram``. Omit this field to keep the current setting.
:type include_percentiles: bool, optional

:param tags: A list of tag keys that will be queryable for your metric.
Expand Down
Loading