Skip to content

Commit 5a68593

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add new metrics processors in Observability Pipelines (#3853)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 94f5973 commit 5a68593

17 files changed

Lines changed: 3253 additions & 4 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 307 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53036,6 +53036,118 @@ components:
5303653036
type: string
5303753037
x-enum-varnames:
5303853038
- ADD_HOSTNAME
53039+
ObservabilityPipelineAddMetricTagsProcessor:
53040+
description: |-
53041+
The `add_metric_tags` processor adds static tags to metrics.
53042+
53043+
**Supported pipeline types:** metrics
53044+
properties:
53045+
display_name:
53046+
$ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
53047+
enabled:
53048+
description: Indicates whether the processor is enabled.
53049+
example: true
53050+
type: boolean
53051+
id:
53052+
description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components).
53053+
example: "add-metric-tags-processor"
53054+
type: string
53055+
include:
53056+
description: A Datadog search query used to determine which metrics this processor targets.
53057+
example: "*"
53058+
type: string
53059+
tags:
53060+
description: A list of static tags (key-value pairs) added to each metric processed by this component.
53061+
items:
53062+
$ref: "#/components/schemas/ObservabilityPipelineFieldValue"
53063+
maxItems: 15
53064+
type: array
53065+
type:
53066+
$ref: "#/components/schemas/ObservabilityPipelineAddMetricTagsProcessorType"
53067+
required:
53068+
- id
53069+
- type
53070+
- include
53071+
- tags
53072+
- enabled
53073+
type: object
53074+
x-pipeline-types: [metrics]
53075+
ObservabilityPipelineAddMetricTagsProcessorType:
53076+
default: add_metric_tags
53077+
description: The processor type. The value must be `add_metric_tags`.
53078+
enum: [add_metric_tags]
53079+
example: add_metric_tags
53080+
type: string
53081+
x-enum-varnames:
53082+
- ADD_METRIC_TAGS
53083+
ObservabilityPipelineAggregateProcessor:
53084+
description: |-
53085+
The `aggregate` processor combines metrics that share the same name and tags into a single metric over a configurable interval.
53086+
53087+
**Supported pipeline types:** metrics
53088+
properties:
53089+
display_name:
53090+
$ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
53091+
enabled:
53092+
description: Indicates whether the processor is enabled.
53093+
example: true
53094+
type: boolean
53095+
id:
53096+
description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components).
53097+
example: "aggregate-processor"
53098+
type: string
53099+
include:
53100+
description: A Datadog search query used to determine which metrics this processor targets.
53101+
example: "*"
53102+
type: string
53103+
interval_secs:
53104+
description: The interval, in seconds, over which metrics are aggregated.
53105+
example: 10
53106+
format: int64
53107+
maximum: 60
53108+
minimum: 1
53109+
type: integer
53110+
mode:
53111+
$ref: "#/components/schemas/ObservabilityPipelineAggregateProcessorMode"
53112+
type:
53113+
$ref: "#/components/schemas/ObservabilityPipelineAggregateProcessorType"
53114+
required:
53115+
- id
53116+
- type
53117+
- include
53118+
- interval_secs
53119+
- mode
53120+
- enabled
53121+
type: object
53122+
x-pipeline-types: [metrics]
53123+
ObservabilityPipelineAggregateProcessorMode:
53124+
description: The aggregation mode applied to metrics that share the same name and tags within the interval.
53125+
enum:
53126+
- auto
53127+
- sum
53128+
- latest
53129+
- count
53130+
- max
53131+
- min
53132+
- mean
53133+
example: auto
53134+
type: string
53135+
x-enum-varnames:
53136+
- AUTO
53137+
- SUM
53138+
- LATEST
53139+
- COUNT
53140+
- MAX
53141+
- MIN
53142+
- MEAN
53143+
ObservabilityPipelineAggregateProcessorType:
53144+
default: aggregate
53145+
description: The processor type. The value must be `aggregate`.
53146+
enum: [aggregate]
53147+
example: aggregate
53148+
type: string
53149+
x-enum-varnames:
53150+
- AGGREGATE
5303953151
ObservabilityPipelineAmazonDataFirehoseSource:
5304053152
description: |-
5304153153
The `amazon_data_firehose` source ingests logs from AWS Data Firehose.
@@ -53751,7 +53863,11 @@ components:
5375153863
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessor"
5375253864
- $ref: "#/components/schemas/ObservabilityPipelineSplitArrayProcessor"
5375353865
- $ref: "#/components/schemas/ObservabilityPipelineThrottleProcessor"
53866+
- $ref: "#/components/schemas/ObservabilityPipelineAddMetricTagsProcessor"
53867+
- $ref: "#/components/schemas/ObservabilityPipelineAggregateProcessor"
5375453868
- $ref: "#/components/schemas/ObservabilityPipelineMetricTagsProcessor"
53869+
- $ref: "#/components/schemas/ObservabilityPipelineRenameMetricTagsProcessor"
53870+
- $ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessor"
5375553871
ObservabilityPipelineConfigSourceItem:
5375653872
description: "A data source for the pipeline."
5375753873
oneOf:
@@ -56799,6 +56915,65 @@ components:
5679956915
type: string
5680056916
x-enum-varnames:
5680156917
- RENAME_FIELDS
56918+
ObservabilityPipelineRenameMetricTagsProcessor:
56919+
description: |-
56920+
The `rename_metric_tags` processor changes the keys of tags on metrics.
56921+
56922+
**Supported pipeline types:** metrics
56923+
properties:
56924+
display_name:
56925+
$ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
56926+
enabled:
56927+
description: Indicates whether the processor is enabled.
56928+
example: true
56929+
type: boolean
56930+
id:
56931+
description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components).
56932+
example: "rename-metric-tags-processor"
56933+
type: string
56934+
include:
56935+
description: A Datadog search query used to determine which metrics this processor targets.
56936+
example: "*"
56937+
type: string
56938+
tags:
56939+
description: A list of rename rules specifying which tag keys to rename on each metric.
56940+
items:
56941+
$ref: "#/components/schemas/ObservabilityPipelineRenameMetricTagsProcessorTag"
56942+
maxItems: 15
56943+
type: array
56944+
type:
56945+
$ref: "#/components/schemas/ObservabilityPipelineRenameMetricTagsProcessorType"
56946+
required:
56947+
- id
56948+
- type
56949+
- include
56950+
- tags
56951+
- enabled
56952+
type: object
56953+
x-pipeline-types: [metrics]
56954+
ObservabilityPipelineRenameMetricTagsProcessorTag:
56955+
description: Defines how to rename a tag on metric events.
56956+
properties:
56957+
rename_to:
56958+
description: The new tag key to assign in place of the original.
56959+
example: "destination_tag"
56960+
type: string
56961+
tag:
56962+
description: The original tag key on the metric event.
56963+
example: "source_tag"
56964+
type: string
56965+
required:
56966+
- tag
56967+
- rename_to
56968+
type: object
56969+
ObservabilityPipelineRenameMetricTagsProcessorType:
56970+
default: rename_metric_tags
56971+
description: The processor type. The value must be `rename_metric_tags`.
56972+
enum: [rename_metric_tags]
56973+
example: rename_metric_tags
56974+
type: string
56975+
x-enum-varnames:
56976+
- RENAME_METRIC_TAGS
5680256977
ObservabilityPipelineRsyslogDestination:
5680356978
description: |-
5680456979
The `rsyslog` destination forwards logs to an external `rsyslog` server over TCP or UDP using the syslog protocol.
@@ -58040,6 +58215,138 @@ components:
5804058215
x-enum-varnames:
5804158216
- TCP
5804258217
- UDP
58218+
ObservabilityPipelineTagCardinalityLimitProcessor:
58219+
description: |-
58220+
The `tag_cardinality_limit` processor caps the number of distinct tag value combinations on metrics, dropping tags or events once the limit is exceeded.
58221+
58222+
**Supported pipeline types:** metrics
58223+
properties:
58224+
display_name:
58225+
$ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
58226+
enabled:
58227+
description: Indicates whether the processor is enabled.
58228+
example: true
58229+
type: boolean
58230+
id:
58231+
description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components).
58232+
example: "tag-cardinality-limit-processor"
58233+
type: string
58234+
include:
58235+
description: A Datadog search query used to determine which metrics this processor targets.
58236+
example: "*"
58237+
type: string
58238+
limit_exceeded_action:
58239+
$ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorAction"
58240+
per_metric_limits:
58241+
description: A list of per-metric cardinality overrides that take precedence over the default `value_limit`.
58242+
items:
58243+
$ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorPerMetricLimit"
58244+
maxItems: 100
58245+
type: array
58246+
type:
58247+
$ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorType"
58248+
value_limit:
58249+
description: The default maximum number of distinct tag value combinations allowed per metric.
58250+
example: 10000
58251+
format: int64
58252+
maximum: 1000000
58253+
minimum: 0
58254+
type: integer
58255+
required:
58256+
- id
58257+
- type
58258+
- include
58259+
- limit_exceeded_action
58260+
- value_limit
58261+
- enabled
58262+
type: object
58263+
x-pipeline-types: [metrics]
58264+
ObservabilityPipelineTagCardinalityLimitProcessorAction:
58265+
description: The action to take when the cardinality limit is exceeded.
58266+
enum:
58267+
- drop_tag
58268+
- drop_event
58269+
example: drop_tag
58270+
type: string
58271+
x-enum-varnames:
58272+
- DROP_TAG
58273+
- DROP_EVENT
58274+
ObservabilityPipelineTagCardinalityLimitProcessorPerMetricLimit:
58275+
description: A cardinality override applied to a specific metric.
58276+
properties:
58277+
limit_exceeded_action:
58278+
$ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorAction"
58279+
metric_name:
58280+
description: The name of the metric this override applies to.
58281+
example: "system.cpu.user"
58282+
type: string
58283+
mode:
58284+
$ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorPerMetricMode"
58285+
per_tag_limits:
58286+
description: A list of per-tag cardinality overrides that apply within this metric. Must be omitted when `mode` is `excluded`.
58287+
items:
58288+
$ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorPerTagLimit"
58289+
maxItems: 50
58290+
type: array
58291+
value_limit:
58292+
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`.
58293+
example: 10000
58294+
format: int64
58295+
maximum: 1000000
58296+
minimum: 0
58297+
type: integer
58298+
required:
58299+
- metric_name
58300+
- mode
58301+
type: object
58302+
ObservabilityPipelineTagCardinalityLimitProcessorPerMetricMode:
58303+
description: How the per-metric override is applied. `tracked` enforces a custom limit; `excluded` skips the metric entirely.
58304+
enum:
58305+
- tracked
58306+
- excluded
58307+
example: tracked
58308+
type: string
58309+
x-enum-varnames:
58310+
- TRACKED
58311+
- EXCLUDED
58312+
ObservabilityPipelineTagCardinalityLimitProcessorPerTagLimit:
58313+
description: A cardinality override for a specific tag key within a per-metric limit.
58314+
properties:
58315+
mode:
58316+
$ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorPerTagMode"
58317+
tag_key:
58318+
description: The tag key this override applies to.
58319+
example: "host"
58320+
type: string
58321+
value_limit:
58322+
description: The maximum number of distinct values allowed for this tag. Required when `mode` is `limit_override`. Must be omitted when `mode` is `excluded`.
58323+
example: 5000
58324+
format: int64
58325+
maximum: 1000000
58326+
minimum: 0
58327+
type: integer
58328+
required:
58329+
- tag_key
58330+
- mode
58331+
type: object
58332+
ObservabilityPipelineTagCardinalityLimitProcessorPerTagMode:
58333+
description: How the per-tag override is applied. `limit_override` enforces a custom limit on the tag; `excluded` skips the tag from cardinality tracking.
58334+
enum:
58335+
- limit_override
58336+
- excluded
58337+
example: limit_override
58338+
type: string
58339+
x-enum-varnames:
58340+
- LIMIT_OVERRIDE
58341+
- EXCLUDED
58342+
ObservabilityPipelineTagCardinalityLimitProcessorType:
58343+
default: tag_cardinality_limit
58344+
description: The processor type. The value must be `tag_cardinality_limit`.
58345+
enum: [tag_cardinality_limit]
58346+
example: tag_cardinality_limit
58347+
type: string
58348+
x-enum-varnames:
58349+
- TAG_CARDINALITY_LIMIT
5804358350
ObservabilityPipelineThrottleProcessor:
5804458351
description: |-
5804558352
The `throttle` processor limits the number of events that pass through over a given time window.

0 commit comments

Comments
 (0)