Skip to content

Commit ec55cad

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add display_name to Observability Pipeline processors (#1097)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 39f09d7 commit ec55cad

File tree

45 files changed

+452
-68
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

+452
-68
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

src/datadogV2/model/model_observability_pipeline_add_env_vars_processor.rs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ use std::fmt::{self, Formatter};
1111
#[skip_serializing_none]
1212
#[derive(Clone, Debug, PartialEq, Serialize)]
1313
pub struct ObservabilityPipelineAddEnvVarsProcessor {
14+
/// The display name for a component.
15+
#[serde(rename = "display_name")]
16+
pub display_name: Option<String>,
1417
/// Whether this processor is enabled.
1518
#[serde(rename = "enabled")]
1619
pub enabled: bool,
@@ -42,6 +45,7 @@ impl ObservabilityPipelineAddEnvVarsProcessor {
4245
variables: Vec<crate::datadogV2::model::ObservabilityPipelineAddEnvVarsProcessorVariable>,
4346
) -> ObservabilityPipelineAddEnvVarsProcessor {
4447
ObservabilityPipelineAddEnvVarsProcessor {
48+
display_name: None,
4549
enabled,
4650
id,
4751
include,
@@ -52,6 +56,11 @@ impl ObservabilityPipelineAddEnvVarsProcessor {
5256
}
5357
}
5458

59+
pub fn display_name(mut self, value: String) -> Self {
60+
self.display_name = Some(value);
61+
self
62+
}
63+
5564
pub fn additional_properties(
5665
mut self,
5766
value: std::collections::BTreeMap<String, serde_json::Value>,
@@ -78,6 +87,7 @@ impl<'de> Deserialize<'de> for ObservabilityPipelineAddEnvVarsProcessor {
7887
where
7988
M: MapAccess<'a>,
8089
{
90+
let mut display_name: Option<String> = None;
8191
let mut enabled: Option<bool> = None;
8292
let mut id: Option<String> = None;
8393
let mut include: Option<String> = None;
@@ -95,6 +105,13 @@ impl<'de> Deserialize<'de> for ObservabilityPipelineAddEnvVarsProcessor {
95105

96106
while let Some((k, v)) = map.next_entry::<String, serde_json::Value>()? {
97107
match k.as_str() {
108+
"display_name" => {
109+
if v.is_null() {
110+
continue;
111+
}
112+
display_name =
113+
Some(serde_json::from_value(v).map_err(M::Error::custom)?);
114+
}
98115
"enabled" => {
99116
enabled = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
100117
}
@@ -132,6 +149,7 @@ impl<'de> Deserialize<'de> for ObservabilityPipelineAddEnvVarsProcessor {
132149
let variables = variables.ok_or_else(|| M::Error::missing_field("variables"))?;
133150

134151
let content = ObservabilityPipelineAddEnvVarsProcessor {
152+
display_name,
135153
enabled,
136154
id,
137155
include,

src/datadogV2/model/model_observability_pipeline_add_fields_processor.rs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ use std::fmt::{self, Formatter};
1111
#[skip_serializing_none]
1212
#[derive(Clone, Debug, PartialEq, Serialize)]
1313
pub struct ObservabilityPipelineAddFieldsProcessor {
14+
/// The display name for a component.
15+
#[serde(rename = "display_name")]
16+
pub display_name: Option<String>,
1417
/// Whether this processor is enabled.
1518
#[serde(rename = "enabled")]
1619
pub enabled: bool,
@@ -42,6 +45,7 @@ impl ObservabilityPipelineAddFieldsProcessor {
4245
type_: crate::datadogV2::model::ObservabilityPipelineAddFieldsProcessorType,
4346
) -> ObservabilityPipelineAddFieldsProcessor {
4447
ObservabilityPipelineAddFieldsProcessor {
48+
display_name: None,
4549
enabled,
4650
fields,
4751
id,
@@ -52,6 +56,11 @@ impl ObservabilityPipelineAddFieldsProcessor {
5256
}
5357
}
5458

59+
pub fn display_name(mut self, value: String) -> Self {
60+
self.display_name = Some(value);
61+
self
62+
}
63+
5564
pub fn additional_properties(
5665
mut self,
5766
value: std::collections::BTreeMap<String, serde_json::Value>,
@@ -78,6 +87,7 @@ impl<'de> Deserialize<'de> for ObservabilityPipelineAddFieldsProcessor {
7887
where
7988
M: MapAccess<'a>,
8089
{
90+
let mut display_name: Option<String> = None;
8191
let mut enabled: Option<bool> = None;
8292
let mut fields: Option<
8393
Vec<crate::datadogV2::model::ObservabilityPipelineFieldValue>,
@@ -95,6 +105,13 @@ impl<'de> Deserialize<'de> for ObservabilityPipelineAddFieldsProcessor {
95105

96106
while let Some((k, v)) = map.next_entry::<String, serde_json::Value>()? {
97107
match k.as_str() {
108+
"display_name" => {
109+
if v.is_null() {
110+
continue;
111+
}
112+
display_name =
113+
Some(serde_json::from_value(v).map_err(M::Error::custom)?);
114+
}
98115
"enabled" => {
99116
enabled = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
100117
}
@@ -132,6 +149,7 @@ impl<'de> Deserialize<'de> for ObservabilityPipelineAddFieldsProcessor {
132149
let type_ = type_.ok_or_else(|| M::Error::missing_field("type_"))?;
133150

134151
let content = ObservabilityPipelineAddFieldsProcessor {
152+
display_name,
135153
enabled,
136154
fields,
137155
id,

src/datadogV2/model/model_observability_pipeline_config_processor_group.rs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ use std::fmt::{self, Formatter};
1111
#[skip_serializing_none]
1212
#[derive(Clone, Debug, PartialEq, Serialize)]
1313
pub struct ObservabilityPipelineConfigProcessorGroup {
14+
/// The display name for a component.
15+
#[serde(rename = "display_name")]
16+
pub display_name: Option<String>,
1417
/// Whether this processor group is enabled.
1518
#[serde(rename = "enabled")]
1619
pub enabled: bool,
@@ -42,6 +45,7 @@ impl ObservabilityPipelineConfigProcessorGroup {
4245
processors: Vec<crate::datadogV2::model::ObservabilityPipelineConfigProcessorItem>,
4346
) -> ObservabilityPipelineConfigProcessorGroup {
4447
ObservabilityPipelineConfigProcessorGroup {
48+
display_name: None,
4549
enabled,
4650
id,
4751
include,
@@ -52,6 +56,11 @@ impl ObservabilityPipelineConfigProcessorGroup {
5256
}
5357
}
5458

59+
pub fn display_name(mut self, value: String) -> Self {
60+
self.display_name = Some(value);
61+
self
62+
}
63+
5564
pub fn additional_properties(
5665
mut self,
5766
value: std::collections::BTreeMap<String, serde_json::Value>,
@@ -78,6 +87,7 @@ impl<'de> Deserialize<'de> for ObservabilityPipelineConfigProcessorGroup {
7887
where
7988
M: MapAccess<'a>,
8089
{
90+
let mut display_name: Option<String> = None;
8191
let mut enabled: Option<bool> = None;
8292
let mut id: Option<String> = None;
8393
let mut include: Option<String> = None;
@@ -93,6 +103,13 @@ impl<'de> Deserialize<'de> for ObservabilityPipelineConfigProcessorGroup {
93103

94104
while let Some((k, v)) = map.next_entry::<String, serde_json::Value>()? {
95105
match k.as_str() {
106+
"display_name" => {
107+
if v.is_null() {
108+
continue;
109+
}
110+
display_name =
111+
Some(serde_json::from_value(v).map_err(M::Error::custom)?);
112+
}
96113
"enabled" => {
97114
enabled = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
98115
}
@@ -122,6 +139,7 @@ impl<'de> Deserialize<'de> for ObservabilityPipelineConfigProcessorGroup {
122139
let processors = processors.ok_or_else(|| M::Error::missing_field("processors"))?;
123140

124141
let content = ObservabilityPipelineConfigProcessorGroup {
142+
display_name,
125143
enabled,
126144
id,
127145
include,

0 commit comments

Comments
 (0)