Skip to content

Commit 9e8c684

Browse files
Add display_name to Observability Pipeline processors (#3024)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> 0e91592
1 parent edaa417 commit 9e8c684

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

datadog_api_client.v2.model.html

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74571,6 +74571,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
7457174571
<dl class="field-list simple">
7457274572
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7457374573
<dd class="field-odd"><ul class="simple">
74574+
<li><p><strong>display_name</strong> (<em>str</em><em>, </em><em>optional</em>) – The display name for a component.</p></li>
7457474575
<li><p><strong>enabled</strong> (<em>bool</em>) – Whether this processor is enabled.</p></li>
7457574576
<li><p><strong>id</strong> (<em>str</em>) – The unique identifier for this component. Used to reference this processor in the pipeline.</p></li>
7457674577
<li><p><strong>include</strong> (<em>str</em>) – A Datadog search query used to determine which logs this processor targets.</p></li>
@@ -74647,6 +74648,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
7464774648
<dl class="field-list simple">
7464874649
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7464974650
<dd class="field-odd"><ul class="simple">
74651+
<li><p><strong>display_name</strong> (<em>str</em><em>, </em><em>optional</em>) – The display name for a component.</p></li>
7465074652
<li><p><strong>enabled</strong> (<em>bool</em>) – Whether this processor is enabled.</p></li>
7465174653
<li><p><strong>fields</strong> (<em>[</em><a class="reference internal" href="#datadog_api_client.v2.model.observability_pipeline_field_value.ObservabilityPipelineFieldValue" title="datadog_api_client.v2.model.observability_pipeline_field_value.ObservabilityPipelineFieldValue"><em>ObservabilityPipelineFieldValue</em></a><em>]</em>) – A list of static fields (key-value pairs) that is added to each log event processed by this component.</p></li>
7465274654
<li><p><strong>id</strong> (<em>str</em>) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (for example, as the <code class="docutils literal notranslate"><span class="pre">input</span></code> to downstream components).</p></li>
@@ -75178,6 +75180,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
7517875180
<dl class="field-list simple">
7517975181
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7518075182
<dd class="field-odd"><ul class="simple">
75183+
<li><p><strong>display_name</strong> (<em>str</em><em>, </em><em>optional</em>) – The display name for a component.</p></li>
7518175184
<li><p><strong>enabled</strong> (<em>bool</em>) – Whether this processor group is enabled.</p></li>
7518275185
<li><p><strong>id</strong> (<em>str</em>) – The unique identifier for the processor group.</p></li>
7518375186
<li><p><strong>include</strong> (<em>str</em>) – Conditional expression for when this processor group should execute.</p></li>
@@ -75202,6 +75205,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
7520275205
<dl class="field-list simple">
7520375206
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7520475207
<dd class="field-odd"><ul class="simple">
75208+
<li><p><strong>display_name</strong> (<em>str</em><em>, </em><em>optional</em>) – The display name for a component.</p></li>
7520575209
<li><p><strong>enabled</strong> (<em>bool</em>) – Whether this processor is enabled.</p></li>
7520675210
<li><p><strong>id</strong> (<em>str</em>) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (for example, as the <cite>input</cite> to downstream components).</p></li>
7520775211
<li><p><strong>include</strong> (<em>str</em>) – A Datadog search query used to determine which logs should pass through the filter. Logs that match this query continue to downstream components; others are dropped.</p></li>
@@ -75431,6 +75435,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
7543175435
<dl class="field-list simple">
7543275436
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7543375437
<dd class="field-odd"><ul class="simple">
75438+
<li><p><strong>display_name</strong> (<em>str</em><em>, </em><em>optional</em>) – The display name for a component.</p></li>
7543475439
<li><p><strong>enabled</strong> (<em>bool</em>) – Whether this processor is enabled.</p></li>
7543575440
<li><p><strong>id</strong> (<em>str</em>) – The unique identifier for this processor.</p></li>
7543675441
<li><p><strong>include</strong> (<em>str</em>) – A Datadog search query used to determine which logs this processor targets. This field should always be set to <code class="docutils literal notranslate"><span class="pre">*</span></code> for the custom_processor processor.</p></li>
@@ -75660,6 +75665,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
7566075665
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7566175666
<dd class="field-odd"><ul class="simple">
7566275667
<li><p><strong>action</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.observability_pipeline_datadog_tags_processor_action.ObservabilityPipelineDatadogTagsProcessorAction" title="datadog_api_client.v2.model.observability_pipeline_datadog_tags_processor_action.ObservabilityPipelineDatadogTagsProcessorAction"><em>ObservabilityPipelineDatadogTagsProcessorAction</em></a>) – The action to take on tags with matching keys.</p></li>
75668+
<li><p><strong>display_name</strong> (<em>str</em><em>, </em><em>optional</em>) – The display name for a component.</p></li>
7566375669
<li><p><strong>enabled</strong> (<em>bool</em>) – Whether this processor is enabled.</p></li>
7566475670
<li><p><strong>id</strong> (<em>str</em>) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (for example, as the <code class="docutils literal notranslate"><span class="pre">input</span></code> to downstream components).</p></li>
7566575671
<li><p><strong>include</strong> (<em>str</em>) – A Datadog search query used to determine which logs this processor targets.</p></li>
@@ -75809,6 +75815,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
7580975815
<dl class="field-list simple">
7581075816
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7581175817
<dd class="field-odd"><ul class="simple">
75818+
<li><p><strong>display_name</strong> (<em>str</em><em>, </em><em>optional</em>) – The display name for a component.</p></li>
7581275819
<li><p><strong>enabled</strong> (<em>bool</em>) – Whether this processor is enabled.</p></li>
7581375820
<li><p><strong>fields</strong> (<em>[</em><em>str</em><em>]</em>) – A list of log field paths to check for duplicates.</p></li>
7581475821
<li><p><strong>id</strong> (<em>str</em>) – The unique identifier for this processor.</p></li>
@@ -76154,6 +76161,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
7615476161
<dl class="field-list simple">
7615576162
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7615676163
<dd class="field-odd"><ul class="simple">
76164+
<li><p><strong>display_name</strong> (<em>str</em><em>, </em><em>optional</em>) – The display name for a component.</p></li>
7615776165
<li><p><strong>enabled</strong> (<em>bool</em>) – Whether this processor is enabled.</p></li>
7615876166
<li><p><strong>file</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.observability_pipeline_enrichment_table_file.ObservabilityPipelineEnrichmentTableFile" title="datadog_api_client.v2.model.observability_pipeline_enrichment_table_file.ObservabilityPipelineEnrichmentTableFile"><em>ObservabilityPipelineEnrichmentTableFile</em></a><em>, </em><em>optional</em>) – Defines a static enrichment table loaded from a CSV file.</p></li>
7615976167
<li><p><strong>geoip</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.observability_pipeline_enrichment_table_geo_ip.ObservabilityPipelineEnrichmentTableGeoIp" title="datadog_api_client.v2.model.observability_pipeline_enrichment_table_geo_ip.ObservabilityPipelineEnrichmentTableGeoIp"><em>ObservabilityPipelineEnrichmentTableGeoIp</em></a><em>, </em><em>optional</em>) – Uses a GeoIP database to enrich logs based on an IP field.</p></li>
@@ -76232,6 +76240,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
7623276240
<dl class="field-list simple">
7623376241
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7623476242
<dd class="field-odd"><ul class="simple">
76243+
<li><p><strong>display_name</strong> (<em>str</em><em>, </em><em>optional</em>) – The display name for a component.</p></li>
7623576244
<li><p><strong>enabled</strong> (<em>bool</em>) – Whether this processor is enabled.</p></li>
7623676245
<li><p><strong>id</strong> (<em>str</em>) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (for example, as the <code class="docutils literal notranslate"><span class="pre">input</span></code> to downstream components).</p></li>
7623776246
<li><p><strong>include</strong> (<em>str</em>) – A Datadog search query used to determine which logs should pass through the filter. Logs that match this query continue to downstream components; others are dropped.</p></li>
@@ -76411,6 +76420,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
7641176420
<dl class="field-list simple">
7641276421
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7641376422
<dd class="field-odd"><ul class="simple">
76423+
<li><p><strong>display_name</strong> (<em>str</em><em>, </em><em>optional</em>) – The display name for a component.</p></li>
7641476424
<li><p><strong>enabled</strong> (<em>bool</em>) – Whether this processor is enabled.</p></li>
7641576425
<li><p><strong>id</strong> (<em>str</em>) – The unique identifier for this component. Used to reference this component in other parts of the pipeline.</p></li>
7641676426
<li><p><strong>include</strong> (<em>str</em><em>, </em><em>optional</em>) – A Datadog search query used to determine which logs this processor targets.</p></li>
@@ -77429,6 +77439,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
7742977439
<dl class="field-list simple">
7743077440
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7743177441
<dd class="field-odd"><ul class="simple">
77442+
<li><p><strong>display_name</strong> (<em>str</em><em>, </em><em>optional</em>) – The display name for a component.</p></li>
7743277443
<li><p><strong>enabled</strong> (<em>bool</em>) – Whether this processor is enabled.</p></li>
7743377444
<li><p><strong>id</strong> (<em>str</em>) – The unique identifier for this component. Used to reference this component in other parts of the pipeline.</p></li>
7743477445
<li><p><strong>include</strong> (<em>str</em>) – A Datadog search query used to determine which logs this processor targets.</p></li>
@@ -77604,6 +77615,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
7760477615
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7760577616
<dd class="field-odd"><ul class="simple">
7760677617
<li><p><strong>disable_library_rules</strong> (<em>bool</em><em>, </em><em>optional</em>) – If set to <code class="docutils literal notranslate"><span class="pre">true</span></code> , disables the default Grok rules provided by Datadog.</p></li>
77618+
<li><p><strong>display_name</strong> (<em>str</em><em>, </em><em>optional</em>) – The display name for a component.</p></li>
7760777619
<li><p><strong>enabled</strong> (<em>bool</em>) – Whether this processor is enabled.</p></li>
7760877620
<li><p><strong>id</strong> (<em>str</em>) – A unique identifier for this processor.</p></li>
7760977621
<li><p><strong>include</strong> (<em>str</em>) – A Datadog search query used to determine which logs this processor targets.</p></li>
@@ -77726,6 +77738,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
7772677738
<dl class="field-list simple">
7772777739
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7772877740
<dd class="field-odd"><ul class="simple">
77741+
<li><p><strong>display_name</strong> (<em>str</em><em>, </em><em>optional</em>) – The display name for a component.</p></li>
7772977742
<li><p><strong>enabled</strong> (<em>bool</em>) – Whether this processor is enabled.</p></li>
7773077743
<li><p><strong>field</strong> (<em>str</em>) – The name of the log field that contains a JSON string.</p></li>
7773177744
<li><p><strong>id</strong> (<em>str</em>) – A unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).</p></li>
@@ -77812,6 +77825,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
7781277825
<dl class="field-list simple">
7781377826
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7781477827
<dd class="field-odd"><ul class="simple">
77828+
<li><p><strong>display_name</strong> (<em>str</em><em>, </em><em>optional</em>) – The display name for a component.</p></li>
7781577829
<li><p><strong>drop_events</strong> (<em>bool</em><em>, </em><em>optional</em>) – If set to <code class="docutils literal notranslate"><span class="pre">true</span></code> , logs that matched the quota filter and sent after the quota has been met are dropped; only logs that did not match the filter query continue through the pipeline.</p></li>
7781677830
<li><p><strong>enabled</strong> (<em>bool</em>) – Whether this processor is enabled.</p></li>
7781777831
<li><p><strong>id</strong> (<em>str</em>) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (for example, as the <code class="docutils literal notranslate"><span class="pre">input</span></code> to downstream components).</p></li>
@@ -77990,6 +78004,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
7799078004
<dl class="field-list simple">
7799178005
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7799278006
<dd class="field-odd"><ul class="simple">
78007+
<li><p><strong>display_name</strong> (<em>str</em><em>, </em><em>optional</em>) – The display name for a component.</p></li>
7799378008
<li><p><strong>enabled</strong> (<em>bool</em>) – Whether this processor is enabled.</p></li>
7799478009
<li><p><strong>group_by</strong> (<em>[</em><em>str</em><em>]</em>) – A list of fields used to group log events for merging.</p></li>
7799578010
<li><p><strong>id</strong> (<em>str</em>) – The unique identifier for this processor.</p></li>
@@ -78098,6 +78113,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
7809878113
<dl class="field-list simple">
7809978114
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7810078115
<dd class="field-odd"><ul class="simple">
78116+
<li><p><strong>display_name</strong> (<em>str</em><em>, </em><em>optional</em>) – The display name for a component.</p></li>
7810178117
<li><p><strong>enabled</strong> (<em>bool</em>) – Whether this processor is enabled.</p></li>
7810278118
<li><p><strong>fields</strong> (<em>[</em><em>str</em><em>]</em>) – A list of field names to be removed from each log event.</p></li>
7810378119
<li><p><strong>id</strong> (<em>str</em>) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).</p></li>
@@ -78153,6 +78169,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
7815378169
<dl class="field-list simple">
7815478170
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7815578171
<dd class="field-odd"><ul class="simple">
78172+
<li><p><strong>display_name</strong> (<em>str</em><em>, </em><em>optional</em>) – The display name for a component.</p></li>
7815678173
<li><p><strong>enabled</strong> (<em>bool</em>) – Whether this processor is enabled.</p></li>
7815778174
<li><p><strong>fields</strong> (<em>[</em><a class="reference internal" href="#datadog_api_client.v2.model.observability_pipeline_rename_fields_processor_field.ObservabilityPipelineRenameFieldsProcessorField" title="datadog_api_client.v2.model.observability_pipeline_rename_fields_processor_field.ObservabilityPipelineRenameFieldsProcessorField"><em>ObservabilityPipelineRenameFieldsProcessorField</em></a><em>]</em>) – A list of rename rules specifying which fields to rename in the event, what to rename them to, and whether to preserve the original fields.</p></li>
7815878175
<li><p><strong>id</strong> (<em>str</em>) – A unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).</p></li>
@@ -78339,6 +78356,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
7833978356
<dl class="field-list simple">
7834078357
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7834178358
<dd class="field-odd"><ul class="simple">
78359+
<li><p><strong>display_name</strong> (<em>str</em><em>, </em><em>optional</em>) – The display name for a component.</p></li>
7834278360
<li><p><strong>enabled</strong> (<em>bool</em>) – Whether this processor is enabled.</p></li>
7834378361
<li><p><strong>id</strong> (<em>str</em>) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (for example, as the <code class="docutils literal notranslate"><span class="pre">input</span></code> to downstream components).</p></li>
7834478362
<li><p><strong>include</strong> (<em>str</em>) – A Datadog search query used to determine which logs this processor targets.</p></li>
@@ -78395,6 +78413,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
7839578413
<dl class="field-list simple">
7839678414
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7839778415
<dd class="field-odd"><ul class="simple">
78416+
<li><p><strong>display_name</strong> (<em>str</em><em>, </em><em>optional</em>) – The display name for a component.</p></li>
7839878417
<li><p><strong>enabled</strong> (<em>bool</em>) – Whether this processor is enabled.</p></li>
7839978418
<li><p><strong>id</strong> (<em>str</em>) – The unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).</p></li>
7840078419
<li><p><strong>include</strong> (<em>str</em>) – A Datadog search query used to determine which logs this processor targets.</p></li>
@@ -80366,6 +80385,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
8036680385
<dl class="field-list simple">
8036780386
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
8036880387
<dd class="field-odd"><ul class="simple">
80388+
<li><p><strong>display_name</strong> (<em>str</em><em>, </em><em>optional</em>) – The display name for a component.</p></li>
8036980389
<li><p><strong>enabled</strong> (<em>bool</em>) – Whether this processor is enabled.</p></li>
8037080390
<li><p><strong>group_by</strong> (<em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – Optional list of fields used to group events before the threshold has been reached.</p></li>
8037180391
<li><p><strong>id</strong> (<em>str</em>) – The unique identifier for this processor.</p></li>

0 commit comments

Comments
 (0)