Skip to content

Commit 317aa0d

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add display_name to Observability Pipeline processors (#3163)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent d7ffaf4 commit 317aa0d

File tree

45 files changed

+335
-141
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+335
-141
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35144,6 +35144,8 @@ components:
3514435144
description: The `add_env_vars` processor adds environment variable values to
3514535145
log events.
3514635146
properties:
35147+
display_name:
35148+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
3514735149
enabled:
3514835150
description: Whether this processor is enabled.
3514935151
example: true
@@ -35199,6 +35201,8 @@ components:
3519935201
ObservabilityPipelineAddFieldsProcessor:
3520035202
description: The `add_fields` processor adds static key-value fields to logs.
3520135203
properties:
35204+
display_name:
35205+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
3520235206
enabled:
3520335207
description: Whether this processor is enabled.
3520435208
example: true
@@ -35515,6 +35519,10 @@ components:
3551535519
role session.
3551635520
type: string
3551735521
type: object
35522+
ObservabilityPipelineComponentDisplayName:
35523+
description: The display name for a component.
35524+
example: my component
35525+
type: string
3551835526
ObservabilityPipelineConfig:
3551935527
description: Specifies the pipeline's configuration, including its sources,
3552035528
processors, and destinations.
@@ -35605,6 +35613,8 @@ components:
3560535613
include: status:error
3560635614
type: filter
3560735615
properties:
35616+
display_name:
35617+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
3560835618
enabled:
3560935619
description: Whether this processor group is enabled.
3561035620
example: true
@@ -35768,6 +35778,8 @@ components:
3576835778
Remap Language (VRL)](https://vector.dev/docs/reference/vrl/) scripts with
3576935779
advanced filtering capabilities.
3577035780
properties:
35781+
display_name:
35782+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
3577135783
enabled:
3577235784
description: Whether this processor is enabled.
3577335785
example: true
@@ -35935,6 +35947,8 @@ components:
3593535947
properties:
3593635948
action:
3593735949
$ref: '#/components/schemas/ObservabilityPipelineDatadogTagsProcessorAction'
35950+
display_name:
35951+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
3593835952
enabled:
3593935953
description: Whether this processor is enabled.
3594035954
example: true
@@ -36016,6 +36030,8 @@ components:
3601636030
ObservabilityPipelineDedupeProcessor:
3601736031
description: The `dedupe` processor removes duplicate fields in log events.
3601836032
properties:
36033+
display_name:
36034+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
3601936035
enabled:
3602036036
description: Whether this processor is enabled.
3602136037
example: true
@@ -36253,6 +36269,8 @@ components:
3625336269
description: The `enrichment_table` processor enriches logs using a static CSV
3625436270
file or GeoIP database.
3625536271
properties:
36272+
display_name:
36273+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
3625636274
enabled:
3625736275
description: Whether this processor is enabled.
3625836276
example: true
@@ -36312,6 +36330,8 @@ components:
3631236330
on a Datadog search query. Logs that match the `include` query are passed
3631336331
through; others are discarded.
3631436332
properties:
36333+
display_name:
36334+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
3631536335
enabled:
3631636336
description: Whether this processor is enabled.
3631736337
example: true
@@ -36414,6 +36434,8 @@ components:
3641436434
Metrics can be counters, gauges, or distributions and optionally grouped by
3641536435
log fields.'
3641636436
properties:
36437+
display_name:
36438+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
3641736439
enabled:
3641836440
description: Whether this processor is enabled.
3641936441
example: true
@@ -37035,6 +37057,8 @@ components:
3703537057
description: The `ocsf_mapper` processor transforms logs into the OCSF schema
3703637058
using a predefined mapping configuration.
3703737059
properties:
37060+
display_name:
37061+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
3703837062
enabled:
3703937063
description: Whether this processor is enabled.
3704037064
example: true
@@ -37166,6 +37190,8 @@ components:
3716637190
by Datadog.
3716737191
example: true
3716837192
type: boolean
37193+
display_name:
37194+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
3716937195
enabled:
3717037196
description: Whether this processor is enabled.
3717137197
example: true
@@ -37278,6 +37304,8 @@ components:
3727837304
and flattens it into the event. This is useful when logs contain embedded
3727937305
JSON as a string.
3728037306
properties:
37307+
display_name:
37308+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
3728137309
enabled:
3728237310
description: Whether this processor is enabled.
3728337311
example: true
@@ -37331,6 +37359,8 @@ components:
3733137359
a specified filter. When the configured daily quota is met, the processor
3733237360
can drop or alert.
3733337361
properties:
37362+
display_name:
37363+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
3733437364
drop_events:
3733537365
description: If set to `true`, logs that matched the quota filter and sent
3733637366
after the quota has been met are dropped; only logs that did not match
@@ -37462,6 +37492,8 @@ components:
3746237492
description: The `reduce` processor aggregates and merges logs based on matching
3746337493
keys and merge strategies.
3746437494
properties:
37495+
display_name:
37496+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
3746537497
enabled:
3746637498
description: Whether this processor is enabled.
3746737499
example: true
@@ -37554,6 +37586,8 @@ components:
3755437586
ObservabilityPipelineRemoveFieldsProcessor:
3755537587
description: The `remove_fields` processor deletes specified fields from logs.
3755637588
properties:
37589+
display_name:
37590+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
3755737591
enabled:
3755837592
description: Whether this processor is enabled.
3755937593
example: true
@@ -37598,6 +37632,8 @@ components:
3759837632
ObservabilityPipelineRenameFieldsProcessor:
3759937633
description: The `rename_fields` processor changes field names.
3760037634
properties:
37635+
display_name:
37636+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
3760137637
enabled:
3760237638
description: Whether this processor is enabled.
3760337639
example: true
@@ -37733,6 +37769,8 @@ components:
3773337769
description: The `sample` processor allows probabilistic sampling of logs at
3773437770
a fixed rate.
3773537771
properties:
37772+
display_name:
37773+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
3773637774
enabled:
3773737775
description: Whether this processor is enabled.
3773837776
example: true
@@ -37780,6 +37818,8 @@ components:
3778037818
description: The `sensitive_data_scanner` processor detects and optionally redacts
3778137819
sensitive data in log events.
3778237820
properties:
37821+
display_name:
37822+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
3778337823
enabled:
3778437824
description: Whether this processor is enabled.
3778537825
example: true
@@ -38769,6 +38809,8 @@ components:
3876938809
description: The `throttle` processor limits the number of events that pass
3877038810
through over a given time window.
3877138811
properties:
38812+
display_name:
38813+
$ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
3877238814
enabled:
3877338815
description: Whether this processor is enabled.
3877438816
example: true
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2025-12-12T12:01:38.830Z"
1+
"2025-12-18T16:15:15.575Z"

cassettes/v2/Observability-Pipelines_4170000189/Create-a-new-pipeline-returns-Bad-Request-response_2199325426/recording.har

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@
5757
"status": 400,
5858
"statusText": "Bad Request"
5959
},
60-
"startedDateTime": "2025-12-12T12:01:38.833Z",
61-
"time": 470
60+
"startedDateTime": "2025-12-18T16:15:15.578Z",
61+
"time": 474
6262
}
6363
],
6464
"pages": [],
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2025-12-12T12:01:39.315Z"
1+
"2025-12-18T16:15:16.062Z"

