Skip to content
Open
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
61 changes: 36 additions & 25 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -70300,6 +70300,8 @@ components:
$ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorPerMetricLimit"
maxItems: 100
type: array
tracking_mode:
$ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorTrackingMode"
type:
$ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorType"
value_limit:
Expand All @@ -70314,6 +70316,7 @@ components:
- type
- include
- limit_exceeded_action
- tracking_mode
- value_limit
- enabled
type: object
Expand All @@ -70328,6 +70331,16 @@ components:
x-enum-varnames:
- DROP_TAG
- DROP_EVENT
ObservabilityPipelineTagCardinalityLimitProcessorOverrideType:
description: How the override is applied. `limit_override` enforces a custom limit; `excluded` omits the metric or tag from cardinality tracking.
enum:
- limit_override
- excluded
example: limit_override
type: string
x-enum-varnames:
- LIMIT_OVERRIDE
- EXCLUDED
ObservabilityPipelineTagCardinalityLimitProcessorPerMetricLimit:
description: A cardinality override applied to a specific metric.
properties:
Expand All @@ -70337,65 +70350,63 @@ components:
description: The name of the metric this override applies to.
example: "system.cpu.user"
type: string
mode:
$ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorPerMetricMode"
override_type:
$ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorOverrideType"
per_tag_limits:
description: A list of per-tag cardinality overrides that apply within this metric. Must be omitted when `mode` is `excluded`.
description: A list of per-tag cardinality overrides that apply within this metric. Must be omitted when `override_type` is `excluded`.
items:
$ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorPerTagLimit"
maxItems: 50
type: array
value_limit:
description: The maximum number of distinct tag value combinations allowed for this metric. Required when `mode` is `tracked`. Must be omitted when `mode` is `excluded`.
description: The maximum number of distinct tag value combinations allowed for this metric. Required when `override_type` is `limit_override`. Must be omitted when `override_type` is `excluded`.
example: 10000
format: int64
maximum: 1000000
minimum: 0
type: integer
required:
- metric_name
- mode
- override_type
type: object
ObservabilityPipelineTagCardinalityLimitProcessorPerMetricMode:
description: How the per-metric override is applied. `tracked` enforces a custom limit; `excluded` skips the metric entirely.
enum:
- tracked
- excluded
example: tracked
type: string
x-enum-varnames:
- TRACKED
- EXCLUDED
ObservabilityPipelineTagCardinalityLimitProcessorPerTagLimit:
description: A cardinality override for a specific tag key within a per-metric limit.
properties:
mode:
$ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorPerTagMode"
override_type:
$ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorOverrideType"
tag_key:
description: The tag key this override applies to.
example: "host"
type: string
value_limit:
description: The maximum number of distinct values allowed for this tag. Required when `mode` is `limit_override`. Must be omitted when `mode` is `excluded`.
description: The maximum number of distinct values allowed for this tag. Required when `override_type` is `limit_override`. Must be omitted when `override_type` is `excluded`.
example: 5000
format: int64
maximum: 1000000
minimum: 0
type: integer
required:
- tag_key
- override_type
type: object
ObservabilityPipelineTagCardinalityLimitProcessorTrackingMode:
description: Controls whether the processor uses exact or probabilistic tag tracking.
properties:
mode:
$ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorTrackingModeMode"
required:
- mode
type: object
ObservabilityPipelineTagCardinalityLimitProcessorPerTagMode:
description: How the per-tag override is applied. `limit_override` enforces a custom limit on the tag; `excluded` skips the tag from cardinality tracking.
ObservabilityPipelineTagCardinalityLimitProcessorTrackingModeMode:
description: The cardinality tracking algorithm to use.
enum:
- limit_override
- excluded
example: limit_override
- exact_fingerprint
- probabilistic
example: exact_fingerprint
type: string
x-enum-varnames:
- LIMIT_OVERRIDE
- EXCLUDED
- EXACT_FINGERPRINT
- PROBABILISTIC
ObservabilityPipelineTagCardinalityLimitProcessorType:
default: tag_cardinality_limit
description: The processor type. The value must be `tag_cardinality_limit`.
Expand Down
23 changes: 15 additions & 8 deletions docs/datadog_api_client.v2.model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29103,17 +29103,17 @@ datadog\_api\_client.v2.model.observability\_pipeline\_tag\_cardinality\_limit\_
:members:
:show-inheritance:

