Skip to content

Commit 80ff67c

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Adding Observability Pipelines Secret Management feature support (#3525)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 919441a commit 80ff67c

File tree

46 files changed

+930
-14
lines changed

Some content is hidden

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

46 files changed

+930
-14
lines changed

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 281 additions & 5 deletions
Large diffs are not rendered by default.

‎cassettes/v2/Observability-Pipelines_4170000189/Validate-an-observability-pipeline-with-destination-secret-key-returns-OK-response_1497740330/frozen.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2026-02-20T14:42:05.988Z"

‎cassettes/v2/Observability-Pipelines_4170000189/Validate-an-observability-pipeline-with-destination-secret-key-returns-OK-response_1497740330/recording.har‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
{
2+
"log": {
3+
"_recordingName": "Observability Pipelines/Validate an observability pipeline with destination secret key returns \"OK\" response",
4+
"creator": {
5+
"comment": "persister:fs",
6+
"name": "Polly.JS",
7+
"version": "6.0.5"
8+
},
9+
"entries": [
10+
{
11+
"_id": "c01ed7042c1eca7eb2709abf07f54e60",
12+
"_order": 0,
13+
"cache": {},
14+
"request": {
15+
"bodySize": 526,
16+
"cookies": [],
17+
"headers": [
18+
{
19+
"_fromType": "array",
20+
"name": "accept",
21+
"value": "application/json"
22+
},
23+
{
24+
"_fromType": "array",
25+
"name": "content-type",
26+
"value": "application/json"
27+
}
28+
],
29+
"headersSize": 583,
30+
"httpVersion": "HTTP/1.1",
31+
"method": "POST",
32+
"postData": {
33+
"mimeType": "application/json",
34+
"params": [],
35+
"text": "{\"data\":{\"attributes\":{\"config\":{\"destinations\":[{\"endpoint_url_key\":\"SUMO_LOGIC_ENDPOINT_URL\",\"id\":\"sumo-logic-destination\",\"inputs\":[\"my-processor-group\"],\"type\":\"sumo_logic\"}],\"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\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]},\"name\":\"Pipeline with Secret Key\"},\"type\":\"pipelines\"}}"
36+
},
37+
"queryString": [],
38+
"url": "https://api.datadoghq.com/api/v2/obs-pipelines/pipelines/validate"
39+
},
40+
"response": {
41+
"bodySize": 14,
42+
"content": {
43+
"mimeType": "application/vnd.api+json",
44+
"size": 14,
45+
"text": "{\"errors\":[]}\n"
46+
},
47+
"cookies": [],
48+
"headers": [
49+
{
50+
"name": "content-type",
51+
"value": "application/vnd.api+json"
52+
}
53+
],
54+
"headersSize": 370,
55+
"httpVersion": "HTTP/1.1",
56+
"redirectURL": "",
57+
"status": 200,
58+
"statusText": "OK"
59+
},
60+
"startedDateTime": "2026-02-20T14:42:05.991Z",
61+
"time": 369
62+
}
63+
],
64+
"pages": [],
65+
"version": "1.2"
66+
}
67+
}

‎cassettes/v2/Observability-Pipelines_4170000189/Validate-an-observability-pipeline-with-source-secret-key-returns-OK-response_3962960055/frozen.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2026-02-20T14:42:32.372Z"

‎cassettes/v2/Observability-Pipelines_4170000189/Validate-an-observability-pipeline-with-source-secret-key-returns-OK-response_3962960055/recording.har‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
{
2+
"log": {
3+
"_recordingName": "Observability Pipelines/Validate an observability pipeline with source secret key returns \"OK\" response",
4+
"creator": {
5+
"comment": "persister:fs",
6+
"name": "Polly.JS",
7+
"version": "6.0.5"
8+
},
9+
"entries": [
10+
{
11+
"_id": "abf3ef3d218bce08cf81f3126665181b",
12+
"_order": 0,
13+
"cache": {},
14+
"request": {
15+
"bodySize": 608,
16+
"cookies": [],
17+
"headers": [
18+
{
19+
"_fromType": "array",
20+
"name": "accept",
21+
"value": "application/json"
22+
},
23+
{
24+
"_fromType": "array",
25+
"name": "content-type",
26+
"value": "application/json"
27+
}
28+
],
29+
"headersSize": 583,
30+
"httpVersion": "HTTP/1.1",
31+
"method": "POST",
32+
"postData": {
33+
"mimeType": "application/json",
34+
"params": [],
35+
"text": "{\"data\":{\"attributes\":{\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"my-processor-group\"],\"type\":\"datadog_logs\"}],\"processor_groups\":[{\"enabled\":true,\"id\":\"my-processor-group\",\"include\":\"service:my-service\",\"inputs\":[\"http-client-source\"],\"processors\":[{\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"auth_strategy\":\"bearer\",\"decoding\":\"bytes\",\"id\":\"http-client-source\",\"scrape_interval_secs\":15,\"scrape_timeout_secs\":5,\"token_key\":\"HTTP_CLIENT_TOKEN\",\"type\":\"http_client\"}]},\"name\":\"Pipeline with Source Secret\"},\"type\":\"pipelines\"}}"
36+
},
37+
"queryString": [],
38+
"url": "https://api.datadoghq.com/api/v2/obs-pipelines/pipelines/validate"
39+
},
40+
"response": {
41+
"bodySize": 14,
42+
"content": {
43+
"mimeType": "application/vnd.api+json",
44+
"size": 14,
45+
"text": "{\"errors\":[]}\n"
46+
},
47+
"cookies": [],
48+
"headers": [
49+
{
50+
"name": "content-type",
51+
"value": "application/vnd.api+json"
52+
}
53+
],
54+
"headersSize": 370,
55+
"httpVersion": "HTTP/1.1",
56+
"redirectURL": "",
57+
"status": 200,
58+
"statusText": "OK"
59+
},
60+
"startedDateTime": "2026-02-20T14:42:32.375Z",
61+
"time": 375
62+
}
63+
],
64+
"pages": [],
65+
"version": "1.2"
66+
}
67+
}

‎features/v2/observability_pipelines.feature‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,3 +190,19 @@ Feature: Observability Pipelines
190190
When the request is sent
191191
Then the response status is 200 OK
192192
And the response "errors" has length 0
193+
194+
@team:DataDog/observability-pipelines
195+
Scenario: Validate an observability pipeline with destination secret key returns "OK" response
196+
Given new "ValidatePipeline" request
197+
And body with value {"data": {"attributes": {"config": {"destinations": [{"id": "sumo-logic-destination", "inputs": ["my-processor-group"], "type": "sumo_logic", "endpoint_url_key": "SUMO_LOGIC_ENDPOINT_URL"}], "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"}]}], "sources": [{"id": "datadog-agent-source", "type": "datadog_agent"}]}, "name": "Pipeline with Secret Key"}, "type": "pipelines"}}
198+
When the request is sent
199+
Then the response status is 200 OK
200+
And the response "errors" has length 0
201+
202+
@team:DataDog/observability-pipelines
203+
Scenario: Validate an observability pipeline with source secret key returns "OK" response
204+
Given new "ValidatePipeline" request
205+
And body with value {"data": {"attributes": {"config": {"destinations": [{"id": "datadog-logs-destination", "inputs": ["my-processor-group"], "type": "datadog_logs"}], "processor_groups": [{"enabled": true, "id": "my-processor-group", "include": "service:my-service", "inputs": ["http-client-source"], "processors": [{"enabled": true, "id": "filter-processor", "include": "status:error", "type": "filter"}]}], "sources": [{"id": "http-client-source", "type": "http_client", "decoding": "bytes", "scrape_interval_secs": 15, "scrape_timeout_secs": 5, "auth_strategy": "bearer", "token_key": "HTTP_CLIENT_TOKEN"}]}, "name": "Pipeline with Source Secret"}, "type": "pipelines"}}
206+
When the request is sent
207+
Then the response status is 200 OK
208+
And the response "errors" has length 0

