Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
66 changes: 63 additions & 3 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43989,6 +43989,40 @@ components:
type: string
x-enum-varnames:
- ELASTICSEARCH
ObservabilityPipelineEnrichmentTableFieldEventLookup:
description: Looks up a value from a field path in the log event.
properties:
event:
description: The path to the field in the log event to use as the lookup key.
example: log.user.id
type: string
required:
- event
type: object
ObservabilityPipelineEnrichmentTableFieldSecretLookup:
description: Looks up a value stored as a pipeline secret.
properties:
secret:
description: The name of the secret containing the lookup key value.
example: MY_LOOKUP_SECRET
type: string
required:
- secret
type: object
ObservabilityPipelineEnrichmentTableFieldStringPath:
description: A plain field path in the log event, used as the lookup key.
example: log.user.id
type: string
ObservabilityPipelineEnrichmentTableFieldVrlLookup:
description: Evaluates a VRL expression to produce the lookup key.
properties:
vrl:
description: A VRL expression that returns the value to use as the lookup key.
example: .log.user.id
type: string
required:
- vrl
type: object
ObservabilityPipelineEnrichmentTableFile:
description: Defines a static enrichment table loaded from a CSV file.
properties:
Expand Down Expand Up @@ -44039,6 +44073,16 @@ components:
type: string
x-enum-varnames:
- CSV
ObservabilityPipelineEnrichmentTableFileKeyItemField:
description: |-
Specifies the source of the key value used for enrichment table lookups.
Can be a plain field path string or an object specifying `event`, `vrl`, or `secret`.
example: log.user.id
oneOf:
- $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFieldStringPath"
- $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFieldEventLookup"
- $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFieldVrlLookup"
- $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFieldSecretLookup"
ObservabilityPipelineEnrichmentTableFileKeyItems:
description: Defines how to map log fields to enrichment table columns during lookups.
properties:
Expand All @@ -44049,9 +44093,7 @@ components:
comparison:
$ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFileKeyItemsComparison"
field:
description: The `items` `field`.
example: log.user.id
type: string
$ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFileKeyItemField"
required:
- column
- comparison
Expand Down Expand Up @@ -47072,6 +47114,8 @@ components:
description: Name of the environment variable or secret that holds the Splunk HEC token.
example: SPLUNK_HEC_TOKEN
type: string
token_strategy:
$ref: "#/components/schemas/ObservabilityPipelineSplunkHecDestinationTokenStrategy"
type:
$ref: "#/components/schemas/ObservabilityPipelineSplunkHecDestinationType"
required:
Expand All @@ -47090,6 +47134,16 @@ components:
x-enum-varnames:
- JSON
- RAW_MESSAGE
ObservabilityPipelineSplunkHecDestinationTokenStrategy:
description: Controls how the Splunk HEC token is supplied. Use `custom` to provide a token with `token_key`, or `from_source` to forward the token received from an upstream Splunk HEC source.
enum:
- custom
- from_source
example: custom
type: string
x-enum-varnames:
- CUSTOM
- FROM_SOURCE
ObservabilityPipelineSplunkHecDestinationType:
default: splunk_hec
description: The destination type. Always `splunk_hec`.
Expand All @@ -47113,6 +47167,12 @@ components:
description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components).
example: splunk-hec-source
type: string
store_hec_token:
description: |-
When `true`, the Splunk HEC token from the incoming request is stored in the event metadata.
This allows downstream components to forward the token to other Splunk HEC destinations.
example: true
type: boolean
tls:
$ref: "#/components/schemas/ObservabilityPipelineTls"
type:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
// Validate an observability pipeline with Splunk HEC destination token_strategy returns "OK"
// response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ObservabilityPipelinesApi;
import com.datadog.api.client.v2.model.ObservabilityPipelineConfig;
import com.datadog.api.client.v2.model.ObservabilityPipelineConfigDestinationItem;
import com.datadog.api.client.v2.model.ObservabilityPipelineConfigProcessorGroup;
import com.datadog.api.client.v2.model.ObservabilityPipelineConfigProcessorItem;
import com.datadog.api.client.v2.model.ObservabilityPipelineConfigSourceItem;
import com.datadog.api.client.v2.model.ObservabilityPipelineDataAttributes;
import com.datadog.api.client.v2.model.ObservabilityPipelineDatadogAgentSource;
import com.datadog.api.client.v2.model.ObservabilityPipelineDatadogAgentSourceType;
import com.datadog.api.client.v2.model.ObservabilityPipelineFilterProcessor;
import com.datadog.api.client.v2.model.ObservabilityPipelineFilterProcessorType;
import com.datadog.api.client.v2.model.ObservabilityPipelineSpec;
import com.datadog.api.client.v2.model.ObservabilityPipelineSpecData;
import com.datadog.api.client.v2.model.ObservabilityPipelineSplunkHecDestination;
import com.datadog.api.client.v2.model.ObservabilityPipelineSplunkHecDestinationTokenStrategy;
import com.datadog.api.client.v2.model.ObservabilityPipelineSplunkHecDestinationType;
import com.datadog.api.client.v2.model.ValidationResponse;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
ObservabilityPipelinesApi apiInstance = new ObservabilityPipelinesApi(defaultClient);

