Skip to content

Add end-to-end acknowledgements to Observability Pipelines #3920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
+24 −2
Open

Add end-to-end acknowledgements to Observability Pipelines #3920

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72239,6 +72239,12 @@ components:
items:
$ref: "#/components/schemas/ObservabilityPipelineConfigDestinationItem"
type: array
end_to_end_acknowledgements:
description: |-
Enables end-to-end event delivery confirmation for the pipeline. When enabled, sources confirm receipt only after all destinations have successfully received the events.
Requires Observability Pipelines Worker 2.14 or later. All configured sources must support this behavior.
example: true
type: boolean
pipeline_type:
$ref: "#/components/schemas/ObservabilityPipelineConfigPipelineType"
processor_groups:
Expand Down Expand Up @@ -177228,6 +177234,7 @@ paths:
inputs:
- datadog-agent-source
type: datadog_logs
end_to_end_acknowledgements: true
sources:
- id: datadog-agent-source
type: datadog_agent
Expand Down Expand Up @@ -177267,6 +177274,7 @@ paths:
inputs:
- my-processor-group
type: datadog_logs
end_to_end_acknowledgements: true
pipeline_type: logs
processor_groups:
- enabled: true
Expand Down Expand Up @@ -177308,6 +177316,7 @@ paths:
inputs:
- datadog-agent-source
type: datadog_logs
end_to_end_acknowledgements: true
sources:
- id: datadog-agent-source
type: datadog_agent
Expand Down Expand Up @@ -177352,6 +177361,7 @@ paths:
inputs:
- my-processor-group
type: datadog_logs
end_to_end_acknowledgements: true
pipeline_type: logs
processor_groups:
- enabled: true
Expand Down Expand Up @@ -177468,6 +177478,7 @@ paths:
inputs:
- datadog-agent-source
type: datadog_logs
end_to_end_acknowledgements: true
sources:
- id: datadog-agent-source
type: datadog_agent
Expand Down Expand Up @@ -177516,6 +177527,7 @@ paths:
inputs:
- my-processor-group
type: datadog_logs
end_to_end_acknowledgements: true
pipeline_type: logs
processor_groups:
- enabled: true
Expand Down Expand Up @@ -177558,6 +177570,7 @@ paths:
inputs:
- datadog-agent-source
type: datadog_logs
end_to_end_acknowledgements: true
sources:
- id: datadog-agent-source
type: datadog_agent
Expand Down
9 changes: 9 additions & 0 deletions src/datadog_api_client/v2/model/observability_pipeline_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ def openapi_types(_):

return {
"destinations": ([ObservabilityPipelineConfigDestinationItem],),
"end_to_end_acknowledgements": (bool,),
"pipeline_type": (ObservabilityPipelineConfigPipelineType,),
"processor_groups": ([ObservabilityPipelineConfigProcessorGroup],),
"processors": ([ObservabilityPipelineConfigProcessorGroup],),
Expand All @@ -170,6 +171,7 @@ def openapi_types(_):

attribute_map = {
"destinations": "destinations",
"end_to_end_acknowledgements": "end_to_end_acknowledgements",
"pipeline_type": "pipeline_type",
"processor_groups": "processor_groups",
"processors": "processors",
Expand Down Expand Up @@ -234,6 +236,7 @@ def __init__(
ObservabilityPipelineOpentelemetrySource,
]
],
end_to_end_acknowledgements: Union[bool, UnsetType] = unset,
pipeline_type: Union[ObservabilityPipelineConfigPipelineType, UnsetType] = unset,
processor_groups: Union[List[ObservabilityPipelineConfigProcessorGroup], UnsetType] = unset,
processors: Union[List[ObservabilityPipelineConfigProcessorGroup], UnsetType] = unset,
Expand All @@ -246,6 +249,10 @@ def __init__(
:param destinations: A list of destination components where processed logs are sent.
:type destinations: [ObservabilityPipelineConfigDestinationItem]

:param end_to_end_acknowledgements: Enables end-to-end event delivery confirmation for the pipeline. When enabled, sources confirm receipt only after all destinations have successfully received the events.
Requires Observability Pipelines Worker 2.14 or later. All configured sources must support this behavior.
:type end_to_end_acknowledgements: bool, optional

:param pipeline_type: The type of data being ingested. Defaults to ``logs`` if not specified.
:type pipeline_type: ObservabilityPipelineConfigPipelineType, optional

Expand All @@ -267,6 +274,8 @@ def __init__(
See `Upgrade Your Filter Queries to the New Search Syntax <https://docs.datadoghq.com/observability_pipelines/guide/upgrade_your_filter_queries_to_the_new_search_syntax/>`_ for more information.
:type use_legacy_search_syntax: bool, optional
"""
if end_to_end_acknowledgements is not unset:
kwargs["end_to_end_acknowledgements"] = end_to_end_acknowledgements
if pipeline_type is not unset:
kwargs["pipeline_type"] = pipeline_type
if processor_groups is not unset:
Expand Down
4 changes: 2 additions & 2 deletions tests/v2/features/observability_pipelines.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Feature: Observability Pipelines
@generated @skip @team:DataDog/observability-pipelines
Scenario: Create a new pipeline returns "Conflict" response
Given new "CreatePipeline" request
And body with value {"data": {"attributes": {"config": {"destinations": [{"id": "datadog-logs-destination", "inputs": ["my-processor-group"], "type": "datadog_logs"}], "pipeline_type": "logs", "processor_groups": [{"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"}, {"enabled": true, "field": "message", "id": "json-processor", "include": "*", "type": "parse_json"}]}], "processors": [], "sources": [{"id": "datadog-agent-source", "type": "datadog_agent"}]}, "name": "Main Observability Pipeline"}, "type": "pipelines"}}
And body with value {"data": {"attributes": {"config": {"destinations": [{"id": "datadog-logs-destination", "inputs": ["my-processor-group"], "type": "datadog_logs"}], "end_to_end_acknowledgements": true, "pipeline_type": "logs", "processor_groups": [{"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"}, {"enabled": true, "field": "message", "id": "json-processor", "include": "*", "type": "parse_json"}]}], "processors": [], "sources": [{"id": "datadog-agent-source", "type": "datadog_agent"}]}, "name": "Main Observability Pipeline"}, "type": "pipelines"}}
When the request is sent
Then the response status is 409 Conflict

Expand Down Expand Up @@ -121,7 +121,7 @@ Feature: Observability Pipelines
Scenario: Update a pipeline returns "Conflict" response
Given new "UpdatePipeline" request
And request contains "pipeline_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"config": {"destinations": [{"id": "datadog-logs-destination", "inputs": ["my-processor-group"], "type": "datadog_logs"}], "pipeline_type": "logs", "processor_groups": [{"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"}, {"enabled": true, "field": "message", "id": "json-processor", "include": "*", "type": "parse_json"}]}], "processors": [], "sources": [{"id": "datadog-agent-source", "type": "datadog_agent"}]}, "name": "Main Observability Pipeline"}, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "pipelines"}}
And body with value {"data": {"attributes": {"config": {"destinations": [{"id": "datadog-logs-destination", "inputs": ["my-processor-group"], "type": "datadog_logs"}], "end_to_end_acknowledgements": true, "pipeline_type": "logs", "processor_groups": [{"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"}, {"enabled": true, "field": "message", "id": "json-processor", "include": "*", "type": "parse_json"}]}], "processors": [], "sources": [{"id": "datadog-agent-source", "type": "datadog_agent"}]}, "name": "Main Observability Pipeline"}, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "pipelines"}}
When the request is sent
Then the response status is 409 Conflict

Expand Down
Loading