‎services/observability_pipelines/src/v2/index.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ export { ObservabilityPipelineDedupeProcessorType } from "./models/Observability
7878
export { ObservabilityPipelineDiskBufferOptions } from "./models/ObservabilityPipelineDiskBufferOptions";
7979
export { ObservabilityPipelineElasticsearchDestination } from "./models/ObservabilityPipelineElasticsearchDestination";
8080
export { ObservabilityPipelineElasticsearchDestinationApiVersion } from "./models/ObservabilityPipelineElasticsearchDestinationApiVersion";
81+
export { ObservabilityPipelineElasticsearchDestinationAuth } from "./models/ObservabilityPipelineElasticsearchDestinationAuth";
8182
export { ObservabilityPipelineElasticsearchDestinationDataStream } from "./models/ObservabilityPipelineElasticsearchDestinationDataStream";
8283
export { ObservabilityPipelineElasticsearchDestinationType } from "./models/ObservabilityPipelineElasticsearchDestinationType";
8384
export { ObservabilityPipelineEnrichmentTableFile } from "./models/ObservabilityPipelineEnrichmentTableFile";

‎services/observability_pipelines/src/v2/models/AzureStorageDestination.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ export class AzureStorageDestination {
1717
* Configuration for buffer settings on destination components.
1818
*/
1919
"buffer"?: ObservabilityPipelineBufferOptions;
20+
/**
21+
* Name of the environment variable or secret that holds the Azure Storage connection string.
22+
*/
23+
"connectionStringKey"?: string;
2024
/**
2125
* The name of the Azure Blob Storage container to store logs in.
2226
*/
@@ -56,6 +60,10 @@ export class AzureStorageDestination {
5660
baseName: "buffer",
5761
type: "ObservabilityPipelineBufferOptions",
5862
},
63+
connectionStringKey: {
64+
baseName: "connection_string_key",
65+
type: "string",
66+
},
5967
containerName: {
6068
baseName: "container_name",
6169
type: "string",

‎services/observability_pipelines/src/v2/models/MicrosoftSentinelDestination.ts‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@ export class MicrosoftSentinelDestination {
1717
* Azure AD client ID used for authentication.
1818
*/
1919
"clientId": string;
20+
/**
21+
* Name of the environment variable or secret that holds the Azure AD client secret.
22+
*/
23+
"clientSecretKey"?: string;
24+
/**
25+
* Name of the environment variable or secret that holds the Data Collection Endpoint (DCE) URI.
26+
*/
27+
"dceUriKey"?: string;
2028
/**
2129
* The immutable ID of the Data Collection Rule (DCR).
2230
*/
@@ -65,6 +73,14 @@ export class MicrosoftSentinelDestination {
6573
type: "string",
6674
required: true,
6775
},
76+
clientSecretKey: {
77+
baseName: "client_secret_key",
78+
type: "string",
79+
},
80+
dceUriKey: {
81+
baseName: "dce_uri_key",
82+
type: "string",
83+
},
6884
dcrImmutableId: {
6985
baseName: "dcr_immutable_id",
7086
type: "string",

‎services/observability_pipelines/src/v2/models/ObservabilityPipelineAmazonDataFirehoseSource.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ import { ObservabilityPipelineTls } from "./ObservabilityPipelineTls";
1010
* **Supported pipeline types:** logs
1111
*/
1212
export class ObservabilityPipelineAmazonDataFirehoseSource {
13+
/**
14+
* Name of the environment variable or secret that holds the Firehose delivery stream address.
15+
*/
16+
"addressKey"?: string;
1317
/**
1418
* AWS authentication credentials used for accessing AWS services such as S3.
1519
* If omitted, the system’s default credentials are used (for example, the IAM role and environment variables).
@@ -42,6 +46,10 @@ export class ObservabilityPipelineAmazonDataFirehoseSource {
4246
* @ignore
4347
*/
4448
static readonly attributeTypeMap: AttributeTypeMap = {
49+
addressKey: {
50+
baseName: "address_key",
51+
type: "string",
52+
},
4553
auth: {
4654
baseName: "auth",
4755
type: "ObservabilityPipelineAwsAuth",

0 commit comments

Comments
 (0)