ObservabilityPipelineSpec body =
new ObservabilityPipelineSpec()
.data(
new ObservabilityPipelineSpecData()
.attributes(
new ObservabilityPipelineDataAttributes()
.config(
new ObservabilityPipelineConfig()
.destinations(
Collections.singletonList(
new ObservabilityPipelineConfigDestinationItem(
new ObservabilityPipelineSplunkHecDestination()
.id("splunk-hec-destination")
.inputs(
Collections.singletonList(
"my-processor-group"))
.type(
ObservabilityPipelineSplunkHecDestinationType
.SPLUNK_HEC)
.tokenKey("SPLUNK_HEC_TOKEN")
.tokenStrategy(
ObservabilityPipelineSplunkHecDestinationTokenStrategy
.CUSTOM))))
.processorGroups(
Collections.singletonList(
new ObservabilityPipelineConfigProcessorGroup()
.enabled(true)
.id("my-processor-group")
.include("service:my-service")
.inputs(
Collections.singletonList(
"datadog-agent-source"))
.processors(
Collections.singletonList(
new ObservabilityPipelineConfigProcessorItem(
new ObservabilityPipelineFilterProcessor()
.enabled(true)
.id("filter-processor")
.include("status:error")
.type(
ObservabilityPipelineFilterProcessorType
.FILTER))))))
.sources(
Collections.singletonList(
new ObservabilityPipelineConfigSourceItem(
new ObservabilityPipelineDatadogAgentSource()
.id("datadog-agent-source")
.type(
ObservabilityPipelineDatadogAgentSourceType
.DATADOG_AGENT)))))
.name("Pipeline with Splunk HEC token_strategy"))
.type("pipelines"));

try {
ValidationResponse result = apiInstance.validatePipeline(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObservabilityPipelinesApi#validatePipeline");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
// Validate an observability pipeline with Splunk HEC source store_hec_token returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ObservabilityPipelinesApi;
import com.datadog.api.client.v2.model.ObservabilityPipelineConfig;
import com.datadog.api.client.v2.model.ObservabilityPipelineConfigDestinationItem;
import com.datadog.api.client.v2.model.ObservabilityPipelineConfigProcessorGroup;
import com.datadog.api.client.v2.model.ObservabilityPipelineConfigProcessorItem;
import com.datadog.api.client.v2.model.ObservabilityPipelineConfigSourceItem;
import com.datadog.api.client.v2.model.ObservabilityPipelineDataAttributes;
import com.datadog.api.client.v2.model.ObservabilityPipelineDatadogLogsDestination;
import com.datadog.api.client.v2.model.ObservabilityPipelineDatadogLogsDestinationType;
import com.datadog.api.client.v2.model.ObservabilityPipelineFilterProcessor;
import com.datadog.api.client.v2.model.ObservabilityPipelineFilterProcessorType;
import com.datadog.api.client.v2.model.ObservabilityPipelineSpec;
import com.datadog.api.client.v2.model.ObservabilityPipelineSpecData;
import com.datadog.api.client.v2.model.ObservabilityPipelineSplunkHecSource;
import com.datadog.api.client.v2.model.ObservabilityPipelineSplunkHecSourceType;
import com.datadog.api.client.v2.model.ValidationResponse;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
ObservabilityPipelinesApi apiInstance = new ObservabilityPipelinesApi(defaultClient);

ObservabilityPipelineSpec body =
new ObservabilityPipelineSpec()
.data(
new ObservabilityPipelineSpecData()
.attributes(
new ObservabilityPipelineDataAttributes()
.config(
new ObservabilityPipelineConfig()
.destinations(
Collections.singletonList(
new ObservabilityPipelineConfigDestinationItem(
new ObservabilityPipelineDatadogLogsDestination()
.id("datadog-logs-destination")
.inputs(
Collections.singletonList(
"my-processor-group"))
.type(
ObservabilityPipelineDatadogLogsDestinationType
.DATADOG_LOGS))))
.processorGroups(
Collections.singletonList(
new ObservabilityPipelineConfigProcessorGroup()
.enabled(true)
.id("my-processor-group")
.include("service:my-service")
.inputs(
Collections.singletonList("splunk-hec-source"))
.processors(
Collections.singletonList(
new ObservabilityPipelineConfigProcessorItem(
new ObservabilityPipelineFilterProcessor()
.enabled(true)
.id("filter-processor")
.include("status:error")
.type(
ObservabilityPipelineFilterProcessorType
.FILTER))))))
.sources(
Collections.singletonList(
new ObservabilityPipelineConfigSourceItem(
new ObservabilityPipelineSplunkHecSource()
.id("splunk-hec-source")
.type(
ObservabilityPipelineSplunkHecSourceType
.SPLUNK_HEC)
.storeHecToken(true)))))
.name("Pipeline with Splunk HEC store_hec_token"))
.type("pipelines"));

try {
ValidationResponse result = apiInstance.validatePipeline(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObservabilityPipelinesApi#validatePipeline");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Loading
Loading