datadog\_api\_client.v2.model.observability\_pipeline\_tag\_cardinality\_limit\_processor\_per\_metric\_limit module
--------------------------------------------------------------------------------------------------------------------
datadog\_api\_client.v2.model.observability\_pipeline\_tag\_cardinality\_limit\_processor\_override\_type module
----------------------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_per_metric_limit
.. automodule:: datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_override_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.observability\_pipeline\_tag\_cardinality\_limit\_processor\_per\_metric\_mode module
-------------------------------------------------------------------------------------------------------------------
datadog\_api\_client.v2.model.observability\_pipeline\_tag\_cardinality\_limit\_processor\_per\_metric\_limit module
--------------------------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_per_metric_mode
.. automodule:: datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_per_metric_limit
:members:
:show-inheritance:

Expand All @@ -29124,10 +29124,17 @@ datadog\_api\_client.v2.model.observability\_pipeline\_tag\_cardinality\_limit\_
:members:
:show-inheritance:

datadog\_api\_client.v2.model.observability\_pipeline\_tag\_cardinality\_limit\_processor\_per\_tag\_mode module
datadog\_api\_client.v2.model.observability\_pipeline\_tag\_cardinality\_limit\_processor\_tracking\_mode module
----------------------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_per_tag_mode
.. automodule:: datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_tracking_mode
:members:
:show-inheritance:

datadog\_api\_client.v2.model.observability\_pipeline\_tag\_cardinality\_limit\_processor\_tracking\_mode\_mode module
----------------------------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_tracking_mode_mode
:members:
:show-inheritance:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,9 @@ def __init__(self, **kwargs):
:param per_metric_limits: A list of per-metric cardinality overrides that take precedence over the default `value_limit`.
:type per_metric_limits: [ObservabilityPipelineTagCardinalityLimitProcessorPerMetricLimit], optional

:param tracking_mode: Controls whether the processor uses exact or probabilistic tag tracking.
:type tracking_mode: ObservabilityPipelineTagCardinalityLimitProcessorTrackingMode