cassettes/v2/Observability-Pipelines_4170000189/Create-a-new-pipeline-returns-OK-response_2981893872/recording.har

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,28 +40,28 @@
4040
"response": {
4141
"bodySize": 527,
4242
"content": {
43-
"mimeType": "application/json",
43+
"mimeType": "application/vnd.api+json",
4444
"size": 527,
45-
"text": "{\"data\":{\"id\":\"512fbd46-d752-11f0-b25a-da7ad0900002\",\"type\":\"pipelines\",\"attributes\":{\"name\":\"Main Observability Pipeline\",\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"my-processor-group\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"enabled\":true,\"id\":\"my-processor-group\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]}}}}\n"
45+
"text": "{\"data\":{\"id\":\"bd8d693c-dc2c-11f0-bf69-da7ad0900002\",\"type\":\"pipelines\",\"attributes\":{\"name\":\"Main Observability Pipeline\",\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"my-processor-group\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"enabled\":true,\"id\":\"my-processor-group\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]}}}}\n"
4646
},
4747
"cookies": [],
4848
"headers": [
4949
{
5050
"name": "content-type",
51-
"value": "application/json"
51+
"value": "application/vnd.api+json"
5252
}
5353
],
54-
"headersSize": 217,
54+
"headersSize": 225,
5555
"httpVersion": "HTTP/1.1",
5656
"redirectURL": "",
5757
"status": 201,
5858
"statusText": "Created"
5959
},
60-
"startedDateTime": "2025-12-12T12:01:39.318Z",
61-
"time": 850
60+
"startedDateTime": "2025-12-18T16:15:16.064Z",
61+
"time": 730
6262
},
6363
{
64-
"_id": "daee0d2a6bfc56dad16e3e11b211ca18",
64+
"_id": "9d38f9f7007bc09a60533acbf9ac24b4",
6565
"_order": 0,
6666
"cache": {},
6767
"request": {
@@ -78,7 +78,7 @@
7878
"httpVersion": "HTTP/1.1",
7979
"method": "DELETE",
8080
"queryString": [],
81-
"url": "https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines/512fbd46-d752-11f0-b25a-da7ad0900002"
81+
"url": "https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines/bd8d693c-dc2c-11f0-bf69-da7ad0900002"
8282
},
8383
"response": {
8484
"bodySize": 0,
@@ -99,8 +99,8 @@
9999
"status": 204,
100100
"statusText": "No Content"
101101
},
102-
"startedDateTime": "2025-12-12T12:01:40.178Z",
103-
"time": 539
102+
"startedDateTime": "2025-12-18T16:15:16.804Z",
103+
"time": 357
104104
}
105105
],
106106
"pages": [],
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2025-12-12T12:01:40.725Z"
1+
"2025-12-18T16:15:17.165Z"

cassettes/v2/Observability-Pipelines_4170000189/Delete-a-pipeline-returns-Not-Found-response_870326444/recording.har

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@
4747
"status": 404,
4848
"statusText": "Not Found"
4949
},
50-
"startedDateTime": "2025-12-12T12:01:40.727Z",
51-
"time": 573
50+
"startedDateTime": "2025-12-18T16:15:17.167Z",
51+
"time": 539
5252
}
5353
],
5454
"pages": [],
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2025-12-12T12:01:41.308Z"
1+
"2025-12-18T16:15:17.716Z"

cassettes/v2/Observability-Pipelines_4170000189/Delete-a-pipeline-returns-OK-response_1744781279/recording.har

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
},
99
"entries": [
1010
{
11-
"_id": "da4c1e7179b6967e765b83722311cb84",
11+
"_id": "d6a6f7a2f347564fcbfbe972ad921c97",
1212
"_order": 0,
1313
"cache": {},
1414
"request": {
15-
"bodySize": 480,
15+
"bodySize": 553,
1616
"cookies": [],
1717
"headers": [
1818
{
@@ -32,36 +32,36 @@
3232
"postData": {
3333
"mimeType": "application/json",
3434
"params": [],
35-
"text": "{\"data\":{\"attributes\":{\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"processor-group-0\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"enabled\":true,\"id\":\"processor-group-0\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]},\"name\":\"Main Observability Pipeline\"},\"type\":\"pipelines\"}}"
35+
"text": "{\"data\":{\"attributes\":{\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"processor-group-0\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"display_name\":\"My Processor Group\",\"enabled\":true,\"id\":\"processor-group-0\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"display_name\":\"My Filter Processor\",\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]},\"name\":\"Main Observability Pipeline\"},\"type\":\"pipelines\"}}"
3636
},
3737
"queryString": [],
3838
"url": "https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines"
3939
},
4040
"response": {
41-
"bodySize": 525,
41+
"bodySize": 598,
4242
"content": {
43-
"mimeType": "application/json",
44-
"size": 525,
45-
"text": "{\"data\":{\"id\":\"5260fb94-d752-11f0-b25c-da7ad0900002\",\"type\":\"pipelines\",\"attributes\":{\"name\":\"Main Observability Pipeline\",\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"processor-group-0\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"enabled\":true,\"id\":\"processor-group-0\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]}}}}\n"
43+
"mimeType": "application/vnd.api+json",
44+
"size": 598,
45+
"text": "{\"data\":{\"id\":\"be89fea4-dc2c-11f0-bdea-da7ad0900002\",\"type\":\"pipelines\",\"attributes\":{\"name\":\"Main Observability Pipeline\",\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"processor-group-0\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"display_name\":\"My Processor Group\",\"enabled\":true,\"id\":\"processor-group-0\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"display_name\":\"My Filter Processor\",\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]}}}}\n"
4646
},
4747
"cookies": [],
4848
"headers": [
4949
{
5050
"name": "content-type",
51-
"value": "application/json"
51+
"value": "application/vnd.api+json"
5252
}
5353
],
54-
"headersSize": 217,
54+
"headersSize": 225,
5555
"httpVersion": "HTTP/1.1",
5656
"redirectURL": "",
5757
"status": 201,
5858
"statusText": "Created"
5959
},
60-
"startedDateTime": "2025-12-12T12:01:41.311Z",
61-
"time": 939
60+
"startedDateTime": "2025-12-18T16:15:17.725Z",
61+
"time": 1062
6262
},
6363
{
64-
"_id": "46a341e963579ca39864fbc1cf39edc4",
64+
"_id": "2f02fb97f9e34f3a313a6d3e4dc210d9",
6565
"_order": 0,
6666
"cache": {},
6767
"request": {
@@ -78,7 +78,7 @@
7878
"httpVersion": "HTTP/1.1",
7979
"method": "DELETE",
8080
"queryString": [],
81-
"url": "https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines/5260fb94-d752-11f0-b25c-da7ad0900002"
81+
"url": "https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines/be89fea4-dc2c-11f0-bdea-da7ad0900002"
8282
},
8383
"response": {
8484
"bodySize": 0,
@@ -99,11 +99,11 @@
9999
"status": 204,
100100
"statusText": "No Content"
101101
},
102-
"startedDateTime": "2025-12-12T12:01:42.258Z",
103-
"time": 816
102+
"startedDateTime": "2025-12-18T16:15:18.794Z",
103+
"time": 677
104104
},
105105
{
106-
"_id": "46a341e963579ca39864fbc1cf39edc4",
106+
"_id": "2f02fb97f9e34f3a313a6d3e4dc210d9",
107107
"_order": 1,
108108
"cache": {},
109109
"request": {
@@ -120,7 +120,7 @@
120120
"httpVersion": "HTTP/1.1",
121121
"method": "DELETE",
122122
"queryString": [],
123-
"url": "https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines/5260fb94-d752-11f0-b25c-da7ad0900002"
123+
"url": "https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines/be89fea4-dc2c-11f0-bdea-da7ad0900002"
124124
},
125125
"response": {
126126
"bodySize": 44,
@@ -142,8 +142,8 @@
142142
"status": 404,
143143
"statusText": "Not Found"
144144
},
145-
"startedDateTime": "2025-12-12T12:01:43.083Z",
146-
"time": 599
145+
"startedDateTime": "2025-12-18T16:15:19.478Z",
146+
"time": 534
147147
}
148148
],
149149
"pages": [],
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
"2025-12-12T12:01:43.689Z"
1+
"2025-12-18T16:15:20.018Z"

0 commit comments

Comments
 (0)