:param value_limit: The default maximum number of distinct tag value combinations allowed per metric.
:type value_limit: int
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
from datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_per_metric_limit import (
ObservabilityPipelineTagCardinalityLimitProcessorPerMetricLimit,
)
from datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_tracking_mode import (
ObservabilityPipelineTagCardinalityLimitProcessorTrackingMode,
)
from datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_type import (
ObservabilityPipelineTagCardinalityLimitProcessorType,
)
Expand All @@ -44,6 +47,9 @@ def openapi_types(_):
from datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_per_metric_limit import (
ObservabilityPipelineTagCardinalityLimitProcessorPerMetricLimit,
)
from datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_tracking_mode import (
ObservabilityPipelineTagCardinalityLimitProcessorTrackingMode,
)
from datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_type import (
ObservabilityPipelineTagCardinalityLimitProcessorType,
)
Expand All @@ -55,6 +61,7 @@ def openapi_types(_):
"include": (str,),
"limit_exceeded_action": (ObservabilityPipelineTagCardinalityLimitProcessorAction,),
"per_metric_limits": ([ObservabilityPipelineTagCardinalityLimitProcessorPerMetricLimit],),
"tracking_mode": (ObservabilityPipelineTagCardinalityLimitProcessorTrackingMode,),
"type": (ObservabilityPipelineTagCardinalityLimitProcessorType,),
"value_limit": (int,),
}
Expand All @@ -66,6 +73,7 @@ def openapi_types(_):
"include": "include",
"limit_exceeded_action": "limit_exceeded_action",
"per_metric_limits": "per_metric_limits",
"tracking_mode": "tracking_mode",
"type": "type",
"value_limit": "value_limit",
}
Expand All @@ -76,6 +84,7 @@ def __init__(
id: str,
include: str,
limit_exceeded_action: ObservabilityPipelineTagCardinalityLimitProcessorAction,
tracking_mode: ObservabilityPipelineTagCardinalityLimitProcessorTrackingMode,
type: ObservabilityPipelineTagCardinalityLimitProcessorType,
value_limit: int,
display_name: Union[str, UnsetType] = unset,
Expand Down Expand Up @@ -107,6 +116,9 @@ def __init__(
:param per_metric_limits: A list of per-metric cardinality overrides that take precedence over the default ``value_limit``.
:type per_metric_limits: [ObservabilityPipelineTagCardinalityLimitProcessorPerMetricLimit], optional

:param tracking_mode: Controls whether the processor uses exact or probabilistic tag tracking.
:type tracking_mode: ObservabilityPipelineTagCardinalityLimitProcessorTrackingMode

:param type: The processor type. The value must be ``tag_cardinality_limit``.
:type type: ObservabilityPipelineTagCardinalityLimitProcessorType

Expand All @@ -123,5 +135,6 @@ def __init__(
self_.id = id
self_.include = include
self_.limit_exceeded_action = limit_exceeded_action
self_.tracking_mode = tracking_mode
self_.type = type
self_.value_limit = value_limit
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
from typing import ClassVar


class ObservabilityPipelineTagCardinalityLimitProcessorPerTagMode(ModelSimple):
class ObservabilityPipelineTagCardinalityLimitProcessorOverrideType(ModelSimple):
"""
How the per-tag override is applied. `limit_override` enforces a custom limit on the tag; `excluded` skips the tag from cardinality tracking.
How the override is applied. `limit_override` enforces a custom limit; `excluded` omits the metric or tag from cardinality tracking.

:param value: Must be one of ["limit_override", "excluded"].
:type value: str
Expand All @@ -24,8 +24,8 @@ class ObservabilityPipelineTagCardinalityLimitProcessorPerTagMode(ModelSimple):
"limit_override",
"excluded",
}
LIMIT_OVERRIDE: ClassVar["ObservabilityPipelineTagCardinalityLimitProcessorPerTagMode"]
EXCLUDED: ClassVar["ObservabilityPipelineTagCardinalityLimitProcessorPerTagMode"]
LIMIT_OVERRIDE: ClassVar["ObservabilityPipelineTagCardinalityLimitProcessorOverrideType"]
EXCLUDED: ClassVar["ObservabilityPipelineTagCardinalityLimitProcessorOverrideType"]

@cached_property
def openapi_types(_):
Expand All @@ -34,9 +34,9 @@ def openapi_types(_):
}


ObservabilityPipelineTagCardinalityLimitProcessorPerTagMode.LIMIT_OVERRIDE = (
ObservabilityPipelineTagCardinalityLimitProcessorPerTagMode("limit_override")
ObservabilityPipelineTagCardinalityLimitProcessorOverrideType.LIMIT_OVERRIDE = (
ObservabilityPipelineTagCardinalityLimitProcessorOverrideType("limit_override")
)
ObservabilityPipelineTagCardinalityLimitProcessorPerTagMode.EXCLUDED = (
ObservabilityPipelineTagCardinalityLimitProcessorPerTagMode("excluded")
ObservabilityPipelineTagCardinalityLimitProcessorOverrideType.EXCLUDED = (
ObservabilityPipelineTagCardinalityLimitProcessorOverrideType("excluded")
)
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
from datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_action import (
ObservabilityPipelineTagCardinalityLimitProcessorAction,
)
from datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_per_metric_mode import (
ObservabilityPipelineTagCardinalityLimitProcessorPerMetricMode,
from datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_override_type import (
ObservabilityPipelineTagCardinalityLimitProcessorOverrideType,
)
from datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_per_tag_limit import (
ObservabilityPipelineTagCardinalityLimitProcessorPerTagLimit,
Expand All @@ -41,8 +41,8 @@ def openapi_types(_):
from datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_action import (
ObservabilityPipelineTagCardinalityLimitProcessorAction,
)
from datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_per_metric_mode import (
ObservabilityPipelineTagCardinalityLimitProcessorPerMetricMode,
from datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_override_type import (
ObservabilityPipelineTagCardinalityLimitProcessorOverrideType,
)
from datadog_api_client.v2.model.observability_pipeline_tag_cardinality_limit_processor_per_tag_limit import (
ObservabilityPipelineTagCardinalityLimitProcessorPerTagLimit,
Expand All @@ -51,23 +51,23 @@ def openapi_types(_):
return {
"limit_exceeded_action": (ObservabilityPipelineTagCardinalityLimitProcessorAction,),
"metric_name": (str,),
"mode": (ObservabilityPipelineTagCardinalityLimitProcessorPerMetricMode,),
"override_type": (ObservabilityPipelineTagCardinalityLimitProcessorOverrideType,),
"per_tag_limits": ([ObservabilityPipelineTagCardinalityLimitProcessorPerTagLimit],),
"value_limit": (int,),
}

attribute_map = {
"limit_exceeded_action": "limit_exceeded_action",
"metric_name": "metric_name",
"mode": "mode",
"override_type": "override_type",
"per_tag_limits": "per_tag_limits",
"value_limit": "value_limit",
}

def __init__(
self_,
metric_name: str,
mode: ObservabilityPipelineTagCardinalityLimitProcessorPerMetricMode,
override_type: ObservabilityPipelineTagCardinalityLimitProcessorOverrideType,
limit_exceeded_action: Union[ObservabilityPipelineTagCardinalityLimitProcessorAction, UnsetType] = unset,
per_tag_limits: Union[List[ObservabilityPipelineTagCardinalityLimitProcessorPerTagLimit], UnsetType] = unset,
value_limit: Union[int, UnsetType] = unset,
Expand All @@ -82,13 +82,13 @@ def __init__(
:param metric_name: The name of the metric this override applies to.
:type metric_name: str

:param mode: How the per-metric override is applied. ``tracked`` enforces a custom limit; ``excluded`` skips the metric entirely.
:type mode: ObservabilityPipelineTagCardinalityLimitProcessorPerMetricMode
:param override_type: How the override is applied. ``limit_override`` enforces a custom limit; ``excluded`` omits the metric or tag from cardinality tracking.
:type override_type: ObservabilityPipelineTagCardinalityLimitProcessorOverrideType

:param per_tag_limits: A list of per-tag cardinality overrides that apply within this metric. Must be omitted when ``mode`` is ``excluded``.
:param per_tag_limits: A list of per-tag cardinality overrides that apply within this metric. Must be omitted when ``override_type`` is ``excluded``.
:type per_tag_limits: [ObservabilityPipelineTagCardinalityLimitProcessorPerTagLimit], optional

:param value_limit: The maximum number of distinct tag value combinations allowed for this metric. Required when ``mode`` is ``tracked``. Must be omitted when ``mode`` is ``excluded``.
:param value_limit: The maximum number of distinct tag value combinations allowed for this metric. Required when ``override_type`` is ``limit_override``. Must be omitted when ``override_type`` is ``excluded``.
:type value_limit: int, optional
"""
if limit_exceeded_action is not unset:
Expand All @@ -100,4 +100,4 @@ def __init__(
super().__init__(kwargs)

self_.metric_name = metric_name
self_.mode = mode
self_.override_type = override_type

This file was deleted.

Loading
Loading