For AI agents: A markdown version of this page is available at https://docs.datadoghq.com/api/latest/observability-pipelines/validate-an-observability-pipeline.md. A documentation index is available at /llms.txt.

Language

English Français 日本語 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 UK1 US1-FED US2-FED

Validate an observability pipeline

copy Copy pageCopied

POST https://api.ap1.datadoghq.com/api/v2/obs-pipelines/pipelines/validatehttps://api.ap2.datadoghq.com/api/v2/obs-pipelines/pipelines/validatehttps://api.datadoghq.eu/api/v2/obs-pipelines/pipelines/validatehttps://api.ddog-gov.com/api/v2/obs-pipelines/pipelines/validatehttps://api.us2.ddog-gov.com/api/v2/obs-pipelines/pipelines/validatehttps://api.uk1.datadoghq.com/api/v2/obs-pipelines/pipelines/validatehttps://api.datadoghq.com/api/v2/obs-pipelines/pipelines/validatehttps://api.us3.datadoghq.com/api/v2/obs-pipelines/pipelines/validatehttps://api.us5.datadoghq.com/api/v2/obs-pipelines/pipelines/validate

Overview

Validates a pipeline configuration without creating or updating any resources. Returns a list of validation errors, if any. This endpoint requires the observability_pipelines_read permission.

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

Contains the the pipeline configuration.

attributes [required]

object

Defines the pipeline’s name and its components (sources, processors, and destinations).

config [required]

object

Specifies the pipeline's configuration, including its sources, processors, and destinations.

destinations [required]

[ <oneOf>]

A list of destination components where processed logs are sent.

<type=elasticsearch>

object

The elasticsearch destination writes logs or metrics to an Elasticsearch cluster.

Supported pipeline types: logs, metrics

api_version

enum

The Elasticsearch API version to use. Set to auto to auto-detect. Allowed enum values: auto,v6,v7,v8

auth

object

Authentication settings for the Elasticsearch destination. When strategy is basic, use username_key and password_key to reference credentials stored in environment variables or secrets.

password_key

string

Name of the environment variable or secret that holds the Elasticsearch password (used when strategy is basic).

strategy [required]

enum

The authentication strategy to use. Allowed enum values: basic,aws

username_key

string

Name of the environment variable or secret that holds the Elasticsearch username (used when strategy is basic).

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

bulk_index

string

The name of the index to write events to in Elasticsearch.

compression

object

Compression configuration for the Elasticsearch destination.

algorithm [required]

enum

The compression algorithm applied when sending data to Elasticsearch. Allowed enum values: none,gzip,zlib,zstd,snappy

level

int64

The compression level. Only applicable for gzip, zlib, and zstd algorithms.

data_stream

object

Configuration options for writing to Elasticsearch Data Streams instead of a fixed index.

auto_routing

boolean

When true, automatically routes events to the appropriate data stream based on the event content.

dataset

string

The data stream dataset. This groups events by their source or application.

dtype

string

The data stream type. This determines how events are categorized within the data stream.

namespace

string

The data stream namespace. This separates events into different environments or domains.

sync_fields

boolean

When true, synchronizes data stream fields with the Elasticsearch index mapping.

endpoint_url_key

string

Name of the environment variable or secret that holds the Elasticsearch endpoint URL.

id [required]

string

The unique identifier for this component.

id_key

string

The name of the field used as the document ID in Elasticsearch.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

pipeline

string

The name of an Elasticsearch ingest pipeline to apply to events before indexing.

request_retry_partial

boolean

When true, retries failed partial bulk requests when some events in a batch fail while others succeed.

tls

object

Configuration for enabling TLS encryption between the pipeline component and external services.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

type [required]

enum

The destination type. The value should always be elasticsearch. Allowed enum values: elasticsearch

default: elasticsearch

<type=http_client>

object

The http_client destination sends data to an HTTP endpoint.

Supported pipeline types: logs, metrics

auth_strategy

enum

HTTP authentication strategy. Allowed enum values: none,basic,bearer,custom

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

compression

object

Compression configuration for HTTP requests.

algorithm [required]

enum

Compression algorithm. Allowed enum values: gzip

custom_key

string

Name of the environment variable or secret that holds a custom header value (used with custom auth strategies).

encoding [required]

enum

Encoding format for log events. Allowed enum values: json

id [required]

string

The unique identifier for this component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

password_key

string

Name of the environment variable or secret that holds the password (used when auth_strategy is basic).

tls

object

Configuration for enabling TLS encryption between the pipeline component and external services.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

server_name

string

Server name to use for Server Name Indication (SNI) and to verify against the certificate presented by the remote host. Use this when the address you connect to doesn't match the certificate's Common Name or Subject Alternative Name.

token_key

string

Name of the environment variable or secret that holds the bearer token (used when auth_strategy is bearer).

type [required]

enum

The destination type. The value should always be http_client. Allowed enum values: http_client

default: http_client

uri_key

string

Name of the environment variable or secret that holds the HTTP endpoint URI.

username_key

string

Name of the environment variable or secret that holds the username (used when auth_strategy is basic).

<type=amazon_opensearch>

object

The amazon_opensearch destination writes logs to Amazon OpenSearch.

Supported pipeline types: logs

auth [required]

object

Authentication settings for the Amazon OpenSearch destination. The strategy field determines whether basic or AWS-based authentication is used.

assume_role

string

The ARN of the role to assume (used with aws strategy).

aws_region

string

AWS region

external_id

string

External ID for the assumed role (used with aws strategy).

session_name

string

Session name for the assumed role (used with aws strategy).

strategy [required]

enum

The authentication strategy to use. Allowed enum values: basic,aws

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

bulk_index

string

The index to write logs to.

id [required]

string

The unique identifier for this component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

type [required]

enum

The destination type. The value should always be amazon_opensearch. Allowed enum values: amazon_opensearch

default: amazon_opensearch

<type=amazon_s3>

object

The amazon_s3 destination sends your logs in Datadog-rehydratable format to an Amazon S3 bucket for archiving.

Supported pipeline types: logs

auth

object

AWS authentication credentials used for accessing AWS services such as S3. If omitted, the system’s default credentials are used (for example, the IAM role and environment variables).

assume_role

string

The Amazon Resource Name (ARN) of the role to assume.

external_id

string

A unique identifier for cross-account role assumption.

session_name

string

A session identifier used for logging and tracing the assumed role session.

bucket [required]

string

S3 bucket name.

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

compression

 <oneOf>

Compression configuration for archived logs. When omitted, logs are compressed with gzip for backward compatibility.

<algorithm=zstd>

object

Zstd compression.

algorithm [required]

enum

The compression type. Always zstd. Allowed enum values: zstd

default: zstd

level [required]

int64

Zstd compression level. Valid values range from 1 to 21.

<algorithm=gzip>

object

Gzip compression.

algorithm [required]

enum

The compression type. Always gzip. Allowed enum values: gzip

default: gzip

level [required]

int64

Gzip compression level. Valid values range from 1 to 9.

id [required]

string

Unique identifier for the destination component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

key_prefix

string

Optional prefix for object keys.

region [required]

string

AWS region of the S3 bucket.

server_side_encryption

enum

Server-side encryption type for Amazon S3. Allowed enum values: aws:kms,AES256

ssekms_key_id

string

The AWS KMS key ID used for SSE-KMS encryption. Only applies when server_side_encryption is set to aws:kms.

storage_class [required]

enum

S3 storage class. Allowed enum values: STANDARD,REDUCED_REDUNDANCY,INTELLIGENT_TIERING,STANDARD_IA,EXPRESS_ONEZONE,ONEZONE_IA,GLACIER,GLACIER_IR,DEEP_ARCHIVE

tls

object

Configuration for enabling TLS encryption between the pipeline component and external services.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

type [required]

enum

The destination type. Always amazon_s3. Allowed enum values: amazon_s3

default: amazon_s3

<type=amazon_s3_generic>

object

The amazon_s3_generic destination sends your logs to an Amazon S3 bucket.

Supported pipeline types: logs

auth

object

AWS authentication credentials used for accessing AWS services such as S3. If omitted, the system’s default credentials are used (for example, the IAM role and environment variables).

assume_role

string

The Amazon Resource Name (ARN) of the role to assume.

external_id

string

A unique identifier for cross-account role assumption.

session_name

string

A session identifier used for logging and tracing the assumed role session.

batch_settings

object

Event batching settings

batch_size

int64

Maximum batch size in bytes.

timeout_secs

int64

Maximum number of seconds to wait before flushing the batch.

bucket [required]

string

S3 bucket name.

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

compression [required]

 <oneOf>

Compression algorithm applied to encoded logs.

<algorithm=zstd>

object

Zstd compression.

algorithm [required]

enum

The compression type. Always zstd. Allowed enum values: zstd

default: zstd

level [required]

int64

Zstd compression level.

<algorithm=gzip>

object

Gzip compression.

algorithm [required]

enum

The compression type. Always gzip. Allowed enum values: gzip

default: gzip

level [required]

int64

Gzip compression level.

<algorithm=snappy>

object

Snappy compression.

algorithm [required]

enum

The compression type. Always snappy. Allowed enum values: snappy

default: snappy

encoding [required]

 <oneOf>

Encoding format for the destination.

<type=json>

object

JSON encoding.

type [required]

enum

The encoding type. Always json. Allowed enum values: json

default: json

<type=parquet>

object

Parquet encoding.

type [required]

enum

The encoding type. Always parquet. Allowed enum values: parquet

default: parquet

id [required]

string

Unique identifier for the destination component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

key_prefix

string

Optional prefix for object keys.

region [required]

string

AWS region of the S3 bucket.

server_side_encryption

enum

Server-side encryption type for Amazon S3. Allowed enum values: aws:kms,AES256

ssekms_key_id

string

The AWS KMS key ID used for SSE-KMS encryption. Only applies when server_side_encryption is set to aws:kms.

storage_class [required]

enum

S3 storage class. Allowed enum values: STANDARD,REDUCED_REDUNDANCY,INTELLIGENT_TIERING,STANDARD_IA,EXPRESS_ONEZONE,ONEZONE_IA,GLACIER,GLACIER_IR,DEEP_ARCHIVE

type [required]

enum

The destination type. Always amazon_s3_generic. Allowed enum values: amazon_s3_generic

default: amazon_s3_generic

<type=amazon_security_lake>

object

The amazon_security_lake destination sends your logs to Amazon Security Lake.

Supported pipeline types: logs

auth

object

AWS authentication credentials used for accessing AWS services such as S3. If omitted, the system’s default credentials are used (for example, the IAM role and environment variables).

assume_role

string

The Amazon Resource Name (ARN) of the role to assume.

external_id

string

A unique identifier for cross-account role assumption.

session_name

string

A session identifier used for logging and tracing the assumed role session.

bucket [required]

string

Name of the Amazon S3 bucket in Security Lake (3-63 characters).

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

custom_source_name [required]

string

Custom source name for the logs in Security Lake.

id [required]

string

Unique identifier for the destination component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

region [required]

string

AWS region of the S3 bucket.

tls

object

Configuration for enabling TLS encryption between the pipeline component and external services.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

type [required]

enum

The destination type. Always amazon_security_lake. Allowed enum values: amazon_security_lake

default: amazon_security_lake

<type=azure_storage>

object

The azure_storage destination forwards logs to an Azure Blob Storage container.

Supported pipeline types: logs

blob_prefix

string

Optional prefix for blobs written to the container.

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

compression

 <oneOf>

Compression configuration for archived logs. When omitted, logs are compressed with gzip for backward compatibility.

<algorithm=zstd>

object

Zstd compression.

algorithm [required]

enum

The compression type. Always zstd. Allowed enum values: zstd

default: zstd

level [required]

int64

Zstd compression level. Valid values range from 1 to 21.

<algorithm=gzip>

object

Gzip compression.

algorithm [required]

enum

The compression type. Always gzip. Allowed enum values: gzip

default: gzip

level [required]

int64

Gzip compression level. Valid values range from 1 to 9.

connection_string_key

string

Name of the environment variable or secret that holds the Azure Storage connection string.

container_name [required]

string

The name of the Azure Blob Storage container to store logs in.

id [required]

string

The unique identifier for this component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

type [required]

enum

The destination type. The value should always be azure_storage. Allowed enum values: azure_storage

default: azure_storage

<type=clickhouse>

object

The clickhouse destination sends log events to a ClickHouse database table over HTTP.

Supported pipeline types: logs.

auth

object

HTTP Basic Authentication credentials for the ClickHouse destination. When strategy is basic, provide username_key and password_key that reference environment variables or secrets containing the credentials.

password_key

string

Name of the environment variable or secret that contains the ClickHouse password.

strategy [required]

enum

The authentication strategy for ClickHouse HTTP requests. Only basic is supported. Allowed enum values: basic

username_key

string

Name of the environment variable or secret that contains the ClickHouse username.

batch

object

Batching configuration for ClickHouse inserts.

max_events

int64

Maximum number of events per batch before it is flushed.

timeout_secs

int64

Maximum number of seconds to wait before flushing a partial batch.

batch_encoding

object

Batch encoding configuration for the ClickHouse destination. Required when format is arrow_stream. The codec field must be set to arrow_stream.

allow_nullable_fields

boolean

When true, null values are allowed for non-nullable fields in the ClickHouse schema. When false (default), missing values for non-nullable columns cause encoding errors.

codec [required]

enum

The codec used for batch encoding. Only arrow_stream is supported. Allowed enum values: arrow_stream

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

compression

 <oneOf>

Compression setting for outbound HTTP requests to ClickHouse. Can be specified as a shorthand string ("gzip" or "none") or as an object with an algorithm field and an optional level (gzip only, 1–9).

Object 1

enum

The compression algorithm applied to outbound HTTP requests. Allowed enum values: gzip,none

Object 2

object

Structured compression configuration for the ClickHouse destination. Use algorithm to specify the compression type and level (optional, gzip only) to control compression strength.

algorithm [required]

enum

The compression algorithm applied to outbound HTTP requests. Allowed enum values: gzip,none

level

int64

Compression level (1–9). Only applicable when algorithm is gzip.

database

string

Optional ClickHouse database name. If omitted, the user's default database on the ClickHouse server is used.

date_time_best_effort

boolean

When true, enables flexible DateTime parsing on the ClickHouse server side.

endpoint_url_key

string

Name of the environment variable or secret that contains the ClickHouse HTTP endpoint URL. Defaults to DESTINATION_CLICKHOUSE_ENDPOINT_URL (prefixed with DD_OP_ at runtime).

format

enum

Insert format for events sent to ClickHouse.

  • json_each_row: Maps event fields to columns by name (ClickHouse JSONEachRow).
  • json_as_object: Inserts each event into a single Object('json') / JSON column (ClickHouse JSONAsObject).
  • json_as_string: Inserts each event into a single String-typed column as raw JSON (ClickHouse JSONAsString).
  • arrow_stream: Batches events using Apache Arrow IPC streaming format. Requires batch_encoding. Allowed enum values: json_each_row,json_as_object,json_as_string,arrow_stream

id [required]

string

The unique identifier for this component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

skip_unknown_fields

boolean

When true, fields not present in the target table schema are dropped instead of causing insert errors. When unset, the ClickHouse server's own input_format_skip_unknown_fields setting applies.

table [required]

string

Target ClickHouse table name. Events are inserted into this table.

tls

object

Configuration for enabling TLS encryption between the pipeline component and external services.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

type [required]

enum

The destination type. The value must be clickhouse. Allowed enum values: clickhouse

default: clickhouse

<type=cloud_prem>

object

The cloud_prem destination sends logs to Datadog CloudPrem.

Supported pipeline types: logs

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

endpoint_url_key

string

Name of the environment variable or secret that holds the CloudPrem endpoint URL.

id [required]

string

The unique identifier for this component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

tls

object

Configuration for TLS encryption.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

server_name

string

Server name to use for Server Name Indication (SNI) and to verify against the certificate presented by the remote host. Use this when the address you connect to doesn't match the certificate's Common Name or Subject Alternative Name.

type [required]

enum

The destination type. The value should always be cloud_prem. Allowed enum values: cloud_prem

default: cloud_prem

<type=crowdstrike_next_gen_siem>

object

The crowdstrike_next_gen_siem destination forwards logs to CrowdStrike Next Gen SIEM.

Supported pipeline types: logs

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

compression

object

Compression configuration for log events.

algorithm [required]

enum

Compression algorithm for log events. Allowed enum values: gzip,zlib

level

int64

Compression level.

encoding [required]

enum

Encoding format for log events. Allowed enum values: json,raw_message

endpoint_url_key

string

Name of the environment variable or secret that holds the CrowdStrike endpoint URL.

id [required]

string

The unique identifier for this component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

tls

object

Configuration for enabling TLS encryption between the pipeline component and external services.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

token_key

string

Name of the environment variable or secret that holds the CrowdStrike API token.

type [required]

enum

The destination type. The value should always be crowdstrike_next_gen_siem. Allowed enum values: crowdstrike_next_gen_siem

default: crowdstrike_next_gen_siem

<type=datadog_logs>

object

The datadog_logs destination forwards logs to Datadog Log Management.

Supported pipeline types: logs

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

id [required]

string

The unique identifier for this component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

routes

[object]

A list of routing rules that forward matching logs to Datadog using dedicated API keys.

api_key_key

string

Name of the environment variable or secret that stores the Datadog API key used by this route.

include

string

A Datadog search query that determines which logs are forwarded using this route.

route_id

string

Unique identifier for this route within the destination.

site

string

Datadog site where matching logs are sent (for example, us1).

type [required]

enum

The destination type. The value should always be datadog_logs. Allowed enum values: datadog_logs

default: datadog_logs

<type=google_chronicle>

object

The google_chronicle destination sends logs to Google Chronicle.

Supported pipeline types: logs

auth

object

Google Cloud credentials used to authenticate with Google Cloud Storage.

credentials_file [required]

string

Path to the Google Cloud service account key file.

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

customer_id [required]

string

The Google Chronicle customer ID.

encoding

enum

The encoding format for the logs sent to Chronicle. Allowed enum values: json,raw_message

endpoint_url_key

string

Name of the environment variable or secret that holds the Google Chronicle endpoint URL.

id [required]

string

The unique identifier for this component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

log_type

string

The log type metadata associated with the Chronicle destination.

type [required]

enum

The destination type. The value should always be google_chronicle. Allowed enum values: google_chronicle

default: google_chronicle

<type=google_cloud_storage>

object

The google_cloud_storage destination stores logs in a Google Cloud Storage (GCS) bucket. It requires a bucket name, Google Cloud authentication, and metadata fields.

Supported pipeline types: logs

acl

enum

Access control list setting for objects written to the bucket. Allowed enum values: private,project-private,public-read,authenticated-read,bucket-owner-read,bucket-owner-full-control

auth

object

Google Cloud credentials used to authenticate with Google Cloud Storage.

credentials_file [required]

string

Path to the Google Cloud service account key file.

bucket [required]

string

Name of the GCS bucket.

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

compression

 <oneOf>

Compression configuration for archived logs. When omitted, logs are compressed with gzip for backward compatibility.

<algorithm=zstd>

object

Zstd compression.

algorithm [required]

enum

The compression type. Always zstd. Allowed enum values: zstd

default: zstd

level [required]

int64

Zstd compression level. Valid values range from 1 to 21.

<algorithm=gzip>

object

Gzip compression.

algorithm [required]

enum

The compression type. Always gzip. Allowed enum values: gzip

default: gzip

level [required]

int64

Gzip compression level. Valid values range from 1 to 9.

id [required]

string

Unique identifier for the destination component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

key_prefix

string

Optional prefix for object keys within the GCS bucket.

metadata

[object]

Custom metadata to attach to each object uploaded to the GCS bucket.

name [required]

string

The metadata key.

value [required]

string

The metadata value.

storage_class [required]

enum

Storage class used for objects stored in GCS. Allowed enum values: STANDARD,NEARLINE,COLDLINE,ARCHIVE

type [required]

enum

The destination type. Always google_cloud_storage. Allowed enum values: google_cloud_storage

default: google_cloud_storage

<type=google_pubsub>

object

The google_pubsub destination publishes logs to a Google Cloud Pub/Sub topic.

Supported pipeline types: logs

auth

object

Google Cloud credentials used to authenticate with Google Cloud Storage.

credentials_file [required]

string

Path to the Google Cloud service account key file.

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

encoding [required]

enum

Encoding format for log events. Allowed enum values: json,raw_message

endpoint_url_key

string

Name of the environment variable or secret that holds the Google Cloud Pub/Sub endpoint URL.

id [required]

string

The unique identifier for this component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

project [required]

string

The Google Cloud project ID that owns the Pub/Sub topic.

tls

object

Configuration for enabling TLS encryption between the pipeline component and external services.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

topic [required]

string

The Pub/Sub topic name to publish logs to.

type [required]

enum

The destination type. The value should always be google_pubsub. Allowed enum values: google_pubsub

default: google_pubsub

<type=kafka>

object

The kafka destination sends logs to Apache Kafka topics.

Supported pipeline types: logs

bootstrap_servers_key

string

Name of the environment variable or secret that holds the Kafka bootstrap servers list.

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

compression

enum

Compression codec for Kafka messages. Allowed enum values: none,gzip,snappy,lz4,zstd

encoding [required]

enum

Encoding format for log events. Allowed enum values: json,raw_message

headers_key

string

The field name to use for Kafka message headers.

id [required]

string

The unique identifier for this component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

key_field

string

The field name to use as the Kafka message key.

librdkafka_options

[object]

Optional list of advanced Kafka producer configuration options, defined as key-value pairs.

name [required]

string

The name of the librdkafka configuration option to set.

value [required]

string

The value assigned to the specified librdkafka configuration option.

message_timeout_ms

int64

Maximum time in milliseconds to wait for message delivery confirmation.

rate_limit_duration_secs

int64

Duration in seconds for the rate limit window.

rate_limit_num

int64

Maximum number of messages allowed per rate limit duration.

sasl

object

Specifies the SASL mechanism for authenticating with a Kafka cluster.

mechanism

enum

SASL mechanism used for Kafka authentication. Allowed enum values: PLAIN,SCRAM-SHA-256,SCRAM-SHA-512

password_key

string

Name of the environment variable or secret that holds the SASL password.

username_key

string

Name of the environment variable or secret that holds the SASL username.

socket_timeout_ms

int64

Socket timeout in milliseconds for network requests.

tls

object

Configuration for enabling TLS encryption between the pipeline component and external services.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

topic [required]

string

The Kafka topic name to publish logs to.

type [required]

enum

The destination type. The value should always be kafka. Allowed enum values: kafka

default: kafka

<type=microsoft_sentinel>

object

The microsoft_sentinel destination forwards logs to Microsoft Sentinel.

Supported pipeline types: logs

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

client_id [required]

string

Azure AD client ID used for authentication.

client_secret_key

string

Name of the environment variable or secret that holds the Azure AD client secret.

dce_uri_key

string

Name of the environment variable or secret that holds the Data Collection Endpoint (DCE) URI.

dcr_immutable_id [required]

string

The immutable ID of the Data Collection Rule (DCR).

id [required]

string

The unique identifier for this component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

table [required]

string

The name of the Log Analytics table where logs are sent.

tenant_id [required]

string

Azure AD tenant ID.

type [required]

enum

The destination type. The value should always be microsoft_sentinel. Allowed enum values: microsoft_sentinel

default: microsoft_sentinel

<type=new_relic>

object

The new_relic destination sends logs to the New Relic platform.

Supported pipeline types: logs

account_id_key

string

Name of the environment variable or secret that holds the New Relic account ID.

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

id [required]

string

The unique identifier for this component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

license_key_key

string

Name of the environment variable or secret that holds the New Relic license key.

region [required]

enum

The New Relic region. Allowed enum values: us,eu

type [required]

enum

The destination type. The value should always be new_relic. Allowed enum values: new_relic

default: new_relic

<type=opensearch>

object

The opensearch destination writes logs to an OpenSearch cluster.

Supported pipeline types: logs

auth

object

Authentication settings for the Elasticsearch destination. When strategy is basic, use username_key and password_key to reference credentials stored in environment variables or secrets.

password_key

string

Name of the environment variable or secret that holds the Elasticsearch password (used when strategy is basic).

strategy [required]

enum

The authentication strategy to use. Allowed enum values: basic,aws

username_key

string

Name of the environment variable or secret that holds the Elasticsearch username (used when strategy is basic).

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

bulk_index

string

The index to write logs to.

data_stream

object

Configuration options for writing to OpenSearch Data Streams instead of a fixed index.

dataset

string

The data stream dataset for your logs. This groups logs by their source or application.

dtype

string

The data stream type for your logs. This determines how logs are categorized within the data stream.

namespace

string

The data stream namespace for your logs. This separates logs into different environments or domains.

endpoint_url_key

string

Name of the environment variable or secret that holds the OpenSearch endpoint URL.

id [required]

string

The unique identifier for this component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

type [required]

enum

The destination type. The value should always be opensearch. Allowed enum values: opensearch

default: opensearch

<type=rsyslog>

object

The rsyslog destination forwards logs to an external rsyslog server over TCP or UDP using the syslog protocol.

Supported pipeline types: logs

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

endpoint_url_key

string

Name of the environment variable or secret that holds the syslog server endpoint URL.

id [required]

string

The unique identifier for this component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

keepalive

int64

Optional socket keepalive duration in milliseconds.

tls

object

Configuration for enabling TLS encryption between the pipeline component and external services.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

type [required]

enum

The destination type. The value should always be rsyslog. Allowed enum values: rsyslog

default: rsyslog

<type=sentinel_one>

object

The sentinel_one destination sends logs to SentinelOne.

Supported pipeline types: logs

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

id [required]

string

The unique identifier for this component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

region [required]

enum

The SentinelOne region to send logs to. Allowed enum values: us,eu,ca,data_set_us

token_key

string

Name of the environment variable or secret that holds the SentinelOne API token.

type [required]

enum

The destination type. The value should always be sentinel_one. Allowed enum values: sentinel_one

default: sentinel_one

<type=socket>

object

The socket destination sends logs over TCP or UDP to a remote server.

Supported pipeline types: logs

address_key

string

Name of the environment variable or secret that holds the socket address (host:port).

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

encoding [required]

enum

Encoding format for log events. Allowed enum values: json,raw_message

framing [required]

 <oneOf>

Framing method configuration.

<method=newline_delimited>

object

Each log event is delimited by a newline character.

method [required]

enum

The definition of ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod object. Allowed enum values: newline_delimited

<method=bytes>

object

Event data is not delimited at all.

method [required]

enum

The definition of ObservabilityPipelineSocketDestinationFramingBytesMethod object. Allowed enum values: bytes

<method=character_delimited>

object

Each log event is separated using the specified delimiter character.

delimiter [required]

string

A single ASCII character used as a delimiter.

method [required]

enum

The definition of ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod object. Allowed enum values: character_delimited

id [required]

string

The unique identifier for this component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

mode [required]

enum

Protocol used to send logs. Allowed enum values: tcp,udp

tls

object

TLS configuration. Relevant only when mode is tcp.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

server_name

string

Server name to use for Server Name Indication (SNI) and to verify against the certificate presented by the remote host. Use this when the address you connect to doesn't match the certificate's Common Name or Subject Alternative Name.

type [required]

enum

The destination type. The value should always be socket. Allowed enum values: socket

default: socket

<type=splunk_hec>

object

The splunk_hec destination forwards logs to Splunk using the HTTP Event Collector (HEC).

Supported pipeline types: logs

auto_extract_timestamp

boolean

If true, Splunk tries to extract timestamps from incoming log events. If false, Splunk assigns the time the event was received. Only applies when endpoint_target is event; cannot be true when endpoint_target is raw.

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

encoding

enum

Encoding format for log events. Allowed enum values: json,raw_message

endpoint_target

enum

The Splunk HEC endpoint to send events to. Use event to send structured events to the /event endpoint, or raw to send the raw message to the /raw endpoint. Allowed enum values: event,raw

endpoint_url_key

string

Name of the environment variable or secret that holds the Splunk HEC endpoint URL.

id [required]

string

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).

index

string

Optional name of the Splunk index where logs are written.

indexed_fields

[string]

List of log field names to send as indexed fields to Splunk HEC. Available only when encoding is json.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

sourcetype

string

The Splunk sourcetype to assign to log events.

token_key

string

Name of the environment variable or secret that holds the Splunk HEC token.

token_strategy

enum

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. Allowed enum values: custom,from_source

type [required]

enum

The destination type. Always splunk_hec. Allowed enum values: splunk_hec

default: splunk_hec

<type=sumo_logic>

object

The sumo_logic destination forwards logs to Sumo Logic.

Supported pipeline types: logs

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

encoding

enum

The output encoding format. Allowed enum values: json,raw_message,logfmt

endpoint_url_key

string

Name of the environment variable or secret that holds the Sumo Logic HTTP endpoint URL.

header_custom_fields

[object]

A list of custom headers to include in the request to Sumo Logic.

name [required]

string

The header field name.

value [required]

string

The header field value.

header_host_name

string

Optional override for the host name header.

header_source_category

string

Optional override for the source category header.

header_source_name

string

Optional override for the source name header.

id [required]

string

The unique identifier for this component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

type [required]

enum

The destination type. The value should always be sumo_logic. Allowed enum values: sumo_logic

default: sumo_logic

<type=syslog_ng>

object

The syslog_ng destination forwards logs to an external syslog-ng server over TCP or UDP using the syslog protocol.

Supported pipeline types: logs

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

endpoint_url_key

string

Name of the environment variable or secret that holds the syslog-ng server endpoint URL.

id [required]

string

The unique identifier for this component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

keepalive

int64

Optional socket keepalive duration in milliseconds.

tls

object

Configuration for enabling TLS encryption between the pipeline component and external services.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

server_name

string

Server name to use for Server Name Indication (SNI) and to verify against the certificate presented by the remote host. Use this when the address you connect to doesn't match the certificate's Common Name or Subject Alternative Name.

type [required]

enum

The destination type. The value should always be syslog_ng. Allowed enum values: syslog_ng

default: syslog_ng

<type=databricks_zerobus>

object

The databricks_zerobus destination sends logs to Databricks using the Zerobus ingestion API, streaming data directly into your Databricks Lakehouse.

Supported pipeline types: Logs, rehydration

auth [required]

object

OAuth credentials for authenticating with the Databricks Zerobus ingestion API.

client_id [required]

string

Your service principal application ID (UUID).

client_secret_key

string

Name of the environment variable or secret that holds the OAuth client secret used to authenticate with the Databricks ingestion endpoint.

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

id [required]

string

The unique identifier for this component.

ingestion_endpoint_key

string

Name of the environment variable or the secret identifier that references the Databricks Zerobus ingestion endpoint, which is used to stream data directly into your Databricks Lakehouse.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

table_name [required]

string

The fully qualified name of your target Databricks table. Make sure this table already exists in your Databricks workspace before deploying.

type [required]

enum

The destination type. The value must be databricks_zerobus. Allowed enum values: databricks_zerobus

default: databricks_zerobus

unity_catalog_endpoint_key

string

Name of the environment variable or the secret identifier that references your Databricks workspace URL, which is used to communicate with the Unity Catalog API.

<type=datadog_metrics>

object

The datadog_metrics destination forwards metrics to Datadog.

Supported pipeline types: metrics

id [required]

string

The unique identifier for this component.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

type [required]

enum

The destination type. The value should always be datadog_metrics. Allowed enum values: datadog_metrics

default: datadog_metrics

<type=opentelemetry>

object

The opentelemetry destination forwards metrics using the OpenTelemetry Protocol (OTLP) over HTTP.

Supported pipeline types: metrics

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

http_client_uri_key

string

Environment variable name containing the URI of the OTLP HTTP endpoint to send metrics to.

default: DESTINATION_OTEL_HTTP_CLIENT_URI

id [required]

string

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).

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

tls

object

Configuration for enabling TLS encryption between the pipeline component and external services.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

type [required]

enum

The destination type. Always opentelemetry. Allowed enum values: opentelemetry

default: opentelemetry

<type=prometheus_remote_write>

object

The prometheus_remote_write destination forwards metrics to an endpoint that supports the Prometheus Remote Write protocol.

Supported pipeline types: metrics

auth_strategy

enum

The authentication strategy to use for outgoing Prometheus Remote Write requests. Allowed enum values: none,basic,bearer

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

default_namespace

string

The default namespace to add as a prefix to metric names that do not already have one.

endpoint_url_key

string

Name of the environment variable or secret that holds the Prometheus Remote Write endpoint URL. Defaults to DESTINATION_PROMETHEUS_REMOTE_WRITE_ENDPOINT_URL (prefixed with DD_OP_ at runtime).

id [required]

string

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).

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

password_key

string

Name of the environment variable or secret that holds the password (used when auth_strategy is basic).

tenant_id

string

The tenant ID to include with outgoing requests. Used by multi-tenant Prometheus Remote Write receivers.

tls

object

Configuration for enabling TLS encryption between the pipeline component and external services.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

server_name

string

Server name to use for Server Name Indication (SNI) and to verify against the certificate presented by the remote host. Use this when the address you connect to doesn't match the certificate's Common Name or Subject Alternative Name.

token_key

string

Name of the environment variable or secret that holds the bearer token (used when auth_strategy is bearer).

type [required]

enum

The destination type. The value should always be prometheus_remote_write. Allowed enum values: prometheus_remote_write

default: prometheus_remote_write

username_key

string

Name of the environment variable or secret that holds the username (used when auth_strategy is basic).

<type=splunk_hec_metrics>

object

The splunk_hec_metrics destination forwards metrics to Splunk using the HTTP Event Collector (HEC).

Supported pipeline types: metrics

buffer

 <oneOf>

Configuration for buffer settings on destination components.

Object 1

object

Options for configuring a disk buffer.

max_size [required]

int64

Maximum size of the disk buffer.

type

enum

The type of the buffer that will be configured, a disk buffer. Allowed enum values: disk

default: disk

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 2

object

Options for configuring a memory buffer by byte size.

max_size [required]

int64

Maximum size of the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

Object 3

object

Options for configuring a memory buffer by queue length.

max_events [required]

int64

Maximum events for the memory buffer.

type

enum

The type of the buffer that will be configured, a memory buffer. Allowed enum values: memory

default: memory

when_full

enum

Behavior when the buffer is full (block and stop accepting new events, or drop new events) Allowed enum values: block,drop_newest

default: block

compression

enum

Compression algorithm applied when sending metrics to Splunk HEC. Allowed enum values: none,gzip

default: none

default_namespace

string

Optional default namespace for metrics sent to Splunk HEC.

endpoint_url_key

string

Name of the environment variable or secret that holds the Splunk HEC endpoint URL.

id [required]

string

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).

index

string

Optional name of the Splunk index where metrics are written.

inputs [required]

[string]

A list of component IDs whose output is used as the input for this component.

source

string

The Splunk source field value for metric events.

sourcetype

string

The Splunk sourcetype to assign to metric events.

tls

object

Configuration for enabling TLS encryption between the pipeline component and external services.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

token_key

string

Name of the environment variable or secret that holds the Splunk HEC token.

type [required]

enum

The destination type. Always splunk_hec_metrics. Allowed enum values: splunk_hec_metrics

default: splunk_hec_metrics

pipeline_type

enum

The type of data being ingested. Defaults to logs if not specified. Allowed enum values: logs,metrics

default: logs

processor_groups

[object]

A list of processor groups that transform or enrich log data.

display_name

string

The display name for a component.

enabled [required]

boolean

Whether this processor group is enabled.

id [required]

string

The unique identifier for the processor group.

include [required]

string

Conditional expression for when this processor group should execute.

inputs [required]

[string]

A list of IDs for components whose output is used as the input for this processor group.

processors [required]

[ <oneOf>]

Processors applied sequentially within this group. Events flow through each processor in order.

<type=filter>

object

The filter processor allows conditional processing of logs/metrics based on a Datadog search query. Logs/metrics that match the include query are passed through; others are discarded.

Supported pipeline types: logs, metrics

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which logs/metrics should pass through the filter. Logs/metrics that match this query continue to downstream components; others are dropped.

type [required]

enum

The processor type. The value should always be filter. Allowed enum values: filter

default: filter

<type=add_env_vars>

object

The add_env_vars processor adds environment variable values to log events.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

The unique identifier for this component. Used to reference this processor in the pipeline.

include [required]

string

A Datadog search query used to determine which logs this processor targets.

type [required]

enum

The processor type. The value should always be add_env_vars. Allowed enum values: add_env_vars

default: add_env_vars

variables [required]

[object]

A list of environment variable mappings to apply to log fields.

field [required]

string

The target field in the log event.

name [required]

string

The name of the environment variable to read.

<type=add_fields>

object

The add_fields processor adds static key-value fields to logs.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

fields [required]

[object]

A list of static fields (key-value pairs) that is added to each log event processed by this component.

name [required]

string

The field name.

value [required]

string

The field value.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which logs this processor targets.

type [required]

enum

The processor type. The value should always be add_fields. Allowed enum values: add_fields

default: add_fields

<type=add_hostname>

object

The add_hostname processor adds the hostname to log events.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which logs this processor targets.

type [required]

enum

The processor type. The value should always be add_hostname. Allowed enum values: add_hostname

default: add_hostname

<type=custom_processor>

object

The custom_processor processor transforms events using Vector Remap Language (VRL) scripts with advanced filtering capabilities.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

The unique identifier for this processor.

include [required]

string

A Datadog search query used to determine which logs this processor targets. This field should always be set to * for the custom_processor processor.

default: *

remaps [required]

[object]

Array of VRL remap rules.

drop_on_error [required]

boolean

Whether to drop events that caused errors during processing.

enabled

boolean

Whether this remap rule is enabled.

include [required]

string

A Datadog search query used to filter events for this specific remap rule.

name [required]

string

A descriptive name for this remap rule.

source [required]

string

The VRL script source code that defines the processing logic.

type [required]

enum

The processor type. The value should always be custom_processor. Allowed enum values: custom_processor

default: custom_processor

<type=datadog_tags>

object

The datadog_tags processor includes or excludes specific Datadog tags in your logs.

Supported pipeline types: logs

action [required]

enum

The action to take on tags with matching keys. Allowed enum values: include,exclude

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which logs this processor targets.

keys [required]

[string]

A list of tag keys.

mode [required]

enum

The processing mode. Allowed enum values: filter

type [required]

enum

The processor type. The value should always be datadog_tags. Allowed enum values: datadog_tags

default: datadog_tags

<type=dedupe>

object

The dedupe processor removes duplicate fields in log events.

Supported pipeline types: logs

cache

object

Configuration for the cache used to detect duplicates.

num_events [required]

int64

The number of events to cache for duplicate detection.

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

fields [required]

[string]

A list of log field paths to check for duplicates.

id [required]

string

The unique identifier for this processor.

include [required]

string

A Datadog search query used to determine which logs this processor targets.

mode [required]

enum

The deduplication mode to apply to the fields. Allowed enum values: match,ignore

type [required]

enum

The processor type. The value should always be dedupe. Allowed enum values: dedupe

default: dedupe

<type=enrichment_table>

object

The enrichment_table processor enriches logs using a static CSV file, GeoIP database, or reference table. Exactly one of file, geoip, or reference_table must be configured.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

file

object

Defines a static enrichment table loaded from a CSV file.

encoding [required]

object

File encoding format.

delimiter [required]

string

The encoding delimiter.

includes_headers [required]

boolean

The encoding includes_headers.

type [required]

enum

Specifies the encoding format (e.g., CSV) used for enrichment tables. Allowed enum values: csv

key [required]

[object]

Key fields used to look up enrichment values.

column [required]

string

The items column.

comparison [required]

enum

Defines how to compare key fields for enrichment table lookups. Allowed enum values: equals

field [required]

 <oneOf>

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.

Object 1

string

A plain field path in the log event, used as the lookup key.

Object 2

object

Looks up a value from a field path in the log event.

event [required]

string

The path to the field in the log event to use as the lookup key.

Object 3

object

Evaluates a VRL expression to produce the lookup key.

vrl [required]

string

A VRL expression that returns the value to use as the lookup key.

Object 4

object

Looks up a value stored as a pipeline secret.

secret [required]

string

The name of the secret containing the lookup key value.

path [required]

string

Path to the CSV file.

schema [required]

[object]

Schema defining column names and their types.

column [required]

string

The items column.

type [required]

enum

Declares allowed data types for enrichment table columns. Allowed enum values: string,boolean,integer,float,date,timestamp

geoip

object

Uses a GeoIP database to enrich logs based on an IP field.

key_field [required]

string

Path to the IP field in the log.

locale [required]

string

Locale used to resolve geographical names.

path [required]

string

Path to the GeoIP database file.

id [required]

string

The unique identifier for this processor.

include [required]

string

A Datadog search query used to determine which logs this processor targets.

reference_table

object

Uses a Datadog reference table to enrich logs.

app_key_key

string

Name of the environment variable or secret that holds the Datadog application key used to access the reference table.

columns

[string]

List of column names to include from the reference table. If not provided, all columns are included.

key_field [required]

string

Path to the field in the log event to match against the reference table.

table_id [required]

string

The unique identifier of the reference table.

target [required]

string

Path where enrichment results should be stored in the log.

type [required]

enum

The processor type. The value should always be enrichment_table. Allowed enum values: enrichment_table

default: enrichment_table

<type=generate_datadog_metrics>

object

DEPRECATED: The generate_datadog_metrics processor creates custom metrics from logs and sends them to Datadog. Metrics can be counters, gauges, or distributions and optionally grouped by log fields.

Supported pipeline types: logs

Deprecated: This processor is deprecated. Use the generate_metrics processor instead.

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

The unique identifier for this component. Used to reference this component in other parts of the pipeline.

include

string

A Datadog search query used to determine which logs this processor targets.

metrics

[object]

Configuration for generating individual metrics.

group_by

[string]

Optional fields used to group the metric series.

include [required]

string

Datadog filter query to match logs for metric generation.

metric_type [required]

enum

Type of metric to create. Allowed enum values: count,gauge,distribution

name [required]

string

Name of the custom metric to be created.

value [required]

 <oneOf>

Specifies how the value of the generated metric is computed.

<strategy=increment_by_one>

object

Strategy that increments a generated metric by one for each matching event.

strategy [required]

enum

Increments the metric by 1 for each matching event. Allowed enum values: increment_by_one

<strategy=increment_by_field>

object

Strategy that increments a generated metric based on the value of a log field.

field [required]

string

Name of the log field containing the numeric value to increment the metric by.

strategy [required]

enum

Uses a numeric field in the log event as the metric increment. Allowed enum values: increment_by_field

type [required]

enum

The processor type. Always generate_datadog_metrics. Allowed enum values: generate_datadog_metrics

default: generate_datadog_metrics

<type=generate_metrics>

object

The generate_metrics processor creates custom metrics from logs. Metrics can be counters, gauges, or distributions and optionally grouped by log fields.

There must be a destination whose inputs reference this processor with the <processor-id>.metrics suffix to route the generated metrics. All destination types normally supported for metrics pipelines are also supported as metrics destinations in logs pipelines.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

The unique identifier for this component. Used to reference this component in other parts of the pipeline.

include

string

A Datadog search query used to determine which logs this processor targets.

metrics

[object]

Configuration for generating individual metrics.

group_by

[string]

Optional fields used to group the metric series.

include [required]

string

Datadog filter query to match logs for metric generation.

metric_type [required]

enum

Type of metric to create. Allowed enum values: count,gauge,distribution

name [required]

string

Name of the custom metric to be created.

value [required]

 <oneOf>

Specifies how the value of the generated metric is computed.

<strategy=increment_by_one>

object

Strategy that increments a generated metric by one for each matching event.

strategy [required]

enum

Increments the metric by 1 for each matching event. Allowed enum values: increment_by_one

<strategy=increment_by_field>

object

Strategy that increments a generated metric based on the value of a log field.

field [required]

string

Name of the log field containing the numeric value to increment the metric by.

strategy [required]

enum

Uses a numeric field in the log event as the metric increment. Allowed enum values: increment_by_field

type [required]

enum

The processor type. Always generate_metrics. Allowed enum values: generate_metrics

default: generate_metrics

<type=ocsf_mapper>

object

The ocsf_mapper processor transforms logs into the OCSF schema using a predefined mapping configuration.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

The unique identifier for this component. Used to reference this component in other parts of the pipeline.

include [required]

string

A Datadog search query used to determine which logs this processor targets.

keep_unmatched

boolean

Whether to keep an event that does not match any of the mapping filters.

mappings [required]

[object]

A list of mapping rules to convert events to the OCSF format.

include [required]

string

A Datadog search query used to select the logs that this mapping should apply to.

mapping [required]

 <oneOf>

Defines a single mapping rule for transforming logs into the OCSF schema.

Object 1

enum

Predefined library mappings for common log formats. Allowed enum values: CloudTrail Account Change,GCP Cloud Audit CreateBucket,GCP Cloud Audit CreateSink,GCP Cloud Audit SetIamPolicy,GCP Cloud Audit UpdateSink,Github Audit Log API Activity,Google Workspace Admin Audit addPrivilege,Microsoft 365 Defender Incident,Microsoft 365 Defender UserLoggedIn,Okta System Log Authentication

Show 1 more,Palo Alto Networks Firewall Traffic

Object 2

object

Custom OCSF mapping configuration for transforming logs.

mapping [required]

[object]

A list of field mapping rules for transforming log fields to OCSF schema fields.

default

The default value to use if the source field is missing or empty.

dest [required]

string

The destination OCSF field path.

lookup

object

Lookup table configuration for mapping source values to destination values.

source

The source field path from the log event.

sources

Multiple source field paths for combined mapping.

value

A static value to use for the destination field.

metadata [required]

object

Metadata for the custom OCSF mapping.

class [required]

string

The OCSF event class name.

profiles

[string]

A list of OCSF profiles to apply.

version [required]

string

The OCSF schema version.

version [required]

int64

The version of the custom mapping configuration.

type [required]

enum

The processor type. The value should always be ocsf_mapper. Allowed enum values: ocsf_mapper

default: ocsf_mapper

<type=parse_grok>

object

The parse_grok processor extracts structured fields from unstructured log messages using Grok patterns.

Supported pipeline types: logs

disable_library_rules

boolean

If set to true, disables the default Grok rules provided by Datadog.

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

field

string

The log field to parse with the Grok rules.

default: message

id [required]

string

A unique identifier for this processor.

include [required]

string

A Datadog search query used to determine which logs this processor targets.

rules [required]

[ <oneOf>]

The list of Grok parsing rules selected by either source field or include query.

Object 1

object

A Grok parsing rule used in the parse_grok processor. Each rule defines how to extract structured fields from a specific log field using Grok patterns.

match_rules [required]

[object]

A list of Grok parsing rules that define how to extract fields from the source field. Each rule must contain a name and a valid Grok pattern.

name [required]

string

The name of the rule.

rule [required]

string

The definition of the Grok rule.

source [required]

string

The value of the source field in log events to be processed by the Grok rules.

support_rules

[object]

A list of Grok helper rules that can be referenced by the parsing rules.

name [required]

string

The name of the Grok helper rule.

rule [required]

string

The definition of the Grok helper rule.

Object 2

object

A Grok parsing rule selected using the include query. Each rule defines how to extract structured fields from logs matching a Datadog search query.

include [required]

string

A Datadog search query used to determine which logs this Grok rule targets.

match_rules [required]

[object]

A list of Grok parsing rules that define how to extract fields from matching logs. Each rule must contain a name and a valid Grok pattern.

name [required]

string

The name of the rule.

rule [required]

string

The definition of the Grok rule.

support_rules

[object]

A list of Grok helper rules that can be referenced by the parsing rules.

name [required]

string

The name of the Grok helper rule.

rule [required]

string

The definition of the Grok helper rule.

type [required]

enum

The processor type. The value should always be parse_grok. Allowed enum values: parse_grok

default: parse_grok

<type=parse_json>

object

The parse_json processor extracts JSON from a specified field and flattens it into the event. This is useful when logs contain embedded JSON as a string.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

field [required]

string

The name of the log field that contains a JSON string.

id [required]

string

A unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).

include [required]

string

A Datadog search query used to determine which logs this processor targets.

type [required]

enum

The processor type. The value should always be parse_json. Allowed enum values: parse_json

default: parse_json

<type=parse_xml>

object

The parse_xml processor parses XML from a specified field and extracts it into the event.

Supported pipeline types: logs

always_use_text_key

boolean

Whether to always use a text key for element content.

attr_prefix

string

The prefix to use for XML attributes in the parsed output.

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

field [required]

string

The name of the log field that contains an XML string.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which logs this processor targets.

include_attr

boolean

Whether to include XML attributes in the parsed output.

parse_bool

boolean

Whether to parse boolean values from strings.

parse_null

boolean

Whether to parse null values.

parse_number

boolean

Whether to parse numeric values from strings.

text_key

string

The key name to use for text content within XML elements. Must be at least 1 character if specified.

type [required]

enum

The processor type. The value should always be parse_xml. Allowed enum values: parse_xml

default: parse_xml

<type=quota>

object

The quota processor measures logging traffic for logs that match a specified filter. When the configured daily quota is met, the processor can drop or alert.

Supported pipeline types: logs

display_name

string

The display name for a component.

drop_events

boolean

If set to true, logs that match the quota filter and are sent after the quota is exceeded are dropped. Logs that do not match the filter continue through the pipeline. Note: You can set either drop_events or overflow_action, but not both.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

ignore_when_missing_partitions

boolean

If true, the processor skips quota checks when partition fields are missing from the logs.

include [required]

string

A Datadog search query used to determine which logs this processor targets.

limit [required]

object

The maximum amount of data or number of events allowed before the quota is enforced. Can be specified in bytes or events.

enforce [required]

enum

Unit for quota enforcement in bytes for data size or events for count. Allowed enum values: bytes,events

limit [required]

int64

The limit for quota enforcement.

name [required]

string

Name of the quota.

overflow_action

enum

The action to take when the quota or bucket limit is exceeded. Options:

  • drop: Drop the event.
  • no_action: Let the event pass through.
  • overflow_routing: Route to an overflow destination.

When overflow_routing is used, there must be a destination whose inputs reference this processor with the <processor-id>.overflow_events suffix to route the overflowing events. Only the following destination types support overflow inputs: amazon_s3_generic, amazon_s3, google_cloud_storage, and azure_storage. Allowed enum values: drop,no_action,overflow_routing

overrides

[object]

A list of alternate quota rules that apply to specific sets of events, identified by matching field values. Each override can define a custom limit.

fields [required]

[object]

A list of field matchers used to apply a specific override. If an event matches all listed key-value pairs, the corresponding override limit is enforced.

name [required]

string

The field name.

value [required]

string

The field value.

limit [required]

object

The maximum amount of data or number of events allowed before the quota is enforced. Can be specified in bytes or events.

enforce [required]

enum

Unit for quota enforcement in bytes for data size or events for count. Allowed enum values: bytes,events

limit [required]

int64

The limit for quota enforcement.

partition_fields

[string]

A list of fields used to segment log traffic for quota enforcement. Quotas are tracked independently by unique combinations of these field values.

too_many_buckets_action

enum

The action to take when the quota or bucket limit is exceeded. Options:

  • drop: Drop the event.
  • no_action: Let the event pass through.
  • overflow_routing: Route to an overflow destination.

When overflow_routing is used, there must be a destination whose inputs reference this processor with the <processor-id>.overflow_events suffix to route the overflowing events. Only the following destination types support overflow inputs: amazon_s3_generic, amazon_s3, google_cloud_storage, and azure_storage. Allowed enum values: drop,no_action,overflow_routing

type [required]

enum

The processor type. The value should always be quota. Allowed enum values: quota

default: quota

<type=reduce>

object

The reduce processor aggregates and merges logs based on matching keys and merge strategies.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

group_by [required]

[string]

A list of fields used to group log events for merging.

id [required]

string

The unique identifier for this processor.

include [required]

string

A Datadog search query used to determine which logs this processor targets.

merge_strategies [required]

[object]

List of merge strategies defining how values from grouped events should be combined.

path [required]

string

The field path in the log event.

strategy [required]

enum

The merge strategy to apply. Allowed enum values: discard,retain,sum,max,min,array,concat,concat_newline,concat_raw,shortest_array

Show 2 more,longest_array,flat_unique

type [required]

enum

The processor type. The value should always be reduce. Allowed enum values: reduce

default: reduce

<type=remove_fields>

object

The remove_fields processor deletes specified fields from logs.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

fields [required]

[string]

A list of field names to be removed from each log event.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which logs this processor targets.

type [required]

enum

The processor type. The value should always be remove_fields. Allowed enum values: remove_fields

default: remove_fields

<type=rename_fields>

object

The rename_fields processor changes field names.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

fields [required]

[object]

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.

destination [required]

string

The field name to assign the renamed value to.

preserve_source [required]

boolean

Indicates whether the original field, that is received from the source, should be kept (true) or removed (false) after renaming.

source [required]

string

The original field name in the log event that should be renamed.

id [required]

string

A unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).

include [required]

string

A Datadog search query used to determine which logs this processor targets.

type [required]

enum

The processor type. The value should always be rename_fields. Allowed enum values: rename_fields

default: rename_fields

<type=sample>

object

The sample processor allows probabilistic sampling of logs at a fixed rate.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

group_by

[string]

Optional list of fields to group events by. Each group is sampled independently.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which logs this processor targets.

percentage [required]

double

The percentage of logs to sample.

type [required]

enum

The processor type. The value should always be sample. Allowed enum values: sample

default: sample

<type=sensitive_data_scanner>

object

The sensitive_data_scanner processor detects and optionally redacts sensitive data in log events.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which logs this processor targets.

rules [required]

[object]

A list of rules for identifying and acting on sensitive data patterns.

keyword_options

object

Configuration for keywords used to reinforce sensitive data pattern detection.

keywords [required]

[string]

A list of keywords to match near the sensitive pattern.

proximity [required]

int64

Maximum number of tokens between a keyword and a sensitive value match.

name [required]

string

A name identifying the rule.

on_match [required]

 <oneOf>

Defines what action to take when sensitive data is matched.

<action=redact>

object

Configuration for completely redacting matched sensitive data.

action [required]

enum

Action type that completely replaces the matched sensitive data with a fixed replacement string to remove all visibility. Allowed enum values: redact

options [required]

object

Configuration for fully redacting sensitive data.

replace [required]

string

The string used to replace matched sensitive data (for example, "***" or "[REDACTED]").

<action=hash>

object

Configuration for hashing matched sensitive values.

action [required]

enum

Action type that replaces the matched sensitive data with a hashed representation, preserving structure while securing content. Allowed enum values: hash

options

object

Optional settings for the hash action. When omitted or empty, matched sensitive data is replaced with a deterministic hashed value that preserves structure for analytics while protecting the original content. Reserved for future hash configuration (for example, algorithm or salt).

<action=partial_redact>

object

Configuration for partially redacting matched sensitive data.

action [required]

enum

Action type that redacts part of the sensitive data while preserving a configurable number of characters, typically used for masking purposes (e.g., show last 4 digits of a credit card). Allowed enum values: partial_redact

options [required]

object

Controls how partial redaction is applied, including character count and direction.

characters [required]

int64

Number of characters to leave visible from the start or end of the matched value; the rest are redacted.

direction [required]

enum

Indicates whether to redact characters from the first or last part of the matched value. Allowed enum values: first,last

pattern [required]

 <oneOf>

Pattern detection configuration for identifying sensitive data using either a custom regex or a library reference.

<type=custom>

object

Defines a custom regex-based pattern for identifying sensitive data in logs.

options [required]

object

Options for defining a custom regex pattern.

description

string

Human-readable description providing context about a sensitive data scanner rule

rule [required]

string

A regular expression used to detect sensitive values. Must be a valid regex.

type [required]

enum

Indicates a custom regular expression is used for matching. Allowed enum values: custom

<type=library>

object

Specifies a pattern from Datadog’s sensitive data detection library to match known sensitive data types.

options [required]

object

Options for selecting a predefined library pattern and enabling keyword support.

description

string

Human-readable description providing context about a sensitive data scanner rule

id [required]

string

Identifier for a predefined pattern from the sensitive data scanner pattern library.

use_recommended_keywords

boolean

Whether to augment the pattern with recommended keywords (optional).

type [required]

enum

Indicates that a predefined library pattern is used. Allowed enum values: library

scope [required]

 <oneOf>

Determines which parts of the log the pattern-matching rule should be applied to.

<target=include>

object

Includes only specific fields for sensitive data scanning.

options [required]

object

Fields to which the scope rule applies.

fields [required]

[string]

List of log attribute names (field paths) to which the scope applies. Only these fields are included in or excluded from pattern matching.

target [required]

enum

Applies the rule only to included fields. Allowed enum values: include

<target=exclude>

object

Excludes specific fields from sensitive data scanning.

options [required]

object

Fields to which the scope rule applies.

fields [required]

[string]

List of log attribute names (field paths) to which the scope applies. Only these fields are included in or excluded from pattern matching.

target [required]

enum

Excludes specific fields from processing. Allowed enum values: exclude

<target=all>

object

Applies scanning across all available fields.

target [required]

enum

Applies the rule to all fields. Allowed enum values: all

tags

[string]

Tags assigned to this rule for filtering and classification.

type [required]

enum

The processor type. The value should always be sensitive_data_scanner. Allowed enum values: sensitive_data_scanner

default: sensitive_data_scanner

<type=split_array>

object

The split_array processor splits array fields into separate events based on configured rules.

Supported pipeline types: logs

arrays [required]

[object]

A list of array split configurations.

field [required]

string

The path to the array field to split.

include [required]

string

A Datadog search query used to determine which logs this array split operation targets.

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which logs this processor targets. For split_array, this should typically be *.

type [required]

enum

The processor type. The value should always be split_array. Allowed enum values: split_array

default: split_array

<type=throttle>

object

The throttle processor limits the number of events that pass through over a given time window.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

group_by

[string]

Optional list of fields used to group events before the threshold has been reached.

id [required]

string

The unique identifier for this processor.

include [required]

string

A Datadog search query used to determine which logs this processor targets.

threshold [required]

int64

the number of events allowed in a given time window. Events sent after the threshold has been reached, are dropped.

type [required]

enum

The processor type. The value should always be throttle. Allowed enum values: throttle

default: throttle

window [required]

double

The time window in seconds over which the threshold applies.

<type=add_metric_tags>

object

The add_metric_tags processor adds static tags to metrics.

Supported pipeline types: metrics

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which metrics this processor targets.

tags [required]

[object]

A list of static tags (key-value pairs) added to each metric processed by this component.

name [required]

string

The field name.

value [required]

string

The field value.

type [required]

enum

The processor type. The value must be add_metric_tags. Allowed enum values: add_metric_tags

default: add_metric_tags

<type=aggregate>

object

The aggregate processor combines metrics that share the same name and tags into a single metric over a configurable interval.

Supported pipeline types: metrics

aggregation_timing

object

Configures how metrics are assigned to aggregation windows. When omitted, metrics are grouped using system time.

allowed_lateness_secs

int64

Grace period, in seconds, for late-arriving metrics when using event time. Defaults to 10 seconds when omitted.

type [required]

enum

Determines whether metrics are assigned to aggregation windows based on when they are processed or their timestamps. Allowed enum values: system_time,event_time

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which metrics this processor targets.

interval_secs [required]

int64

The interval, in seconds, over which metrics are aggregated.

mode [required]

enum

The aggregation mode applied to metrics that share the same name and tags within the interval. Allowed enum values: auto,sum,latest,count,max,min,mean

type [required]

enum

The processor type. The value must be aggregate. Allowed enum values: aggregate

default: aggregate

Object 25

 <oneOf>

The enrichment_table processor enriches metrics with tags from a static CSV file or a Datadog reference table. It looks up a row using the metric name or a metric tag value. It then adds each column of the matching row as a metric tag, overwriting any existing tag with the same key. Exactly one of file or reference_table must be configured.

Supported pipeline types: metrics

Object 1

object

An enrichment_table processor that enriches metrics using a static CSV file.

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

file [required]

object

Defines a static enrichment table loaded from a CSV file for metric enrichment.

encoding [required]

object

File encoding format.

delimiter [required]

string

The encoding delimiter.

includes_headers [required]

boolean

The encoding includes_headers.

type [required]

enum

Specifies the encoding format (e.g., CSV) used for enrichment tables. Allowed enum values: csv

key [required]

object

Defines how to map a metric lookup value to a CSV column during enrichment table lookups.

column [required]

string

The CSV column name or index to match against the lookup value.

source [required]

 <oneOf>

Specifies the source of the key value used for metric enrichment table lookups. The lookup key can be either the metric name or a metric tag.

<type=metric_name>

object

Uses the metric name as the lookup key for enrichment table matching.

<type=tag>

object

Uses a metric tag as the lookup key for enrichment table matching.

path [required]

string

Path to the CSV file.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which metrics this processor targets.

type [required]

enum

The processor type. The value should always be enrichment_table. Allowed enum values: enrichment_table

default: enrichment_table

Object 2

object

An enrichment_table processor that enriches metrics using a Datadog reference table.

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which metrics this processor targets.

reference_table [required]

object

Uses a Datadog reference table to enrich metrics.

app_key_key

string

The name of the environment variable or secret that holds the Datadog application key used to access the reference table.

columns

[string]

A list of column names to include from the reference table. If not provided, all columns are included.

key [required]

object

Defines the metric lookup value used as the reference-table row ID.

source [required]

 <oneOf>

Specifies the source of the key value used for metric enrichment table lookups. The lookup key can be either the metric name or a metric tag.

<type=metric_name>

object

Uses the metric name as the lookup key for enrichment table matching.

<type=tag>

object

Uses a metric tag as the lookup key for enrichment table matching.

table_id [required]

string

The unique identifier of the reference table.

type [required]

enum

The processor type. The value should always be enrichment_table. Allowed enum values: enrichment_table

default: enrichment_table

<type=metric_tags>

object

The metric_tags processor filters metrics based on their tags using Datadog tag key patterns.

Supported pipeline types: metrics

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query that determines which metrics the processor targets.

rules [required]

[object]

A list of rules for filtering metric tags.

action [required]

enum

The action to take on tags with matching keys. Allowed enum values: include,exclude

include [required]

string

A Datadog search query used to determine which metrics this rule targets.

keys [required]

[string]

A list of tag keys to include or exclude.

mode [required]

enum

The processing mode for tag filtering. Allowed enum values: filter

type [required]

enum

The processor type. The value should always be metric_tags. Allowed enum values: metric_tags

default: metric_tags

<type=rename_metric_tags>

object

The rename_metric_tags processor changes the keys of tags on metrics.

Supported pipeline types: metrics

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which metrics this processor targets.

tags [required]

[object]

A list of rename rules specifying which tag keys to rename on each metric.

rename_to [required]

string

The new tag key to assign in place of the original.

tag [required]

string

The original tag key on the metric event.

type [required]

enum

The processor type. The value must be rename_metric_tags. Allowed enum values: rename_metric_tags

default: rename_metric_tags

<type=tag_cardinality_limit>

object

The tag_cardinality_limit processor caps the number of distinct tag value combinations on metrics, dropping tags or events once the limit is exceeded.

Supported pipeline types: metrics

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which metrics this processor targets.

limit_exceeded_action [required]

enum

The action to take when the cardinality limit is exceeded. Allowed enum values: drop_tag,drop_event

per_metric_limits

[object]

A list of per-metric cardinality overrides that take precedence over the default value_limit.

limit_exceeded_action

enum

The action to take when the cardinality limit is exceeded. Allowed enum values: drop_tag,drop_event

metric_name [required]

string

The name of the metric this override applies to.

override_type [required]

enum

How the override is applied. limit_override enforces a custom limit; excluded omits the metric or tag from cardinality tracking. Allowed enum values: limit_override,excluded

per_tag_limits

[object]

A list of per-tag cardinality overrides that apply within this metric. Must be omitted when override_type is excluded.

override_type [required]

enum

How the override is applied. limit_override enforces a custom limit; excluded omits the metric or tag from cardinality tracking. Allowed enum values: limit_override,excluded

tag_key [required]

string

The tag key this override applies to.

value_limit

int64

The maximum number of distinct values allowed for this tag. Required when override_type is limit_override. Must be omitted when override_type is excluded.

value_limit

int64

The maximum number of distinct tag value combinations allowed for this metric. Required when override_type is limit_override. Must be omitted when override_type is excluded.

tracking_mode [required]

object

Controls whether the processor uses exact or probabilistic tag tracking.

mode [required]

enum

The cardinality tracking algorithm to use. Allowed enum values: exact_fingerprint,probabilistic

type [required]

enum

The processor type. The value must be tag_cardinality_limit. Allowed enum values: tag_cardinality_limit

default: tag_cardinality_limit

value_limit [required]

int64

The default maximum number of distinct tag value combinations allowed per metric.

processors

[object]

DEPRECATED: A list of processor groups that transform or enrich log data.

Deprecated: This field is deprecated, you should now use the processor_groups field.

display_name

string

The display name for a component.

enabled [required]

boolean

Whether this processor group is enabled.

id [required]

string

The unique identifier for the processor group.

include [required]

string

Conditional expression for when this processor group should execute.

inputs [required]

[string]

A list of IDs for components whose output is used as the input for this processor group.

processors [required]

[ <oneOf>]

Processors applied sequentially within this group. Events flow through each processor in order.

<type=filter>

object

The filter processor allows conditional processing of logs/metrics based on a Datadog search query. Logs/metrics that match the include query are passed through; others are discarded.

Supported pipeline types: logs, metrics

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which logs/metrics should pass through the filter. Logs/metrics that match this query continue to downstream components; others are dropped.

type [required]

enum

The processor type. The value should always be filter. Allowed enum values: filter

default: filter

<type=add_env_vars>

object

The add_env_vars processor adds environment variable values to log events.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

The unique identifier for this component. Used to reference this processor in the pipeline.

include [required]

string

A Datadog search query used to determine which logs this processor targets.

type [required]

enum

The processor type. The value should always be add_env_vars. Allowed enum values: add_env_vars

default: add_env_vars

variables [required]

[object]

A list of environment variable mappings to apply to log fields.

field [required]

string

The target field in the log event.

name [required]

string

The name of the environment variable to read.

<type=add_fields>

object

The add_fields processor adds static key-value fields to logs.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

fields [required]

[object]

A list of static fields (key-value pairs) that is added to each log event processed by this component.

name [required]

string

The field name.

value [required]

string

The field value.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which logs this processor targets.

type [required]

enum

The processor type. The value should always be add_fields. Allowed enum values: add_fields

default: add_fields

<type=add_hostname>

object

The add_hostname processor adds the hostname to log events.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which logs this processor targets.

type [required]

enum

The processor type. The value should always be add_hostname. Allowed enum values: add_hostname

default: add_hostname

<type=custom_processor>

object

The custom_processor processor transforms events using Vector Remap Language (VRL) scripts with advanced filtering capabilities.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

The unique identifier for this processor.

include [required]

string

A Datadog search query used to determine which logs this processor targets. This field should always be set to * for the custom_processor processor.

default: *

remaps [required]

[object]

Array of VRL remap rules.

drop_on_error [required]

boolean

Whether to drop events that caused errors during processing.

enabled

boolean

Whether this remap rule is enabled.

include [required]

string

A Datadog search query used to filter events for this specific remap rule.

name [required]

string

A descriptive name for this remap rule.

source [required]

string

The VRL script source code that defines the processing logic.

type [required]

enum

The processor type. The value should always be custom_processor. Allowed enum values: custom_processor

default: custom_processor

<type=datadog_tags>

object

The datadog_tags processor includes or excludes specific Datadog tags in your logs.

Supported pipeline types: logs

action [required]

enum

The action to take on tags with matching keys. Allowed enum values: include,exclude

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which logs this processor targets.

keys [required]

[string]

A list of tag keys.

mode [required]

enum

The processing mode. Allowed enum values: filter

type [required]

enum

The processor type. The value should always be datadog_tags. Allowed enum values: datadog_tags

default: datadog_tags

<type=dedupe>

object

The dedupe processor removes duplicate fields in log events.

Supported pipeline types: logs

cache

object

Configuration for the cache used to detect duplicates.

num_events [required]

int64

The number of events to cache for duplicate detection.

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

fields [required]

[string]

A list of log field paths to check for duplicates.

id [required]

string

The unique identifier for this processor.

include [required]

string

A Datadog search query used to determine which logs this processor targets.

mode [required]

enum

The deduplication mode to apply to the fields. Allowed enum values: match,ignore

type [required]

enum

The processor type. The value should always be dedupe. Allowed enum values: dedupe

default: dedupe

<type=enrichment_table>

object

The enrichment_table processor enriches logs using a static CSV file, GeoIP database, or reference table. Exactly one of file, geoip, or reference_table must be configured.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

file

object

Defines a static enrichment table loaded from a CSV file.

encoding [required]

object

File encoding format.

delimiter [required]

string

The encoding delimiter.

includes_headers [required]

boolean

The encoding includes_headers.

type [required]

enum

Specifies the encoding format (e.g., CSV) used for enrichment tables. Allowed enum values: csv

key [required]

[object]

Key fields used to look up enrichment values.

column [required]

string

The items column.

comparison [required]

enum

Defines how to compare key fields for enrichment table lookups. Allowed enum values: equals

field [required]

 <oneOf>

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.

Object 1

string

A plain field path in the log event, used as the lookup key.

Object 2

object

Looks up a value from a field path in the log event.

event [required]

string

The path to the field in the log event to use as the lookup key.

Object 3

object

Evaluates a VRL expression to produce the lookup key.

vrl [required]

string

A VRL expression that returns the value to use as the lookup key.

Object 4

object

Looks up a value stored as a pipeline secret.

secret [required]

string

The name of the secret containing the lookup key value.

path [required]

string

Path to the CSV file.

schema [required]

[object]

Schema defining column names and their types.

column [required]

string

The items column.

type [required]

enum

Declares allowed data types for enrichment table columns. Allowed enum values: string,boolean,integer,float,date,timestamp

geoip

object

Uses a GeoIP database to enrich logs based on an IP field.

key_field [required]

string

Path to the IP field in the log.

locale [required]

string

Locale used to resolve geographical names.

path [required]

string

Path to the GeoIP database file.

id [required]

string

The unique identifier for this processor.

include [required]

string

A Datadog search query used to determine which logs this processor targets.

reference_table

object

Uses a Datadog reference table to enrich logs.

app_key_key

string

Name of the environment variable or secret that holds the Datadog application key used to access the reference table.

columns

[string]

List of column names to include from the reference table. If not provided, all columns are included.

key_field [required]

string

Path to the field in the log event to match against the reference table.

table_id [required]

string

The unique identifier of the reference table.

target [required]

string

Path where enrichment results should be stored in the log.

type [required]

enum

The processor type. The value should always be enrichment_table. Allowed enum values: enrichment_table

default: enrichment_table

<type=generate_datadog_metrics>

object

DEPRECATED: The generate_datadog_metrics processor creates custom metrics from logs and sends them to Datadog. Metrics can be counters, gauges, or distributions and optionally grouped by log fields.

Supported pipeline types: logs

Deprecated: This processor is deprecated. Use the generate_metrics processor instead.

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

The unique identifier for this component. Used to reference this component in other parts of the pipeline.

include

string

A Datadog search query used to determine which logs this processor targets.

metrics

[object]

Configuration for generating individual metrics.

group_by

[string]

Optional fields used to group the metric series.

include [required]

string

Datadog filter query to match logs for metric generation.

metric_type [required]

enum

Type of metric to create. Allowed enum values: count,gauge,distribution

name [required]

string

Name of the custom metric to be created.

value [required]

 <oneOf>

Specifies how the value of the generated metric is computed.

<strategy=increment_by_one>

object

Strategy that increments a generated metric by one for each matching event.

strategy [required]

enum

Increments the metric by 1 for each matching event. Allowed enum values: increment_by_one

<strategy=increment_by_field>

object

Strategy that increments a generated metric based on the value of a log field.

field [required]

string

Name of the log field containing the numeric value to increment the metric by.

strategy [required]

enum

Uses a numeric field in the log event as the metric increment. Allowed enum values: increment_by_field

type [required]

enum

The processor type. Always generate_datadog_metrics. Allowed enum values: generate_datadog_metrics

default: generate_datadog_metrics

<type=generate_metrics>

object

The generate_metrics processor creates custom metrics from logs. Metrics can be counters, gauges, or distributions and optionally grouped by log fields.

There must be a destination whose inputs reference this processor with the <processor-id>.metrics suffix to route the generated metrics. All destination types normally supported for metrics pipelines are also supported as metrics destinations in logs pipelines.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

The unique identifier for this component. Used to reference this component in other parts of the pipeline.

include

string

A Datadog search query used to determine which logs this processor targets.

metrics

[object]

Configuration for generating individual metrics.

group_by

[string]

Optional fields used to group the metric series.

include [required]

string

Datadog filter query to match logs for metric generation.

metric_type [required]

enum

Type of metric to create. Allowed enum values: count,gauge,distribution

name [required]

string

Name of the custom metric to be created.

value [required]

 <oneOf>

Specifies how the value of the generated metric is computed.

<strategy=increment_by_one>

object

Strategy that increments a generated metric by one for each matching event.

strategy [required]

enum

Increments the metric by 1 for each matching event. Allowed enum values: increment_by_one

<strategy=increment_by_field>

object

Strategy that increments a generated metric based on the value of a log field.

field [required]

string

Name of the log field containing the numeric value to increment the metric by.

strategy [required]

enum

Uses a numeric field in the log event as the metric increment. Allowed enum values: increment_by_field

type [required]

enum

The processor type. Always generate_metrics. Allowed enum values: generate_metrics

default: generate_metrics

<type=ocsf_mapper>

object

The ocsf_mapper processor transforms logs into the OCSF schema using a predefined mapping configuration.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

The unique identifier for this component. Used to reference this component in other parts of the pipeline.

include [required]

string

A Datadog search query used to determine which logs this processor targets.

keep_unmatched

boolean

Whether to keep an event that does not match any of the mapping filters.

mappings [required]

[object]

A list of mapping rules to convert events to the OCSF format.

include [required]

string

A Datadog search query used to select the logs that this mapping should apply to.

mapping [required]

 <oneOf>

Defines a single mapping rule for transforming logs into the OCSF schema.

Object 1

enum

Predefined library mappings for common log formats. Allowed enum values: CloudTrail Account Change,GCP Cloud Audit CreateBucket,GCP Cloud Audit CreateSink,GCP Cloud Audit SetIamPolicy,GCP Cloud Audit UpdateSink,Github Audit Log API Activity,Google Workspace Admin Audit addPrivilege,Microsoft 365 Defender Incident,Microsoft 365 Defender UserLoggedIn,Okta System Log Authentication

Show 1 more,Palo Alto Networks Firewall Traffic

Object 2

object

Custom OCSF mapping configuration for transforming logs.

mapping [required]

[object]

A list of field mapping rules for transforming log fields to OCSF schema fields.

default

The default value to use if the source field is missing or empty.

dest [required]

string

The destination OCSF field path.

lookup

object

Lookup table configuration for mapping source values to destination values.

source

The source field path from the log event.

sources

Multiple source field paths for combined mapping.

value

A static value to use for the destination field.

metadata [required]

object

Metadata for the custom OCSF mapping.

class [required]

string

The OCSF event class name.

profiles

[string]

A list of OCSF profiles to apply.

version [required]

string

The OCSF schema version.

version [required]

int64

The version of the custom mapping configuration.

type [required]

enum

The processor type. The value should always be ocsf_mapper. Allowed enum values: ocsf_mapper

default: ocsf_mapper

<type=parse_grok>

object

The parse_grok processor extracts structured fields from unstructured log messages using Grok patterns.

Supported pipeline types: logs

disable_library_rules

boolean

If set to true, disables the default Grok rules provided by Datadog.

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

field

string

The log field to parse with the Grok rules.

default: message

id [required]

string

A unique identifier for this processor.

include [required]

string

A Datadog search query used to determine which logs this processor targets.

rules [required]

[ <oneOf>]

The list of Grok parsing rules selected by either source field or include query.

Object 1

object

A Grok parsing rule used in the parse_grok processor. Each rule defines how to extract structured fields from a specific log field using Grok patterns.

match_rules [required]

[object]

A list of Grok parsing rules that define how to extract fields from the source field. Each rule must contain a name and a valid Grok pattern.

name [required]

string

The name of the rule.

rule [required]

string

The definition of the Grok rule.

source [required]

string

The value of the source field in log events to be processed by the Grok rules.

support_rules

[object]

A list of Grok helper rules that can be referenced by the parsing rules.

name [required]

string

The name of the Grok helper rule.

rule [required]

string

The definition of the Grok helper rule.

Object 2

object

A Grok parsing rule selected using the include query. Each rule defines how to extract structured fields from logs matching a Datadog search query.

include [required]

string

A Datadog search query used to determine which logs this Grok rule targets.

match_rules [required]

[object]

A list of Grok parsing rules that define how to extract fields from matching logs. Each rule must contain a name and a valid Grok pattern.

name [required]

string

The name of the rule.

rule [required]

string

The definition of the Grok rule.

support_rules

[object]

A list of Grok helper rules that can be referenced by the parsing rules.

name [required]

string

The name of the Grok helper rule.

rule [required]

string

The definition of the Grok helper rule.

type [required]

enum

The processor type. The value should always be parse_grok. Allowed enum values: parse_grok

default: parse_grok

<type=parse_json>

object

The parse_json processor extracts JSON from a specified field and flattens it into the event. This is useful when logs contain embedded JSON as a string.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

field [required]

string

The name of the log field that contains a JSON string.

id [required]

string

A unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).

include [required]

string

A Datadog search query used to determine which logs this processor targets.

type [required]

enum

The processor type. The value should always be parse_json. Allowed enum values: parse_json

default: parse_json

<type=parse_xml>

object

The parse_xml processor parses XML from a specified field and extracts it into the event.

Supported pipeline types: logs

always_use_text_key

boolean

Whether to always use a text key for element content.

attr_prefix

string

The prefix to use for XML attributes in the parsed output.

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

field [required]

string

The name of the log field that contains an XML string.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which logs this processor targets.

include_attr

boolean

Whether to include XML attributes in the parsed output.

parse_bool

boolean

Whether to parse boolean values from strings.

parse_null

boolean

Whether to parse null values.

parse_number

boolean

Whether to parse numeric values from strings.

text_key

string

The key name to use for text content within XML elements. Must be at least 1 character if specified.

type [required]

enum

The processor type. The value should always be parse_xml. Allowed enum values: parse_xml

default: parse_xml

<type=quota>

object

The quota processor measures logging traffic for logs that match a specified filter. When the configured daily quota is met, the processor can drop or alert.

Supported pipeline types: logs

display_name

string

The display name for a component.

drop_events

boolean

If set to true, logs that match the quota filter and are sent after the quota is exceeded are dropped. Logs that do not match the filter continue through the pipeline. Note: You can set either drop_events or overflow_action, but not both.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

ignore_when_missing_partitions

boolean

If true, the processor skips quota checks when partition fields are missing from the logs.

include [required]

string

A Datadog search query used to determine which logs this processor targets.

limit [required]

object

The maximum amount of data or number of events allowed before the quota is enforced. Can be specified in bytes or events.

enforce [required]

enum

Unit for quota enforcement in bytes for data size or events for count. Allowed enum values: bytes,events

limit [required]

int64

The limit for quota enforcement.

name [required]

string

Name of the quota.

overflow_action

enum

The action to take when the quota or bucket limit is exceeded. Options:

  • drop: Drop the event.
  • no_action: Let the event pass through.
  • overflow_routing: Route to an overflow destination.

When overflow_routing is used, there must be a destination whose inputs reference this processor with the <processor-id>.overflow_events suffix to route the overflowing events. Only the following destination types support overflow inputs: amazon_s3_generic, amazon_s3, google_cloud_storage, and azure_storage. Allowed enum values: drop,no_action,overflow_routing

overrides

[object]

A list of alternate quota rules that apply to specific sets of events, identified by matching field values. Each override can define a custom limit.

fields [required]

[object]

A list of field matchers used to apply a specific override. If an event matches all listed key-value pairs, the corresponding override limit is enforced.

name [required]

string

The field name.

value [required]

string

The field value.

limit [required]

object

The maximum amount of data or number of events allowed before the quota is enforced. Can be specified in bytes or events.

enforce [required]

enum

Unit for quota enforcement in bytes for data size or events for count. Allowed enum values: bytes,events

limit [required]

int64

The limit for quota enforcement.

partition_fields

[string]

A list of fields used to segment log traffic for quota enforcement. Quotas are tracked independently by unique combinations of these field values.

too_many_buckets_action

enum

The action to take when the quota or bucket limit is exceeded. Options:

  • drop: Drop the event.
  • no_action: Let the event pass through.
  • overflow_routing: Route to an overflow destination.

When overflow_routing is used, there must be a destination whose inputs reference this processor with the <processor-id>.overflow_events suffix to route the overflowing events. Only the following destination types support overflow inputs: amazon_s3_generic, amazon_s3, google_cloud_storage, and azure_storage. Allowed enum values: drop,no_action,overflow_routing

type [required]

enum

The processor type. The value should always be quota. Allowed enum values: quota

default: quota

<type=reduce>

object

The reduce processor aggregates and merges logs based on matching keys and merge strategies.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

group_by [required]

[string]

A list of fields used to group log events for merging.

id [required]

string

The unique identifier for this processor.

include [required]

string

A Datadog search query used to determine which logs this processor targets.

merge_strategies [required]

[object]

List of merge strategies defining how values from grouped events should be combined.

path [required]

string

The field path in the log event.

strategy [required]

enum

The merge strategy to apply. Allowed enum values: discard,retain,sum,max,min,array,concat,concat_newline,concat_raw,shortest_array

Show 2 more,longest_array,flat_unique

type [required]

enum

The processor type. The value should always be reduce. Allowed enum values: reduce

default: reduce

<type=remove_fields>

object

The remove_fields processor deletes specified fields from logs.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

fields [required]

[string]

A list of field names to be removed from each log event.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which logs this processor targets.

type [required]

enum

The processor type. The value should always be remove_fields. Allowed enum values: remove_fields

default: remove_fields

<type=rename_fields>

object

The rename_fields processor changes field names.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

fields [required]

[object]

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.

destination [required]

string

The field name to assign the renamed value to.

preserve_source [required]

boolean

Indicates whether the original field, that is received from the source, should be kept (true) or removed (false) after renaming.

source [required]

string

The original field name in the log event that should be renamed.

id [required]

string

A unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).

include [required]

string

A Datadog search query used to determine which logs this processor targets.

type [required]

enum

The processor type. The value should always be rename_fields. Allowed enum values: rename_fields

default: rename_fields

<type=sample>

object

The sample processor allows probabilistic sampling of logs at a fixed rate.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

group_by

[string]

Optional list of fields to group events by. Each group is sampled independently.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which logs this processor targets.

percentage [required]

double

The percentage of logs to sample.

type [required]

enum

The processor type. The value should always be sample. Allowed enum values: sample

default: sample

<type=sensitive_data_scanner>

object

The sensitive_data_scanner processor detects and optionally redacts sensitive data in log events.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which logs this processor targets.

rules [required]

[object]

A list of rules for identifying and acting on sensitive data patterns.

keyword_options

object

Configuration for keywords used to reinforce sensitive data pattern detection.

keywords [required]

[string]

A list of keywords to match near the sensitive pattern.

proximity [required]

int64

Maximum number of tokens between a keyword and a sensitive value match.

name [required]

string

A name identifying the rule.

on_match [required]

 <oneOf>

Defines what action to take when sensitive data is matched.

<action=redact>

object

Configuration for completely redacting matched sensitive data.

action [required]

enum

Action type that completely replaces the matched sensitive data with a fixed replacement string to remove all visibility. Allowed enum values: redact

options [required]

object

Configuration for fully redacting sensitive data.

replace [required]

string

The string used to replace matched sensitive data (for example, "***" or "[REDACTED]").

<action=hash>

object

Configuration for hashing matched sensitive values.

action [required]

enum

Action type that replaces the matched sensitive data with a hashed representation, preserving structure while securing content. Allowed enum values: hash

options

object

Optional settings for the hash action. When omitted or empty, matched sensitive data is replaced with a deterministic hashed value that preserves structure for analytics while protecting the original content. Reserved for future hash configuration (for example, algorithm or salt).

<action=partial_redact>

object

Configuration for partially redacting matched sensitive data.

action [required]

enum

Action type that redacts part of the sensitive data while preserving a configurable number of characters, typically used for masking purposes (e.g., show last 4 digits of a credit card). Allowed enum values: partial_redact

options [required]

object

Controls how partial redaction is applied, including character count and direction.

characters [required]

int64

Number of characters to leave visible from the start or end of the matched value; the rest are redacted.

direction [required]

enum

Indicates whether to redact characters from the first or last part of the matched value. Allowed enum values: first,last

pattern [required]

 <oneOf>

Pattern detection configuration for identifying sensitive data using either a custom regex or a library reference.

<type=custom>

object

Defines a custom regex-based pattern for identifying sensitive data in logs.

options [required]

object

Options for defining a custom regex pattern.

description

string

Human-readable description providing context about a sensitive data scanner rule

rule [required]

string

A regular expression used to detect sensitive values. Must be a valid regex.

type [required]

enum

Indicates a custom regular expression is used for matching. Allowed enum values: custom

<type=library>

object

Specifies a pattern from Datadog’s sensitive data detection library to match known sensitive data types.

options [required]

object

Options for selecting a predefined library pattern and enabling keyword support.

description

string

Human-readable description providing context about a sensitive data scanner rule

id [required]

string

Identifier for a predefined pattern from the sensitive data scanner pattern library.

use_recommended_keywords

boolean

Whether to augment the pattern with recommended keywords (optional).

type [required]

enum

Indicates that a predefined library pattern is used. Allowed enum values: library

scope [required]

 <oneOf>

Determines which parts of the log the pattern-matching rule should be applied to.

<target=include>

object

Includes only specific fields for sensitive data scanning.

options [required]

object

Fields to which the scope rule applies.

fields [required]

[string]

List of log attribute names (field paths) to which the scope applies. Only these fields are included in or excluded from pattern matching.

target [required]

enum

Applies the rule only to included fields. Allowed enum values: include

<target=exclude>

object

Excludes specific fields from sensitive data scanning.

options [required]

object

Fields to which the scope rule applies.

fields [required]

[string]

List of log attribute names (field paths) to which the scope applies. Only these fields are included in or excluded from pattern matching.

target [required]

enum

Excludes specific fields from processing. Allowed enum values: exclude

<target=all>

object

Applies scanning across all available fields.

target [required]

enum

Applies the rule to all fields. Allowed enum values: all

tags

[string]

Tags assigned to this rule for filtering and classification.

type [required]

enum

The processor type. The value should always be sensitive_data_scanner. Allowed enum values: sensitive_data_scanner

default: sensitive_data_scanner

<type=split_array>

object

The split_array processor splits array fields into separate events based on configured rules.

Supported pipeline types: logs

arrays [required]

[object]

A list of array split configurations.

field [required]

string

The path to the array field to split.

include [required]

string

A Datadog search query used to determine which logs this array split operation targets.

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which logs this processor targets. For split_array, this should typically be *.

type [required]

enum

The processor type. The value should always be split_array. Allowed enum values: split_array

default: split_array

<type=throttle>

object

The throttle processor limits the number of events that pass through over a given time window.

Supported pipeline types: logs

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

group_by

[string]

Optional list of fields used to group events before the threshold has been reached.

id [required]

string

The unique identifier for this processor.

include [required]

string

A Datadog search query used to determine which logs this processor targets.

threshold [required]

int64

the number of events allowed in a given time window. Events sent after the threshold has been reached, are dropped.

type [required]

enum

The processor type. The value should always be throttle. Allowed enum values: throttle

default: throttle

window [required]

double

The time window in seconds over which the threshold applies.

<type=add_metric_tags>

object

The add_metric_tags processor adds static tags to metrics.

Supported pipeline types: metrics

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which metrics this processor targets.

tags [required]

[object]

A list of static tags (key-value pairs) added to each metric processed by this component.

name [required]

string

The field name.

value [required]

string

The field value.

type [required]

enum

The processor type. The value must be add_metric_tags. Allowed enum values: add_metric_tags

default: add_metric_tags

<type=aggregate>

object

The aggregate processor combines metrics that share the same name and tags into a single metric over a configurable interval.

Supported pipeline types: metrics

aggregation_timing

object

Configures how metrics are assigned to aggregation windows. When omitted, metrics are grouped using system time.

allowed_lateness_secs

int64

Grace period, in seconds, for late-arriving metrics when using event time. Defaults to 10 seconds when omitted.

type [required]

enum

Determines whether metrics are assigned to aggregation windows based on when they are processed or their timestamps. Allowed enum values: system_time,event_time

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which metrics this processor targets.

interval_secs [required]

int64

The interval, in seconds, over which metrics are aggregated.

mode [required]

enum

The aggregation mode applied to metrics that share the same name and tags within the interval. Allowed enum values: auto,sum,latest,count,max,min,mean

type [required]

enum

The processor type. The value must be aggregate. Allowed enum values: aggregate

default: aggregate

Object 25

 <oneOf>

The enrichment_table processor enriches metrics with tags from a static CSV file or a Datadog reference table. It looks up a row using the metric name or a metric tag value. It then adds each column of the matching row as a metric tag, overwriting any existing tag with the same key. Exactly one of file or reference_table must be configured.

Supported pipeline types: metrics

Object 1

object

An enrichment_table processor that enriches metrics using a static CSV file.

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

file [required]

object

Defines a static enrichment table loaded from a CSV file for metric enrichment.

encoding [required]

object

File encoding format.

delimiter [required]

string

The encoding delimiter.

includes_headers [required]

boolean

The encoding includes_headers.

type [required]

enum

Specifies the encoding format (e.g., CSV) used for enrichment tables. Allowed enum values: csv

key [required]

object

Defines how to map a metric lookup value to a CSV column during enrichment table lookups.

column [required]

string

The CSV column name or index to match against the lookup value.

source [required]

 <oneOf>

Specifies the source of the key value used for metric enrichment table lookups. The lookup key can be either the metric name or a metric tag.

<type=metric_name>

object

Uses the metric name as the lookup key for enrichment table matching.

<type=tag>

object

Uses a metric tag as the lookup key for enrichment table matching.

path [required]

string

Path to the CSV file.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which metrics this processor targets.

type [required]

enum

The processor type. The value should always be enrichment_table. Allowed enum values: enrichment_table

default: enrichment_table

Object 2

object

An enrichment_table processor that enriches metrics using a Datadog reference table.

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which metrics this processor targets.

reference_table [required]

object

Uses a Datadog reference table to enrich metrics.

app_key_key

string

The name of the environment variable or secret that holds the Datadog application key used to access the reference table.

columns

[string]

A list of column names to include from the reference table. If not provided, all columns are included.

key [required]

object

Defines the metric lookup value used as the reference-table row ID.

source [required]

 <oneOf>

Specifies the source of the key value used for metric enrichment table lookups. The lookup key can be either the metric name or a metric tag.

<type=metric_name>

object

Uses the metric name as the lookup key for enrichment table matching.

<type=tag>

object

Uses a metric tag as the lookup key for enrichment table matching.

table_id [required]

string

The unique identifier of the reference table.

type [required]

enum

The processor type. The value should always be enrichment_table. Allowed enum values: enrichment_table

default: enrichment_table

<type=metric_tags>

object

The metric_tags processor filters metrics based on their tags using Datadog tag key patterns.

Supported pipeline types: metrics

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query that determines which metrics the processor targets.

rules [required]

[object]

A list of rules for filtering metric tags.

action [required]

enum

The action to take on tags with matching keys. Allowed enum values: include,exclude

include [required]

string

A Datadog search query used to determine which metrics this rule targets.

keys [required]

[string]

A list of tag keys to include or exclude.

mode [required]

enum

The processing mode for tag filtering. Allowed enum values: filter

type [required]

enum

The processor type. The value should always be metric_tags. Allowed enum values: metric_tags

default: metric_tags

<type=rename_metric_tags>

object

The rename_metric_tags processor changes the keys of tags on metrics.

Supported pipeline types: metrics

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which metrics this processor targets.

tags [required]

[object]

A list of rename rules specifying which tag keys to rename on each metric.

rename_to [required]

string

The new tag key to assign in place of the original.

tag [required]

string

The original tag key on the metric event.

type [required]

enum

The processor type. The value must be rename_metric_tags. Allowed enum values: rename_metric_tags

default: rename_metric_tags

<type=tag_cardinality_limit>

object

The tag_cardinality_limit processor caps the number of distinct tag value combinations on metrics, dropping tags or events once the limit is exceeded.

Supported pipeline types: metrics

display_name

string

The display name for a component.

enabled [required]

boolean

Indicates whether the processor is enabled.

id [required]

string

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).

include [required]

string

A Datadog search query used to determine which metrics this processor targets.

limit_exceeded_action [required]

enum

The action to take when the cardinality limit is exceeded. Allowed enum values: drop_tag,drop_event

per_metric_limits

[object]

A list of per-metric cardinality overrides that take precedence over the default value_limit.

limit_exceeded_action

enum

The action to take when the cardinality limit is exceeded. Allowed enum values: drop_tag,drop_event

metric_name [required]

string

The name of the metric this override applies to.

override_type [required]

enum

How the override is applied. limit_override enforces a custom limit; excluded omits the metric or tag from cardinality tracking. Allowed enum values: limit_override,excluded

per_tag_limits

[object]

A list of per-tag cardinality overrides that apply within this metric. Must be omitted when override_type is excluded.

override_type [required]

enum

How the override is applied. limit_override enforces a custom limit; excluded omits the metric or tag from cardinality tracking. Allowed enum values: limit_override,excluded

tag_key [required]

string

The tag key this override applies to.

value_limit

int64

The maximum number of distinct values allowed for this tag. Required when override_type is limit_override. Must be omitted when override_type is excluded.

value_limit

int64

The maximum number of distinct tag value combinations allowed for this metric. Required when override_type is limit_override. Must be omitted when override_type is excluded.

tracking_mode [required]

object

Controls whether the processor uses exact or probabilistic tag tracking.

mode [required]

enum

The cardinality tracking algorithm to use. Allowed enum values: exact_fingerprint,probabilistic

type [required]

enum

The processor type. The value must be tag_cardinality_limit. Allowed enum values: tag_cardinality_limit

default: tag_cardinality_limit

value_limit [required]

int64

The default maximum number of distinct tag value combinations allowed per metric.

sources [required]

[ <oneOf>]

A list of configured data sources for the pipeline.

<type=datadog_agent>

object

The datadog_agent source collects logs/metrics from the Datadog Agent.

Supported pipeline types: logs, metrics

address_key

string

Name of the environment variable or secret that holds the listen address for the Datadog Agent source.

id [required]

string

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).

tls

object

Configuration for enabling TLS encryption between the pipeline component and external services.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

type [required]

enum

The source type. The value should always be datadog_agent. Allowed enum values: datadog_agent

default: datadog_agent

<type=amazon_data_firehose>

object

The amazon_data_firehose source ingests logs from AWS Data Firehose.

Supported pipeline types: logs

address_key

string

Name of the environment variable or secret that holds the Firehose delivery stream address.

auth

object

AWS authentication credentials used for accessing AWS services such as S3. If omitted, the system’s default credentials are used (for example, the IAM role and environment variables).

assume_role

string

The Amazon Resource Name (ARN) of the role to assume.

external_id

string

A unique identifier for cross-account role assumption.

session_name

string

A session identifier used for logging and tracing the assumed role session.

id [required]

string

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).

tls

object

Configuration for enabling TLS encryption between the pipeline component and external services.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

type [required]

enum

The source type. The value should always be amazon_data_firehose. Allowed enum values: amazon_data_firehose

default: amazon_data_firehose

<type=amazon_s3>

object

The amazon_s3 source ingests logs from an Amazon S3 bucket. It supports AWS authentication, TLS encryption, and configurable compression.

Supported pipeline types: logs

auth

object

AWS authentication credentials used for accessing AWS services such as S3. If omitted, the system’s default credentials are used (for example, the IAM role and environment variables).

assume_role

string

The Amazon Resource Name (ARN) of the role to assume.

external_id

string

A unique identifier for cross-account role assumption.

session_name

string

A session identifier used for logging and tracing the assumed role session.

compression

enum

Compression format for objects retrieved from the S3 bucket. Use auto to detect compression from the object's Content-Encoding header or file extension. Allowed enum values: auto,none,gzip,zstd

id [required]

string

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).

region [required]

string

AWS region where the S3 bucket resides.

tls

object

Configuration for enabling TLS encryption between the pipeline component and external services.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

type [required]

enum

The source type. Always amazon_s3. Allowed enum values: amazon_s3

default: amazon_s3

url_key

string

Name of the environment variable or secret that holds the S3 bucket URL.

<type=fluent_bit>

object

The fluent_bit source ingests logs from Fluent Bit.

Supported pipeline types: logs

address_key

string

Name of the environment variable or secret that holds the listen address for the Fluent Bit receiver.

id [required]

string

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).

tls

object

Configuration for enabling TLS encryption between the pipeline component and external connecting clients.

ca_file

string

Path to the Certificate Authority (CA) file used to validate connecting clients' TLS certificates.

crt_file [required]

string

Path to the TLS server certificate file used to used to identify the pipeline component to connecting clients.

key_file

string

Path to the private key file associated with the TLS server certificate.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

verify_certificate

boolean

When true, requires client connections to present a valid certificate, enabling mutual TLS authentication.

type [required]

enum

The source type. The value should always be fluent_bit. Allowed enum values: fluent_bit

default: fluent_bit

<type=fluentd>

object

The fluentd source ingests logs from a Fluentd-compatible service.

Supported pipeline types: logs

address_key

string

Name of the environment variable or secret that holds the listen address for the Fluent receiver.

id [required]

string

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).

tls

object

Configuration for enabling TLS encryption between the pipeline component and external connecting clients.

ca_file

string

Path to the Certificate Authority (CA) file used to validate connecting clients' TLS certificates.

crt_file [required]

string

Path to the TLS server certificate file used to used to identify the pipeline component to connecting clients.

key_file

string

Path to the private key file associated with the TLS server certificate.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

verify_certificate

boolean

When true, requires client connections to present a valid certificate, enabling mutual TLS authentication.

type [required]

enum

The source type. The value should always be `fluentd. Allowed enum values: fluentd

default: fluentd

<type=google_pubsub>

object

The google_pubsub source ingests logs from a Google Cloud Pub/Sub subscription.

Supported pipeline types: logs

auth

object

Google Cloud credentials used to authenticate with Google Cloud Storage.

credentials_file [required]

string

Path to the Google Cloud service account key file.

decoding [required]

enum

The decoding format used to interpret incoming logs. Allowed enum values: bytes,gelf,json,syslog

id [required]

string

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).

project [required]

string

The Google Cloud project ID that owns the Pub/Sub subscription.

subscription [required]

string

The Pub/Sub subscription name from which messages are consumed.

tls

object

Configuration for enabling TLS encryption between the pipeline component and external services.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

type [required]

enum

The source type. The value should always be google_pubsub. Allowed enum values: google_pubsub

default: google_pubsub

<type=http_client>

object

The http_client source scrapes logs from HTTP endpoints at regular intervals.

Supported pipeline types: logs

auth_strategy

enum

Optional authentication strategy for HTTP requests. Allowed enum values: none,basic,bearer,custom

custom_key

string

Name of the environment variable or secret that holds a custom header value (used with custom auth strategies).

decoding [required]

enum

The decoding format used to interpret incoming logs. Allowed enum values: bytes,gelf,json,syslog

endpoint_url_key

string

Name of the environment variable or secret that holds the HTTP endpoint URL to scrape.

id [required]

string

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).

password_key

string

Name of the environment variable or secret that holds the password (used when auth_strategy is basic).

scrape_interval_secs

int64

The interval (in seconds) between HTTP scrape requests.

scrape_timeout_secs

int64

The timeout (in seconds) for each scrape request.

tls

object

Configuration for enabling TLS encryption between the pipeline component and external services.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

server_name

string

Server name to use for Server Name Indication (SNI) and to verify against the certificate presented by the remote host. Use this when the address you connect to doesn't match the certificate's Common Name or Subject Alternative Name.

token_key

string

Name of the environment variable or secret that holds the bearer token (used when auth_strategy is bearer).

type [required]

enum

The source type. The value should always be http_client. Allowed enum values: http_client

default: http_client

username_key

string

Name of the environment variable or secret that holds the username (used when auth_strategy is basic).

<type=http_server>

object

The http_server source collects logs over HTTP POST from external services.

Supported pipeline types: logs

address_key

string

Name of the environment variable or secret that holds the listen address for the HTTP server.

auth_strategy [required]

enum

HTTP authentication method. Allowed enum values: none,plain

custom_key

string

Name of the environment variable or secret that holds a custom header value (used with custom auth strategies).

decoding [required]

enum

The decoding format used to interpret incoming logs. Allowed enum values: bytes,gelf,json,syslog

id [required]

string

Unique ID for the HTTP server source.

password_key

string

Name of the environment variable or secret that holds the password (used when auth_strategy is plain).

tls

object

Configuration for enabling TLS encryption between the pipeline component and external connecting clients.

ca_file

string

Path to the Certificate Authority (CA) file used to validate connecting clients' TLS certificates.

crt_file [required]

string

Path to the TLS server certificate file used to used to identify the pipeline component to connecting clients.

key_file

string

Path to the private key file associated with the TLS server certificate.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

verify_certificate

boolean

When true, requires client connections to present a valid certificate, enabling mutual TLS authentication.

type [required]

enum

The source type. The value should always be http_server. Allowed enum values: http_server

default: http_server

username_key

string

Name of the environment variable or secret that holds the username (used when auth_strategy is plain).

valid_tokens

[object]

A list of tokens that are accepted for authenticating incoming HTTP requests. When set, the source rejects any request whose token does not match an enabled entry in this list. Cannot be combined with the plain auth strategy.

enabled

boolean

Indicates whether this token is currently accepted. Disabled tokens are rejected without being removed from the configuration.

default: true

field_to_add

object

An optional metadata field that is attached to every event authenticated by the associated token. Both key and value must match ^[A-Za-z0-9_]+$.

key [required]

string

The metadata field name to add to incoming events.

value [required]

string

The metadata field value to add to incoming events.

path_to_token

 <oneOf>

Specifies where the worker extracts the token from in the incoming HTTP request. This can be either a built-in location (path or address) or an HTTP header object.

Object 1

enum

Built-in token location on the incoming HTTP request. Allowed enum values: path,address

Object 2

object

Extract the token from a specific HTTP request header.

header [required]

string

The name of the HTTP header that carries the token.

token_key [required]

string

Name of the environment variable or secret that holds the expected token value.

<type=kafka>

object

The kafka source ingests data from Apache Kafka topics.

Supported pipeline types: logs

bootstrap_servers_key

string

Name of the environment variable or secret that holds the Kafka bootstrap servers list.

group_id [required]

string

Consumer group ID used by the Kafka client.

id [required]

string

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).

librdkafka_options

[object]

Optional list of advanced Kafka client configuration options, defined as key-value pairs.

name [required]

string

The name of the librdkafka configuration option to set.

value [required]

string

The value assigned to the specified librdkafka configuration option.

sasl

object

Specifies the SASL mechanism for authenticating with a Kafka cluster.

mechanism

enum

SASL mechanism used for Kafka authentication. Allowed enum values: PLAIN,SCRAM-SHA-256,SCRAM-SHA-512

password_key

string

Name of the environment variable or secret that holds the SASL password.

username_key

string

Name of the environment variable or secret that holds the SASL username.

tls

object

Configuration for enabling TLS encryption between the pipeline component and external services.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the server’s TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to authenticate the pipeline component with upstream or downstream services.

key_file

string

Path to the private key file associated with the TLS client certificate. Used for mutual TLS authentication.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

topics [required]

[string]

A list of Kafka topic names to subscribe to. The source ingests messages from each topic specified.

type [required]

enum

The source type. The value should always be kafka. Allowed enum values: kafka

default: kafka

<type=logstash>

object

The logstash source ingests logs from a Logstash forwarder.

Supported pipeline types: logs

address_key

string

Name of the environment variable or secret that holds the listen address for the Logstash receiver.

id [required]

string

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).

tls

object

Configuration for enabling TLS encryption between the pipeline component and external connecting clients.

ca_file

string

Path to the Certificate Authority (CA) file used to validate connecting clients' TLS certificates.

crt_file [required]

string

Path to the TLS server certificate file used to used to identify the pipeline component to connecting clients.

key_file

string

Path to the private key file associated with the TLS server certificate.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

verify_certificate

boolean

When true, requires client connections to present a valid certificate, enabling mutual TLS authentication.

type [required]

enum

The source type. The value should always be logstash. Allowed enum values: logstash

default: logstash

<type=rsyslog>

object

The rsyslog source listens for logs over TCP or UDP from an rsyslog server using the syslog protocol.

Supported pipeline types: logs

address_key

string

Name of the environment variable or secret that holds the listen address for the syslog receiver.

id [required]

string

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).

mode [required]

enum

Protocol used by the syslog source to receive messages. Allowed enum values: tcp,udp

tls

object

Configuration for enabling TLS encryption between the pipeline component and external connecting clients.

ca_file

string

Path to the Certificate Authority (CA) file used to validate connecting clients' TLS certificates.

crt_file [required]

string

Path to the TLS server certificate file used to used to identify the pipeline component to connecting clients.

key_file

string

Path to the private key file associated with the TLS server certificate.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

verify_certificate

boolean

When true, requires client connections to present a valid certificate, enabling mutual TLS authentication.

type [required]

enum

The source type. The value should always be rsyslog. Allowed enum values: rsyslog

default: rsyslog

<type=socket>

object

The socket source ingests logs over TCP or UDP.

Supported pipeline types: logs

address_key

string

Name of the environment variable or secret that holds the listen address for the socket.

framing [required]

 <oneOf>

Framing method configuration for the socket source.

<method=newline_delimited>

object

Byte frames which are delimited by a newline character.

method [required]

enum

Byte frames which are delimited by a newline character. Allowed enum values: newline_delimited

<method=bytes>

object

Byte frames are passed through as-is according to the underlying I/O boundaries (for example, split between messages or stream segments).

method [required]

enum

Byte frames are passed through as-is according to the underlying I/O boundaries (for example, split between messages or stream segments). Allowed enum values: bytes

<method=character_delimited>

object

Byte frames which are delimited by a chosen character.

delimiter [required]

string

A single ASCII character used to delimit events.

method [required]

enum

Byte frames which are delimited by a chosen character. Allowed enum values: character_delimited

<method=octet_counting>

object

Byte frames according to the octet counting format as per RFC6587.

method [required]

enum

Byte frames according to the octet counting format as per RFC6587. Allowed enum values: octet_counting

<method=chunked_gelf>

object

Byte frames which are chunked GELF messages.

method [required]

enum

Byte frames which are chunked GELF messages. Allowed enum values: chunked_gelf

id [required]

string

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).

mode [required]

enum

Protocol used to receive logs. Allowed enum values: tcp,udp

tls

object

TLS configuration. Relevant only when mode is tcp.

ca_file

string

Path to the Certificate Authority (CA) file used to validate connecting clients' TLS certificates.

crt_file [required]

string

Path to the TLS server certificate file used to used to identify the pipeline component to connecting clients.

key_file

string

Path to the private key file associated with the TLS server certificate.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

verify_certificate

boolean

When true, requires client connections to present a valid certificate, enabling mutual TLS authentication.

type [required]

enum

The source type. The value should always be socket. Allowed enum values: socket

default: socket

<type=splunk_hec>

object

The splunk_hec source implements the Splunk HTTP Event Collector (HEC) API.

Supported pipeline types: logs

address_key

string

Name of the environment variable or secret that holds the listen address for the HEC API.

id [required]

string

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).

store_hec_token

boolean

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.

tls

object

Configuration for enabling TLS encryption between the pipeline component and external connecting clients.

ca_file

string

Path to the Certificate Authority (CA) file used to validate connecting clients' TLS certificates.

crt_file [required]

string

Path to the TLS server certificate file used to used to identify the pipeline component to connecting clients.

key_file

string

Path to the private key file associated with the TLS server certificate.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

verify_certificate

boolean

When true, requires client connections to present a valid certificate, enabling mutual TLS authentication.

type [required]

enum

The source type. Always splunk_hec. Allowed enum values: splunk_hec

default: splunk_hec

valid_tokens

[object]

A list of tokens that are accepted for authenticating incoming HEC requests. When set, the source rejects any request whose HEC token does not match an enabled entry in this list.

enabled

boolean

Indicates whether this token is currently accepted. Disabled tokens are rejected without being removed from the configuration.

default: true

field_to_add

object

An optional metadata field that is attached to every event authenticated by the associated token. Both key and value must match ^[A-Za-z0-9_]+$.

key [required]

string

The metadata field name to add to incoming events.

value [required]

string

The metadata field value to add to incoming events.

token_key [required]

string

Name of the environment variable or secret that holds the expected HEC token value.

<type=splunk_tcp>

object

The splunk_tcp source receives logs from a Splunk Universal Forwarder over TCP. TLS is supported for secure transmission.

Supported pipeline types: logs

address_key

string

Name of the environment variable or secret that holds the listen address for the Splunk TCP receiver.

id [required]

string

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).

max_connection_duration_secs

int64

Maximum duration, in seconds, that a connection can remain open before it is closed. When unset, connections can remain open indefinitely.

tls

object

Configuration for enabling TLS encryption between the pipeline component and external connecting clients.

ca_file

string

Path to the Certificate Authority (CA) file used to validate connecting clients' TLS certificates.

crt_file [required]

string

Path to the TLS server certificate file used to used to identify the pipeline component to connecting clients.

key_file

string

Path to the private key file associated with the TLS server certificate.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

verify_certificate

boolean

When true, requires client connections to present a valid certificate, enabling mutual TLS authentication.

type [required]

enum

The source type. Always splunk_tcp. Allowed enum values: splunk_tcp

default: splunk_tcp

<type=sumo_logic>

object

The sumo_logic source receives logs from Sumo Logic collectors.

Supported pipeline types: logs

address_key

string

Name of the environment variable or secret that holds the listen address for the Sumo Logic receiver.

id [required]

string

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).

type [required]

enum

The source type. The value should always be sumo_logic. Allowed enum values: sumo_logic

default: sumo_logic

<type=syslog_ng>

object

The syslog_ng source listens for logs over TCP or UDP from a syslog-ng server using the syslog protocol.

Supported pipeline types: logs

address_key

string

Name of the environment variable or secret that holds the listen address for the syslog-ng receiver.

id [required]

string

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).

mode [required]

enum

Protocol used by the syslog source to receive messages. Allowed enum values: tcp,udp

tls

object

Configuration for enabling TLS encryption between the pipeline component and external connecting clients.

ca_file

string

Path to the Certificate Authority (CA) file used to validate connecting clients' TLS certificates.

crt_file [required]

string

Path to the TLS server certificate file used to used to identify the pipeline component to connecting clients.

key_file

string

Path to the private key file associated with the TLS server certificate.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

verify_certificate

boolean

When true, requires client connections to present a valid certificate, enabling mutual TLS authentication.

type [required]

enum

The source type. The value should always be syslog_ng. Allowed enum values: syslog_ng

default: syslog_ng

<type=websocket>

object

The websocket source ingests logs from a WebSocket server using the ws:// or wss:// protocol.

Supported pipeline types: logs.

auth_strategy [required]

enum

Authentication strategy for the WebSocket source connection. Allowed enum values: none,basic,bearer,custom

custom_key

string

Name of the environment variable or secret that holds the custom authorization header value. Used when auth_strategy is custom.

decoding [required]

enum

The decoding format used to interpret incoming logs. Allowed enum values: bytes,gelf,json,syslog

id [required]

string

The unique identifier for this component.

password_key

string

Name of the environment variable or secret that holds the password. Used when auth_strategy is basic.

tls

 <oneOf>

TLS configuration for the WebSocket source. Use enabled for standard wss:// connections, or with_client_cert to present a client certificate for mutual TLS.

<mode=enabled>

object

TLS configuration that enables encryption without a client certificate. Use this for standard wss:// connections that do not require mutual TLS.

mode [required]

enum

TLS mode. Must be enabled. Allowed enum values: enabled

<mode=with_client_cert>

object

TLS configuration that enables encryption and presents a client certificate for mutual TLS authentication.

ca_file

string

Path to the Certificate Authority (CA) file used to validate the remote server's TLS certificate.

crt_file [required]

string

Path to the TLS client certificate file used to identify this source to the remote server.

key_file

string

Path to the private key file associated with the client certificate.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

mode [required]

enum

TLS mode. Must be with_client_cert. Allowed enum values: with_client_cert

token_key

string

Name of the environment variable or secret that holds the bearer token. Used when auth_strategy is bearer.

type [required]

enum

The source type. The value should always be websocket. Allowed enum values: websocket

default: websocket

uri_key

string

Name of the environment variable or secret that holds the WebSocket server URI (ws:// or wss://).

username_key

string

Name of the environment variable or secret that holds the username. Used when auth_strategy is basic.

<type=opentelemetry>

object

The opentelemetry source receives telemetry data using the OpenTelemetry Protocol (OTLP) over gRPC and HTTP.

Supported pipeline types: logs, metrics

grpc_address_key

string

Environment variable name containing the gRPC server address for receiving OTLP data. Must be a valid environment variable name (alphanumeric characters and underscores only).

http_address_key

string

Environment variable name containing the HTTP server address for receiving OTLP data. Must be a valid environment variable name (alphanumeric characters and underscores only).

id [required]

string

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).

tls

object

Configuration for enabling TLS encryption between the pipeline component and external connecting clients.

ca_file

string

Path to the Certificate Authority (CA) file used to validate connecting clients' TLS certificates.

crt_file [required]

string

Path to the TLS server certificate file used to used to identify the pipeline component to connecting clients.

key_file

string

Path to the private key file associated with the TLS server certificate.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

verify_certificate

boolean

When true, requires client connections to present a valid certificate, enabling mutual TLS authentication.

type [required]

enum

The source type. The value should always be opentelemetry. Allowed enum values: opentelemetry

default: opentelemetry

<type=prometheus_remote_write>

object

The prometheus_remote_write source ingests metrics pushed over the Prometheus Remote Write protocol.

Supported pipeline types: metrics

address_key

string

Name of the environment variable or secret that holds the listen address for the Prometheus Remote Write endpoint.

auth_strategy [required]

enum

HTTP authentication method. Allowed enum values: none,plain

id [required]

string

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).

password_key

string

Name of the environment variable or secret that holds the password (used when auth_strategy is plain).

path [required]

string

The HTTP path on which the source listens for incoming Prometheus Remote Write requests.

tls

object

Configuration for enabling TLS encryption between the pipeline component and external connecting clients.

ca_file

string

Path to the Certificate Authority (CA) file used to validate connecting clients' TLS certificates.

crt_file [required]

string

Path to the TLS server certificate file used to used to identify the pipeline component to connecting clients.

key_file

string

Path to the private key file associated with the TLS server certificate.

key_pass_key

string

Name of the environment variable or secret that holds the passphrase for the private key file.

verify_certificate

boolean

When true, requires client connections to present a valid certificate, enabling mutual TLS authentication.

type [required]

enum

The source type. The value should always be prometheus_remote_write. Allowed enum values: prometheus_remote_write

default: prometheus_remote_write

username_key

string

Name of the environment variable or secret that holds the username (used when auth_strategy is plain).

valid_tokens

[object]

A list of tokens that are accepted for authenticating incoming requests. When set, the source rejects any request whose token does not match an enabled entry in this list.

enabled

boolean

Indicates whether this token is currently accepted. Disabled tokens are rejected without being removed from the configuration.

default: true

path_to_token

 <oneOf>

Specifies where the worker extracts the token from in the incoming HTTP request. This can be either a built-in location (path or address) or an HTTP header object.

Object 1

enum

Built-in token location on the incoming HTTP request. Allowed enum values: path,address

Object 2

object

Extract the token from a specific HTTP request header.

header [required]

string

The name of the HTTP header that carries the token.

token_key [required]

string

Name of the environment variable or secret that holds the expected token value.

use_legacy_search_syntax

boolean

Set to true to continue using the legacy search syntax while migrating filter queries. After migrating all queries to the new syntax, set to false. The legacy syntax is deprecated and will eventually be removed. Requires Observability Pipelines Worker 2.11 or later. Only applies to logs pipelines. This field is ignored for metrics pipelines. See Upgrade Your Filter Queries to the New Search Syntax for more information.

name [required]

string

Name of the pipeline.

type [required]

string

The resource type identifier. For pipeline resources, this should always be set to pipelines.

default: pipelines

{
  "data": {
    "attributes": {
      "config": {
        "pipeline_type": "metrics",
        "destinations": [
          {
            "id": "datadog-metrics-destination",
            "inputs": [
              "my-processor-group"
            ],
            "type": "datadog_metrics"
          }
        ],
        "processor_groups": [
          {
            "enabled": true,
            "id": "my-processor-group",
            "include": "*",
            "inputs": [
              "datadog-agent-source"
            ],
            "processors": [
              {
                "enabled": true,
                "id": "enrichment-table-processor",
                "include": "*",
                "type": "enrichment_table",
                "file": {
                  "encoding": {
                    "delimiter": ",",
                    "type": "csv",
                    "includes_headers": true
                  },
                  "key": {
                    "column": "service",
                    "source": {
                      "type": "tag",
                      "name": "service"
                    }
                  },
                  "path": "/etc/enrichment/lookup.csv"
                }
              }
            ]
          }
        ],
        "sources": [
          {
            "id": "datadog-agent-source",
            "type": "datadog_agent"
          }
        ]
      },
      "name": "Metrics Pipeline with Enrichment Table File Lookup"
    },
    "type": "pipelines"
  }
}
{
  "data": {
    "attributes": {
      "config": {
        "pipeline_type": "metrics",
        "destinations": [
          {
            "id": "datadog-metrics-destination",
            "inputs": [
              "my-processor-group"
            ],
            "type": "datadog_metrics"
          }
        ],
        "processor_groups": [
          {
            "enabled": true,
            "id": "my-processor-group",
            "include": "*",
            "inputs": [
              "datadog-agent-source"
            ],
            "processors": [
              {
                "enabled": true,
                "id": "enrichment-table-processor",
                "include": "*",
                "type": "enrichment_table",
                "reference_table": {
                  "table_id": "metric-enrichment",
                  "key": {
                    "source": {
                      "type": "metric_name"
                    }
                  },
                  "columns": [
                    "environment",
                    "team"
                  ]
                }
              }
            ]
          }
        ],
        "sources": [
          {
            "id": "datadog-agent-source",
            "type": "datadog_agent"
          }
        ]
      },
      "name": "Metrics Pipeline with Enrichment Table Reference Table"
    },
    "type": "pipelines"
  }
}
{
  "data": {
    "attributes": {
      "config": {
        "pipeline_type": "metrics",
        "destinations": [
          {
            "id": "datadog-metrics-destination",
            "inputs": [
              "my-processor-group"
            ],
            "type": "datadog_metrics"
          }
        ],
        "processor_groups": [
          {
            "enabled": true,
            "id": "my-processor-group",
            "include": "*",
            "inputs": [
              "opentelemetry-source"
            ],
            "processors": [
              {
                "enabled": true,
                "id": "filter-processor",
                "include": "env:production",
                "type": "filter"
              }
            ]
          }
        ],
        "sources": [
          {
            "id": "opentelemetry-source",
            "type": "opentelemetry"
          }
        ]
      },
      "name": "Metrics OTel Pipeline"
    },
    "type": "pipelines"
  }
}

Response

OK

Response containing validation errors.

Expand All

Field

Type

Description

errors

[object]

The ValidationResponse errors.

meta [required]

object

Describes additional metadata for validation errors, including field names and error messages.

field

string

The field name that caused the error.

id

string

The ID of the component in which the error occurred.

message [required]

string

The detailed error message.

title [required]

string

A short, human-readable summary of the error.

{
  "errors": [
    {
      "meta": {
        "field": "region",
        "id": "datadog-agent-source",
        "message": "Field 'region' is required"
      },
      "title": "Field 'region' is required"
    }
  ]
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Authorized

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                          ## default
# 

# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/obs-pipelines/pipelines/validate" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "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"
  }
}
EOF

                        
                          ## default
# 

# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/obs-pipelines/pipelines/validate" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "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"
  }
}
EOF

                        
                          ## default
# 

# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/obs-pipelines/pipelines/validate" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "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"
  }
}
EOF

                        
// Validate a metrics pipeline with opentelemetry source returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)

func main() {
	body := datadogV2.ObservabilityPipelineSpec{
		Data: datadogV2.ObservabilityPipelineSpecData{
			Attributes: datadogV2.ObservabilityPipelineDataAttributes{
				Config: datadogV2.ObservabilityPipelineConfig{
					PipelineType: datadogV2.OBSERVABILITYPIPELINECONFIGPIPELINETYPE_METRICS.Ptr(),
					Destinations: []datadogV2.ObservabilityPipelineConfigDestinationItem{
						datadogV2.ObservabilityPipelineConfigDestinationItem{
							ObservabilityPipelineDatadogMetricsDestination: &datadogV2.ObservabilityPipelineDatadogMetricsDestination{
								Id: "datadog-metrics-destination",
								Inputs: []string{
									"my-processor-group",
								},
								Type: datadogV2.OBSERVABILITYPIPELINEDATADOGMETRICSDESTINATIONTYPE_DATADOG_METRICS,
							}},
					},
					ProcessorGroups: []datadogV2.ObservabilityPipelineConfigProcessorGroup{
						{
							Enabled: true,
							Id:      "my-processor-group",
							Include: "*",
							Inputs: []string{
								"opentelemetry-source",
							},
							Processors: []datadogV2.ObservabilityPipelineConfigProcessorItem{
								datadogV2.ObservabilityPipelineConfigProcessorItem{
									ObservabilityPipelineFilterProcessor: &datadogV2.ObservabilityPipelineFilterProcessor{
										Enabled: true,
										Id:      "filter-processor",
										Include: "env:production",
										Type:    datadogV2.OBSERVABILITYPIPELINEFILTERPROCESSORTYPE_FILTER,
									}},
							},
						},
					},
					Sources: []datadogV2.ObservabilityPipelineConfigSourceItem{
						datadogV2.ObservabilityPipelineConfigSourceItem{
							ObservabilityPipelineOpentelemetrySource: &datadogV2.ObservabilityPipelineOpentelemetrySource{
								Id:   "opentelemetry-source",
								Type: datadogV2.OBSERVABILITYPIPELINEOPENTELEMETRYSOURCETYPE_OPENTELEMETRY,
							}},
					},
				},
				Name: "Metrics OTel Pipeline",
			},
			Type: "pipelines",
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewObservabilityPipelinesApi(apiClient)
	resp, r, err := api.ValidatePipeline(ctx, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObservabilityPipelinesApi.ValidatePipeline`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `ObservabilityPipelinesApi.ValidatePipeline`:\n%s\n", responseContent)
}

// Validate an observability pipeline returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)

func main() {
	body := datadogV2.ObservabilityPipelineSpec{
		Data: datadogV2.ObservabilityPipelineSpecData{
			Attributes: datadogV2.ObservabilityPipelineDataAttributes{
				Config: datadogV2.ObservabilityPipelineConfig{
					Destinations: []datadogV2.ObservabilityPipelineConfigDestinationItem{
						datadogV2.ObservabilityPipelineConfigDestinationItem{
							ObservabilityPipelineDatadogLogsDestination: &datadogV2.ObservabilityPipelineDatadogLogsDestination{
								Id: "datadog-logs-destination",
								Inputs: []string{
									"my-processor-group",
								},
								Type: datadogV2.OBSERVABILITYPIPELINEDATADOGLOGSDESTINATIONTYPE_DATADOG_LOGS,
							}},
					},
					ProcessorGroups: []datadogV2.ObservabilityPipelineConfigProcessorGroup{
						{
							Enabled: true,
							Id:      "my-processor-group",
							Include: "service:my-service",
							Inputs: []string{
								"datadog-agent-source",
							},
							Processors: []datadogV2.ObservabilityPipelineConfigProcessorItem{
								datadogV2.ObservabilityPipelineConfigProcessorItem{
									ObservabilityPipelineFilterProcessor: &datadogV2.ObservabilityPipelineFilterProcessor{
										Enabled: true,
										Id:      "filter-processor",
										Include: "status:error",
										Type:    datadogV2.OBSERVABILITYPIPELINEFILTERPROCESSORTYPE_FILTER,
									}},
							},
						},
					},
					Sources: []datadogV2.ObservabilityPipelineConfigSourceItem{
						datadogV2.ObservabilityPipelineConfigSourceItem{
							ObservabilityPipelineDatadogAgentSource: &datadogV2.ObservabilityPipelineDatadogAgentSource{
								Id:   "datadog-agent-source",
								Type: datadogV2.OBSERVABILITYPIPELINEDATADOGAGENTSOURCETYPE_DATADOG_AGENT,
							}},
					},
				},
				Name: "Main Observability Pipeline",
			},
			Type: "pipelines",
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewObservabilityPipelinesApi(apiClient)
	resp, r, err := api.ValidatePipeline(ctx, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObservabilityPipelinesApi.ValidatePipeline`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `ObservabilityPipelinesApi.ValidatePipeline`:\n%s\n", responseContent)
}

// Validate an observability pipeline with ClickHouse destination arrow_stream format returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)

func main() {
	body := datadogV2.ObservabilityPipelineSpec{
		Data: datadogV2.ObservabilityPipelineSpecData{
			Attributes: datadogV2.ObservabilityPipelineDataAttributes{
				Config: datadogV2.ObservabilityPipelineConfig{
					Destinations: []datadogV2.ObservabilityPipelineConfigDestinationItem{
						datadogV2.ObservabilityPipelineConfigDestinationItem{
							ObservabilityPipelineClickhouseDestination: &datadogV2.ObservabilityPipelineClickhouseDestination{
								Id: "clickhouse-destination",
								Inputs: []string{
									"my-processor-group",
								},
								Type:     datadogV2.OBSERVABILITYPIPELINECLICKHOUSEDESTINATIONTYPE_CLICKHOUSE,
								Table:    "application_logs",
								Database: datadog.PtrString("my_database"),
								Format:   datadogV2.OBSERVABILITYPIPELINECLICKHOUSEDESTINATIONFORMAT_ARROW_STREAM.Ptr(),
								BatchEncoding: &datadogV2.ObservabilityPipelineClickhouseDestinationBatchEncoding{
									Codec:               datadogV2.OBSERVABILITYPIPELINECLICKHOUSEDESTINATIONBATCHENCODINGCODEC_ARROW_STREAM,
									AllowNullableFields: datadog.PtrBool(false),
								},
								Compression: &datadogV2.ObservabilityPipelineClickhouseDestinationCompression{
									ObservabilityPipelineClickhouseDestinationCompressionAlgorithm: datadogV2.OBSERVABILITYPIPELINECLICKHOUSEDESTINATIONCOMPRESSIONALGORITHM_GZIP.Ptr()},
								Auth: &datadogV2.ObservabilityPipelineClickhouseDestinationAuth{
									Strategy:    datadogV2.OBSERVABILITYPIPELINECLICKHOUSEDESTINATIONAUTHSTRATEGY_BASIC,
									UsernameKey: datadog.PtrString("CLICKHOUSE_USERNAME"),
									PasswordKey: datadog.PtrString("CLICKHOUSE_PASSWORD"),
								},
								Batch: &datadogV2.ObservabilityPipelineClickhouseDestinationBatch{
									MaxEvents:   datadog.PtrInt64(1000),
									TimeoutSecs: datadog.PtrInt64(1),
								},
							}},
					},
					ProcessorGroups: []datadogV2.ObservabilityPipelineConfigProcessorGroup{
						{
							Enabled: true,
							Id:      "my-processor-group",
							Include: "service:my-service",
							Inputs: []string{
								"datadog-agent-source",
							},
							Processors: []datadogV2.ObservabilityPipelineConfigProcessorItem{
								datadogV2.ObservabilityPipelineConfigProcessorItem{
									ObservabilityPipelineFilterProcessor: &datadogV2.ObservabilityPipelineFilterProcessor{
										Enabled: true,
										Id:      "filter-processor",
										Include: "status:error",
										Type:    datadogV2.OBSERVABILITYPIPELINEFILTERPROCESSORTYPE_FILTER,
									}},
							},
						},
					},
					Sources: []datadogV2.ObservabilityPipelineConfigSourceItem{
						datadogV2.ObservabilityPipelineConfigSourceItem{
							ObservabilityPipelineDatadogAgentSource: &datadogV2.ObservabilityPipelineDatadogAgentSource{
								Id:   "datadog-agent-source",
								Type: datadogV2.OBSERVABILITYPIPELINEDATADOGAGENTSOURCETYPE_DATADOG_AGENT,
							}},
					},
				},
				Name: "Pipeline with ClickHouse Destination Arrow Stream",
			},
			Type: "pipelines",
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewObservabilityPipelinesApi(apiClient)
	resp, r, err := api.ValidatePipeline(ctx, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ObservabilityPipelinesApi.ValidatePipeline`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `ObservabilityPipelinesApi.ValidatePipeline`:\n%s\n", responseContent)
}

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"
// Validate a metrics pipeline with opentelemetry source 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.ObservabilityPipelineConfigPipelineType;
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.ObservabilityPipelineDatadogMetricsDestination;
import com.datadog.api.client.v2.model.ObservabilityPipelineDatadogMetricsDestinationType;
import com.datadog.api.client.v2.model.ObservabilityPipelineFilterProcessor;
import com.datadog.api.client.v2.model.ObservabilityPipelineFilterProcessorType;
import com.datadog.api.client.v2.model.ObservabilityPipelineOpentelemetrySource;
import com.datadog.api.client.v2.model.ObservabilityPipelineOpentelemetrySourceType;
import com.datadog.api.client.v2.model.ObservabilityPipelineSpec;
import com.datadog.api.client.v2.model.ObservabilityPipelineSpecData;
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();
    defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
    ObservabilityPipelinesApi apiInstance = new ObservabilityPipelinesApi(defaultClient);

    ObservabilityPipelineSpec body =
        new ObservabilityPipelineSpec()
            .data(
                new ObservabilityPipelineSpecData()
                    .attributes(
                        new ObservabilityPipelineDataAttributes()
                            .config(
                                new ObservabilityPipelineConfig()
                                    .pipelineType(ObservabilityPipelineConfigPipelineType.METRICS)
                                    .destinations(
                                        Collections.singletonList(
                                            new ObservabilityPipelineConfigDestinationItem(
                                                new ObservabilityPipelineDatadogMetricsDestination()
                                                    .id("datadog-metrics-destination")
                                                    .inputs(
                                                        Collections.singletonList(
                                                            "my-processor-group"))
                                                    .type(
                                                        ObservabilityPipelineDatadogMetricsDestinationType
                                                            .DATADOG_METRICS))))
                                    .processorGroups(
                                        Collections.singletonList(
                                            new ObservabilityPipelineConfigProcessorGroup()
                                                .enabled(true)
                                                .id("my-processor-group")
                                                .include("*")
                                                .inputs(
                                                    Collections.singletonList(
                                                        "opentelemetry-source"))
                                                .processors(
                                                    Collections.singletonList(
                                                        new ObservabilityPipelineConfigProcessorItem(
                                                            new ObservabilityPipelineFilterProcessor()
                                                                .enabled(true)
                                                                .id("filter-processor")
                                                                .include("env:production")
                                                                .type(
                                                                    ObservabilityPipelineFilterProcessorType
                                                                        .FILTER))))))
                                    .sources(
                                        Collections.singletonList(
                                            new ObservabilityPipelineConfigSourceItem(
                                                new ObservabilityPipelineOpentelemetrySource()
                                                    .id("opentelemetry-source")
                                                    .type(
                                                        ObservabilityPipelineOpentelemetrySourceType
                                                            .OPENTELEMETRY)))))
                            .name("Metrics OTel Pipeline"))
                    .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();
    }
  }
}

// Validate an observability pipeline 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.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.ValidationResponse;
import java.util.Collections;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
    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(
                                                        "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("Main Observability Pipeline"))
                    .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();
    }
  }
}

// Validate an observability pipeline with ClickHouse destination arrow_stream format 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.ObservabilityPipelineClickhouseDestination;
import com.datadog.api.client.v2.model.ObservabilityPipelineClickhouseDestinationAuth;
import com.datadog.api.client.v2.model.ObservabilityPipelineClickhouseDestinationAuthStrategy;
import com.datadog.api.client.v2.model.ObservabilityPipelineClickhouseDestinationBatch;
import com.datadog.api.client.v2.model.ObservabilityPipelineClickhouseDestinationBatchEncoding;
import com.datadog.api.client.v2.model.ObservabilityPipelineClickhouseDestinationBatchEncodingCodec;
import com.datadog.api.client.v2.model.ObservabilityPipelineClickhouseDestinationCompression;
import com.datadog.api.client.v2.model.ObservabilityPipelineClickhouseDestinationCompressionAlgorithm;
import com.datadog.api.client.v2.model.ObservabilityPipelineClickhouseDestinationFormat;
import com.datadog.api.client.v2.model.ObservabilityPipelineClickhouseDestinationType;
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.ValidationResponse;
import java.util.Collections;

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

    ObservabilityPipelineSpec body =
        new ObservabilityPipelineSpec()
            .data(
                new ObservabilityPipelineSpecData()
                    .attributes(
                        new ObservabilityPipelineDataAttributes()
                            .config(
                                new ObservabilityPipelineConfig()
                                    .destinations(
                                        Collections.singletonList(
                                            new ObservabilityPipelineConfigDestinationItem(
                                                new ObservabilityPipelineClickhouseDestination()
                                                    .id("clickhouse-destination")
                                                    .inputs(
                                                        Collections.singletonList(
                                                            "my-processor-group"))
                                                    .type(
                                                        ObservabilityPipelineClickhouseDestinationType
                                                            .CLICKHOUSE)
                                                    .table("application_logs")
                                                    .database("my_database")
                                                    .format(
                                                        ObservabilityPipelineClickhouseDestinationFormat
                                                            .ARROW_STREAM)
                                                    .batchEncoding(
                                                        new ObservabilityPipelineClickhouseDestinationBatchEncoding()
                                                            .codec(
                                                                ObservabilityPipelineClickhouseDestinationBatchEncodingCodec
                                                                    .ARROW_STREAM)
                                                            .allowNullableFields(false))
                                                    .compression(
                                                        new ObservabilityPipelineClickhouseDestinationCompression(
                                                            ObservabilityPipelineClickhouseDestinationCompressionAlgorithm
                                                                .GZIP))
                                                    .auth(
                                                        new ObservabilityPipelineClickhouseDestinationAuth()
                                                            .strategy(
                                                                ObservabilityPipelineClickhouseDestinationAuthStrategy
                                                                    .BASIC)
                                                            .usernameKey("CLICKHOUSE_USERNAME")
                                                            .passwordKey("CLICKHOUSE_PASSWORD"))
                                                    .batch(
                                                        new ObservabilityPipelineClickhouseDestinationBatch()
                                                            .maxEvents(1000L)
                                                            .timeoutSecs(1L)))))
                                    .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 ClickHouse Destination Arrow Stream"))
                    .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();
    }
  }
}

Instructions

First install the library and its dependencies and then save the example to Example.java and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"
"""
Validate a metrics pipeline with opentelemetry source returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.observability_pipelines_api import ObservabilityPipelinesApi
from datadog_api_client.v2.model.observability_pipeline_config import ObservabilityPipelineConfig
from datadog_api_client.v2.model.observability_pipeline_config_pipeline_type import (
    ObservabilityPipelineConfigPipelineType,
)
from datadog_api_client.v2.model.observability_pipeline_config_processor_group import (
    ObservabilityPipelineConfigProcessorGroup,
)
from datadog_api_client.v2.model.observability_pipeline_data_attributes import ObservabilityPipelineDataAttributes
from datadog_api_client.v2.model.observability_pipeline_datadog_metrics_destination import (
    ObservabilityPipelineDatadogMetricsDestination,
)
from datadog_api_client.v2.model.observability_pipeline_datadog_metrics_destination_type import (
    ObservabilityPipelineDatadogMetricsDestinationType,
)
from datadog_api_client.v2.model.observability_pipeline_filter_processor import ObservabilityPipelineFilterProcessor
from datadog_api_client.v2.model.observability_pipeline_filter_processor_type import (
    ObservabilityPipelineFilterProcessorType,
)
from datadog_api_client.v2.model.observability_pipeline_opentelemetry_source import (
    ObservabilityPipelineOpentelemetrySource,
)
from datadog_api_client.v2.model.observability_pipeline_opentelemetry_source_type import (
    ObservabilityPipelineOpentelemetrySourceType,
)
from datadog_api_client.v2.model.observability_pipeline_spec import ObservabilityPipelineSpec
from datadog_api_client.v2.model.observability_pipeline_spec_data import ObservabilityPipelineSpecData

body = ObservabilityPipelineSpec(
    data=ObservabilityPipelineSpecData(
        attributes=ObservabilityPipelineDataAttributes(
            config=ObservabilityPipelineConfig(
                pipeline_type=ObservabilityPipelineConfigPipelineType.METRICS,
                destinations=[
                    ObservabilityPipelineDatadogMetricsDestination(
                        id="datadog-metrics-destination",
                        inputs=[
                            "my-processor-group",
                        ],
                        type=ObservabilityPipelineDatadogMetricsDestinationType.DATADOG_METRICS,
                    ),
                ],
                processor_groups=[
                    ObservabilityPipelineConfigProcessorGroup(
                        enabled=True,
                        id="my-processor-group",
                        include="*",
                        inputs=[
                            "opentelemetry-source",
                        ],
                        processors=[
                            ObservabilityPipelineFilterProcessor(
                                enabled=True,
                                id="filter-processor",
                                include="env:production",
                                type=ObservabilityPipelineFilterProcessorType.FILTER,
                            ),
                        ],
                    ),
                ],
                sources=[
                    ObservabilityPipelineOpentelemetrySource(
                        id="opentelemetry-source",
                        type=ObservabilityPipelineOpentelemetrySourceType.OPENTELEMETRY,
                    ),
                ],
            ),
            name="Metrics OTel Pipeline",
        ),
        type="pipelines",
    ),
)

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
    api_instance = ObservabilityPipelinesApi(api_client)
    response = api_instance.validate_pipeline(body=body)

    print(response)

"""
Validate an observability pipeline returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.observability_pipelines_api import ObservabilityPipelinesApi
from datadog_api_client.v2.model.observability_pipeline_config import ObservabilityPipelineConfig
from datadog_api_client.v2.model.observability_pipeline_config_processor_group import (
    ObservabilityPipelineConfigProcessorGroup,
)
from datadog_api_client.v2.model.observability_pipeline_data_attributes import ObservabilityPipelineDataAttributes
from datadog_api_client.v2.model.observability_pipeline_datadog_agent_source import (
    ObservabilityPipelineDatadogAgentSource,
)
from datadog_api_client.v2.model.observability_pipeline_datadog_agent_source_type import (
    ObservabilityPipelineDatadogAgentSourceType,
)
from datadog_api_client.v2.model.observability_pipeline_datadog_logs_destination import (
    ObservabilityPipelineDatadogLogsDestination,
)
from datadog_api_client.v2.model.observability_pipeline_datadog_logs_destination_type import (
    ObservabilityPipelineDatadogLogsDestinationType,
)
from datadog_api_client.v2.model.observability_pipeline_filter_processor import ObservabilityPipelineFilterProcessor
from datadog_api_client.v2.model.observability_pipeline_filter_processor_type import (
    ObservabilityPipelineFilterProcessorType,
)
from datadog_api_client.v2.model.observability_pipeline_spec import ObservabilityPipelineSpec
from datadog_api_client.v2.model.observability_pipeline_spec_data import ObservabilityPipelineSpecData

body = ObservabilityPipelineSpec(
    data=ObservabilityPipelineSpecData(
        attributes=ObservabilityPipelineDataAttributes(
            config=ObservabilityPipelineConfig(
                destinations=[
                    ObservabilityPipelineDatadogLogsDestination(
                        id="datadog-logs-destination",
                        inputs=[
                            "my-processor-group",
                        ],
                        type=ObservabilityPipelineDatadogLogsDestinationType.DATADOG_LOGS,
                    ),
                ],
                processor_groups=[
                    ObservabilityPipelineConfigProcessorGroup(
                        enabled=True,
                        id="my-processor-group",
                        include="service:my-service",
                        inputs=[
                            "datadog-agent-source",
                        ],
                        processors=[
                            ObservabilityPipelineFilterProcessor(
                                enabled=True,
                                id="filter-processor",
                                include="status:error",
                                type=ObservabilityPipelineFilterProcessorType.FILTER,
                            ),
                        ],
                    ),
                ],
                sources=[
                    ObservabilityPipelineDatadogAgentSource(
                        id="datadog-agent-source",
                        type=ObservabilityPipelineDatadogAgentSourceType.DATADOG_AGENT,
                    ),
                ],
            ),
            name="Main Observability Pipeline",
        ),
        type="pipelines",
    ),
)

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
    api_instance = ObservabilityPipelinesApi(api_client)
    response = api_instance.validate_pipeline(body=body)

    print(response)

"""
Validate an observability pipeline with ClickHouse destination arrow_stream format returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.observability_pipelines_api import ObservabilityPipelinesApi
from datadog_api_client.v2.model.observability_pipeline_clickhouse_destination import (
    ObservabilityPipelineClickhouseDestination,
)
from datadog_api_client.v2.model.observability_pipeline_clickhouse_destination_auth import (
    ObservabilityPipelineClickhouseDestinationAuth,
)
from datadog_api_client.v2.model.observability_pipeline_clickhouse_destination_auth_strategy import (
    ObservabilityPipelineClickhouseDestinationAuthStrategy,
)
from datadog_api_client.v2.model.observability_pipeline_clickhouse_destination_batch import (
    ObservabilityPipelineClickhouseDestinationBatch,
)
from datadog_api_client.v2.model.observability_pipeline_clickhouse_destination_batch_encoding import (
    ObservabilityPipelineClickhouseDestinationBatchEncoding,
)
from datadog_api_client.v2.model.observability_pipeline_clickhouse_destination_batch_encoding_codec import (
    ObservabilityPipelineClickhouseDestinationBatchEncodingCodec,
)
from datadog_api_client.v2.model.observability_pipeline_clickhouse_destination_format import (
    ObservabilityPipelineClickhouseDestinationFormat,
)
from datadog_api_client.v2.model.observability_pipeline_clickhouse_destination_type import (
    ObservabilityPipelineClickhouseDestinationType,
)
from datadog_api_client.v2.model.observability_pipeline_config import ObservabilityPipelineConfig
from datadog_api_client.v2.model.observability_pipeline_config_processor_group import (
    ObservabilityPipelineConfigProcessorGroup,
)
from datadog_api_client.v2.model.observability_pipeline_data_attributes import ObservabilityPipelineDataAttributes
from datadog_api_client.v2.model.observability_pipeline_datadog_agent_source import (
    ObservabilityPipelineDatadogAgentSource,
)
from datadog_api_client.v2.model.observability_pipeline_datadog_agent_source_type import (
    ObservabilityPipelineDatadogAgentSourceType,
)
from datadog_api_client.v2.model.observability_pipeline_filter_processor import ObservabilityPipelineFilterProcessor
from datadog_api_client.v2.model.observability_pipeline_filter_processor_type import (
    ObservabilityPipelineFilterProcessorType,
)
from datadog_api_client.v2.model.observability_pipeline_spec import ObservabilityPipelineSpec
from datadog_api_client.v2.model.observability_pipeline_spec_data import ObservabilityPipelineSpecData

body = ObservabilityPipelineSpec(
    data=ObservabilityPipelineSpecData(
        attributes=ObservabilityPipelineDataAttributes(
            config=ObservabilityPipelineConfig(
                destinations=[
                    ObservabilityPipelineClickhouseDestination(
                        id="clickhouse-destination",
                        inputs=[
                            "my-processor-group",
                        ],
                        type=ObservabilityPipelineClickhouseDestinationType.CLICKHOUSE,
                        table="application_logs",
                        database="my_database",
                        format=ObservabilityPipelineClickhouseDestinationFormat.ARROW_STREAM,
                        batch_encoding=ObservabilityPipelineClickhouseDestinationBatchEncoding(
                            codec=ObservabilityPipelineClickhouseDestinationBatchEncodingCodec.ARROW_STREAM,
                            allow_nullable_fields=False,
                        ),
                        compression="gzip",
                        auth=ObservabilityPipelineClickhouseDestinationAuth(
                            strategy=ObservabilityPipelineClickhouseDestinationAuthStrategy.BASIC,
                            username_key="CLICKHOUSE_USERNAME",
                            password_key="CLICKHOUSE_PASSWORD",
                        ),
                        batch=ObservabilityPipelineClickhouseDestinationBatch(
                            max_events=1000,
                            timeout_secs=1,
                        ),
                    ),
                ],
                processor_groups=[
                    ObservabilityPipelineConfigProcessorGroup(
                        enabled=True,
                        id="my-processor-group",
                        include="service:my-service",
                        inputs=[
                            "datadog-agent-source",
                        ],
                        processors=[
                            ObservabilityPipelineFilterProcessor(
                                enabled=True,
                                id="filter-processor",
                                include="status:error",
                                type=ObservabilityPipelineFilterProcessorType.FILTER,
                            ),
                        ],
                    ),
                ],
                sources=[
                    ObservabilityPipelineDatadogAgentSource(
                        id="datadog-agent-source",
                        type=ObservabilityPipelineDatadogAgentSourceType.DATADOG_AGENT,
                    ),
                ],
            ),
            name="Pipeline with ClickHouse Destination Arrow Stream",
        ),
        type="pipelines",
    ),
)

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
    api_instance = ObservabilityPipelinesApi(api_client)
    response = api_instance.validate_pipeline(body=body)

    print(response)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"
# Validate a metrics pipeline with opentelemetry source returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::ObservabilityPipelinesAPI.new

body = DatadogAPIClient::V2::ObservabilityPipelineSpec.new({
  data: DatadogAPIClient::V2::ObservabilityPipelineSpecData.new({
    attributes: DatadogAPIClient::V2::ObservabilityPipelineDataAttributes.new({
      config: DatadogAPIClient::V2::ObservabilityPipelineConfig.new({
        pipeline_type: DatadogAPIClient::V2::ObservabilityPipelineConfigPipelineType::METRICS,
        destinations: [
          DatadogAPIClient::V2::ObservabilityPipelineDatadogMetricsDestination.new({
            id: "datadog-metrics-destination",
            inputs: [
              "my-processor-group",
            ],
            type: DatadogAPIClient::V2::ObservabilityPipelineDatadogMetricsDestinationType::DATADOG_METRICS,
          }),
        ],
        processor_groups: [
          DatadogAPIClient::V2::ObservabilityPipelineConfigProcessorGroup.new({
            enabled: true,
            id: "my-processor-group",
            include: "*",
            inputs: [
              "opentelemetry-source",
            ],
            processors: [
              DatadogAPIClient::V2::ObservabilityPipelineFilterProcessor.new({
                enabled: true,
                id: "filter-processor",
                include: "env:production",
                type: DatadogAPIClient::V2::ObservabilityPipelineFilterProcessorType::FILTER,
              }),
            ],
          }),
        ],
        sources: [
          DatadogAPIClient::V2::ObservabilityPipelineOpentelemetrySource.new({
            id: "opentelemetry-source",
            type: DatadogAPIClient::V2::ObservabilityPipelineOpentelemetrySourceType::OPENTELEMETRY,
          }),
        ],
      }),
      name: "Metrics OTel Pipeline",
    }),
    type: "pipelines",
  }),
})
p api_instance.validate_pipeline(body)

# Validate an observability pipeline returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::ObservabilityPipelinesAPI.new

body = DatadogAPIClient::V2::ObservabilityPipelineSpec.new({
  data: DatadogAPIClient::V2::ObservabilityPipelineSpecData.new({
    attributes: DatadogAPIClient::V2::ObservabilityPipelineDataAttributes.new({
      config: DatadogAPIClient::V2::ObservabilityPipelineConfig.new({
        destinations: [
          DatadogAPIClient::V2::ObservabilityPipelineDatadogLogsDestination.new({
            id: "datadog-logs-destination",
            inputs: [
              "my-processor-group",
            ],
            type: DatadogAPIClient::V2::ObservabilityPipelineDatadogLogsDestinationType::DATADOG_LOGS,
          }),
        ],
        processor_groups: [
          DatadogAPIClient::V2::ObservabilityPipelineConfigProcessorGroup.new({
            enabled: true,
            id: "my-processor-group",
            include: "service:my-service",
            inputs: [
              "datadog-agent-source",
            ],
            processors: [
              DatadogAPIClient::V2::ObservabilityPipelineFilterProcessor.new({
                enabled: true,
                id: "filter-processor",
                include: "status:error",
                type: DatadogAPIClient::V2::ObservabilityPipelineFilterProcessorType::FILTER,
              }),
            ],
          }),
        ],
        sources: [
          DatadogAPIClient::V2::ObservabilityPipelineDatadogAgentSource.new({
            id: "datadog-agent-source",
            type: DatadogAPIClient::V2::ObservabilityPipelineDatadogAgentSourceType::DATADOG_AGENT,
          }),
        ],
      }),
      name: "Main Observability Pipeline",
    }),
    type: "pipelines",
  }),
})
p api_instance.validate_pipeline(body)

# Validate an observability pipeline with ClickHouse destination arrow_stream format returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::ObservabilityPipelinesAPI.new

body = DatadogAPIClient::V2::ObservabilityPipelineSpec.new({
  data: DatadogAPIClient::V2::ObservabilityPipelineSpecData.new({
    attributes: DatadogAPIClient::V2::ObservabilityPipelineDataAttributes.new({
      config: DatadogAPIClient::V2::ObservabilityPipelineConfig.new({
        destinations: [
          DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestination.new({
            id: "clickhouse-destination",
            inputs: [
              "my-processor-group",
            ],
            type: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationType::CLICKHOUSE,
            table: "application_logs",
            database: "my_database",
            format: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationFormat::ARROW_STREAM,
            batch_encoding: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationBatchEncoding.new({
              codec: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationBatchEncodingCodec::ARROW_STREAM,
              allow_nullable_fields: false,
            }),
            compression: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationCompressionAlgorithm::GZIP,
            auth: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationAuth.new({
              strategy: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationAuthStrategy::BASIC,
              username_key: "CLICKHOUSE_USERNAME",
              password_key: "CLICKHOUSE_PASSWORD",
            }),
            batch: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationBatch.new({
              max_events: 1000,
              timeout_secs: 1,
            }),
          }),
        ],
        processor_groups: [
          DatadogAPIClient::V2::ObservabilityPipelineConfigProcessorGroup.new({
            enabled: true,
            id: "my-processor-group",
            include: "service:my-service",
            inputs: [
              "datadog-agent-source",
            ],
            processors: [
              DatadogAPIClient::V2::ObservabilityPipelineFilterProcessor.new({
                enabled: true,
                id: "filter-processor",
                include: "status:error",
                type: DatadogAPIClient::V2::ObservabilityPipelineFilterProcessorType::FILTER,
              }),
            ],
          }),
        ],
        sources: [
          DatadogAPIClient::V2::ObservabilityPipelineDatadogAgentSource.new({
            id: "datadog-agent-source",
            type: DatadogAPIClient::V2::ObservabilityPipelineDatadogAgentSourceType::DATADOG_AGENT,
          }),
        ],
      }),
      name: "Pipeline with ClickHouse Destination Arrow Stream",
    }),
    type: "pipelines",
  }),
})
p api_instance.validate_pipeline(body)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"
// Validate a metrics pipeline with opentelemetry source returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_observability_pipelines::ObservabilityPipelinesAPI;
use datadog_api_client::datadogV2::model::ObservabilityPipelineConfig;
use datadog_api_client::datadogV2::model::ObservabilityPipelineConfigDestinationItem;
use datadog_api_client::datadogV2::model::ObservabilityPipelineConfigPipelineType;
use datadog_api_client::datadogV2::model::ObservabilityPipelineConfigProcessorGroup;
use datadog_api_client::datadogV2::model::ObservabilityPipelineConfigProcessorItem;
use datadog_api_client::datadogV2::model::ObservabilityPipelineConfigSourceItem;
use datadog_api_client::datadogV2::model::ObservabilityPipelineDataAttributes;
use datadog_api_client::datadogV2::model::ObservabilityPipelineDatadogMetricsDestination;
use datadog_api_client::datadogV2::model::ObservabilityPipelineDatadogMetricsDestinationType;
use datadog_api_client::datadogV2::model::ObservabilityPipelineFilterProcessor;
use datadog_api_client::datadogV2::model::ObservabilityPipelineFilterProcessorType;
use datadog_api_client::datadogV2::model::ObservabilityPipelineOpentelemetrySource;
use datadog_api_client::datadogV2::model::ObservabilityPipelineOpentelemetrySourceType;
use datadog_api_client::datadogV2::model::ObservabilityPipelineSpec;
use datadog_api_client::datadogV2::model::ObservabilityPipelineSpecData;

#[tokio::main]
async fn main() {
    let body =
        ObservabilityPipelineSpec::new(
            ObservabilityPipelineSpecData::new(
                ObservabilityPipelineDataAttributes::new(
                    ObservabilityPipelineConfig::new(
                        vec![
                            ObservabilityPipelineConfigDestinationItem::ObservabilityPipelineDatadogMetricsDestination(
                                Box::new(
                                    ObservabilityPipelineDatadogMetricsDestination::new(
                                        "datadog-metrics-destination".to_string(),
                                        vec!["my-processor-group".to_string()],
                                        ObservabilityPipelineDatadogMetricsDestinationType::DATADOG_METRICS,
                                    ),
                                ),
                            )
                        ],
                        vec![
                            ObservabilityPipelineConfigSourceItem::ObservabilityPipelineOpentelemetrySource(
                                Box::new(
                                    ObservabilityPipelineOpentelemetrySource::new(
                                        "opentelemetry-source".to_string(),
                                        ObservabilityPipelineOpentelemetrySourceType::OPENTELEMETRY,
                                    ),
                                ),
                            )
                        ],
                    )
                        .pipeline_type(ObservabilityPipelineConfigPipelineType::METRICS)
                        .processor_groups(
                            vec![
                                ObservabilityPipelineConfigProcessorGroup::new(
                                    true,
                                    "my-processor-group".to_string(),
                                    "*".to_string(),
                                    vec!["opentelemetry-source".to_string()],
                                    vec![
                                        ObservabilityPipelineConfigProcessorItem::ObservabilityPipelineFilterProcessor(
                                            Box::new(
                                                ObservabilityPipelineFilterProcessor::new(
                                                    true,
                                                    "filter-processor".to_string(),
                                                    "env:production".to_string(),
                                                    ObservabilityPipelineFilterProcessorType::FILTER,
                                                ),
                                            ),
                                        )
                                    ],
                                )
                            ],
                        ),
                    "Metrics OTel Pipeline".to_string(),
                ),
                "pipelines".to_string(),
            ),
        );
    let configuration = datadog::Configuration::new();
    let api = ObservabilityPipelinesAPI::with_config(configuration);
    let resp = api.validate_pipeline(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

// Validate an observability pipeline returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_observability_pipelines::ObservabilityPipelinesAPI;
use datadog_api_client::datadogV2::model::ObservabilityPipelineConfig;
use datadog_api_client::datadogV2::model::ObservabilityPipelineConfigDestinationItem;
use datadog_api_client::datadogV2::model::ObservabilityPipelineConfigProcessorGroup;
use datadog_api_client::datadogV2::model::ObservabilityPipelineConfigProcessorItem;
use datadog_api_client::datadogV2::model::ObservabilityPipelineConfigSourceItem;
use datadog_api_client::datadogV2::model::ObservabilityPipelineDataAttributes;
use datadog_api_client::datadogV2::model::ObservabilityPipelineDatadogAgentSource;
use datadog_api_client::datadogV2::model::ObservabilityPipelineDatadogAgentSourceType;
use datadog_api_client::datadogV2::model::ObservabilityPipelineDatadogLogsDestination;
use datadog_api_client::datadogV2::model::ObservabilityPipelineDatadogLogsDestinationType;
use datadog_api_client::datadogV2::model::ObservabilityPipelineFilterProcessor;
use datadog_api_client::datadogV2::model::ObservabilityPipelineFilterProcessorType;
use datadog_api_client::datadogV2::model::ObservabilityPipelineSpec;
use datadog_api_client::datadogV2::model::ObservabilityPipelineSpecData;

#[tokio::main]
async fn main() {
    let body =
        ObservabilityPipelineSpec::new(
            ObservabilityPipelineSpecData::new(
                ObservabilityPipelineDataAttributes::new(
                    ObservabilityPipelineConfig::new(
                        vec![
                            ObservabilityPipelineConfigDestinationItem::ObservabilityPipelineDatadogLogsDestination(
                                Box::new(
                                    ObservabilityPipelineDatadogLogsDestination::new(
                                        "datadog-logs-destination".to_string(),
                                        vec!["my-processor-group".to_string()],
                                        ObservabilityPipelineDatadogLogsDestinationType::DATADOG_LOGS,
                                    ),
                                ),
                            )
                        ],
                        vec![
                            ObservabilityPipelineConfigSourceItem::ObservabilityPipelineDatadogAgentSource(
                                Box::new(
                                    ObservabilityPipelineDatadogAgentSource::new(
                                        "datadog-agent-source".to_string(),
                                        ObservabilityPipelineDatadogAgentSourceType::DATADOG_AGENT,
                                    ),
                                ),
                            )
                        ],
                    ).processor_groups(
                        vec![
                            ObservabilityPipelineConfigProcessorGroup::new(
                                true,
                                "my-processor-group".to_string(),
                                "service:my-service".to_string(),
                                vec!["datadog-agent-source".to_string()],
                                vec![
                                    ObservabilityPipelineConfigProcessorItem::ObservabilityPipelineFilterProcessor(
                                        Box::new(
                                            ObservabilityPipelineFilterProcessor::new(
                                                true,
                                                "filter-processor".to_string(),
                                                "status:error".to_string(),
                                                ObservabilityPipelineFilterProcessorType::FILTER,
                                            ),
                                        ),
                                    )
                                ],
                            )
                        ],
                    ),
                    "Main Observability Pipeline".to_string(),
                ),
                "pipelines".to_string(),
            ),
        );
    let configuration = datadog::Configuration::new();
    let api = ObservabilityPipelinesAPI::with_config(configuration);
    let resp = api.validate_pipeline(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

// Validate an observability pipeline with ClickHouse destination arrow_stream
// format returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_observability_pipelines::ObservabilityPipelinesAPI;
use datadog_api_client::datadogV2::model::ObservabilityPipelineClickhouseDestination;
use datadog_api_client::datadogV2::model::ObservabilityPipelineClickhouseDestinationAuth;
use datadog_api_client::datadogV2::model::ObservabilityPipelineClickhouseDestinationAuthStrategy;
use datadog_api_client::datadogV2::model::ObservabilityPipelineClickhouseDestinationBatch;
use datadog_api_client::datadogV2::model::ObservabilityPipelineClickhouseDestinationBatchEncoding;
use datadog_api_client::datadogV2::model::ObservabilityPipelineClickhouseDestinationBatchEncodingCodec;
use datadog_api_client::datadogV2::model::ObservabilityPipelineClickhouseDestinationCompression;
use datadog_api_client::datadogV2::model::ObservabilityPipelineClickhouseDestinationCompressionAlgorithm;
use datadog_api_client::datadogV2::model::ObservabilityPipelineClickhouseDestinationFormat;
use datadog_api_client::datadogV2::model::ObservabilityPipelineClickhouseDestinationType;
use datadog_api_client::datadogV2::model::ObservabilityPipelineConfig;
use datadog_api_client::datadogV2::model::ObservabilityPipelineConfigDestinationItem;
use datadog_api_client::datadogV2::model::ObservabilityPipelineConfigProcessorGroup;
use datadog_api_client::datadogV2::model::ObservabilityPipelineConfigProcessorItem;
use datadog_api_client::datadogV2::model::ObservabilityPipelineConfigSourceItem;
use datadog_api_client::datadogV2::model::ObservabilityPipelineDataAttributes;
use datadog_api_client::datadogV2::model::ObservabilityPipelineDatadogAgentSource;
use datadog_api_client::datadogV2::model::ObservabilityPipelineDatadogAgentSourceType;
use datadog_api_client::datadogV2::model::ObservabilityPipelineFilterProcessor;
use datadog_api_client::datadogV2::model::ObservabilityPipelineFilterProcessorType;
use datadog_api_client::datadogV2::model::ObservabilityPipelineSpec;
use datadog_api_client::datadogV2::model::ObservabilityPipelineSpecData;

#[tokio::main]
async fn main() {
    let body =
        ObservabilityPipelineSpec::new(
            ObservabilityPipelineSpecData::new(
                ObservabilityPipelineDataAttributes::new(
                    ObservabilityPipelineConfig::new(
                        vec![
                            ObservabilityPipelineConfigDestinationItem::ObservabilityPipelineClickhouseDestination(
                                Box::new(
                                    ObservabilityPipelineClickhouseDestination::new(
                                        "clickhouse-destination".to_string(),
                                        vec!["my-processor-group".to_string()],
                                        "application_logs".to_string(),
                                        ObservabilityPipelineClickhouseDestinationType::CLICKHOUSE,
                                    )
                                        .auth(
                                            ObservabilityPipelineClickhouseDestinationAuth::new(
                                                ObservabilityPipelineClickhouseDestinationAuthStrategy::BASIC,
                                            )
                                                .password_key("CLICKHOUSE_PASSWORD".to_string())
                                                .username_key("CLICKHOUSE_USERNAME".to_string()),
                                        )
                                        .batch(
                                            ObservabilityPipelineClickhouseDestinationBatch::new()
                                                .max_events(1000)
                                                .timeout_secs(1),
                                        )
                                        .batch_encoding(
                                            ObservabilityPipelineClickhouseDestinationBatchEncoding::new(
                                                ObservabilityPipelineClickhouseDestinationBatchEncodingCodec
                                                ::ARROW_STREAM,
                                            ).allow_nullable_fields(false),
                                        )
                                        .compression(
                                            ObservabilityPipelineClickhouseDestinationCompression
                                            ::ObservabilityPipelineClickhouseDestinationCompressionAlgorithm(
                                                Box::new(
                                                    ObservabilityPipelineClickhouseDestinationCompressionAlgorithm
                                                    ::GZIP,
                                                ),
                                            ),
                                        )
                                        .database("my_database".to_string())
                                        .format(ObservabilityPipelineClickhouseDestinationFormat::ARROW_STREAM),
                                ),
                            )
                        ],
                        vec![
                            ObservabilityPipelineConfigSourceItem::ObservabilityPipelineDatadogAgentSource(
                                Box::new(
                                    ObservabilityPipelineDatadogAgentSource::new(
                                        "datadog-agent-source".to_string(),
                                        ObservabilityPipelineDatadogAgentSourceType::DATADOG_AGENT,
                                    ),
                                ),
                            )
                        ],
                    ).processor_groups(
                        vec![
                            ObservabilityPipelineConfigProcessorGroup::new(
                                true,
                                "my-processor-group".to_string(),
                                "service:my-service".to_string(),
                                vec!["datadog-agent-source".to_string()],
                                vec![
                                    ObservabilityPipelineConfigProcessorItem::ObservabilityPipelineFilterProcessor(
                                        Box::new(
                                            ObservabilityPipelineFilterProcessor::new(
                                                true,
                                                "filter-processor".to_string(),
                                                "status:error".to_string(),
                                                ObservabilityPipelineFilterProcessorType::FILTER,
                                            ),
                                        ),
                                    )
                                ],
                            )
                        ],
                    ),
                    "Pipeline with ClickHouse Destination Arrow Stream".to_string(),
                ),
                "pipelines".to_string(),
            ),
        );
    let configuration = datadog::Configuration::new();
    let api = ObservabilityPipelinesAPI::with_config(configuration);
    let resp = api.validate_pipeline(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Instructions

First install the library and its dependencies and then save the example to src/main.rs and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
 * Validate a metrics pipeline with opentelemetry source returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration({
  authMethods: {
    AuthZ: {
      accessToken: process.env.DD_BEARER_TOKEN as string,
    },
  },
});
const apiInstance = new v2.ObservabilityPipelinesApi(configuration);

const params: v2.ObservabilityPipelinesApiValidatePipelineRequest = {
  body: {
    data: {
      attributes: {
        config: {
          pipelineType: "metrics",
          destinations: [
            {
              id: "datadog-metrics-destination",
              inputs: ["my-processor-group"],
              type: "datadog_metrics",
            },
          ],
          processorGroups: [
            {
              enabled: true,
              id: "my-processor-group",
              include: "*",
              inputs: ["opentelemetry-source"],
              processors: [
                {
                  enabled: true,
                  id: "filter-processor",
                  include: "env:production",
                  type: "filter",
                },
              ],
            },
          ],
          sources: [
            {
              id: "opentelemetry-source",
              type: "opentelemetry",
            },
          ],
        },
        name: "Metrics OTel Pipeline",
      },
      type: "pipelines",
    },
  },
};

apiInstance
  .validatePipeline(params)
  .then((data: v2.ValidationResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

/**
 * Validate an observability pipeline returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration({
  authMethods: {
    AuthZ: {
      accessToken: process.env.DD_BEARER_TOKEN as string,
    },
  },
});
const apiInstance = new v2.ObservabilityPipelinesApi(configuration);

const params: v2.ObservabilityPipelinesApiValidatePipelineRequest = {
  body: {
    data: {
      attributes: {
        config: {
          destinations: [
            {
              id: "datadog-logs-destination",
              inputs: ["my-processor-group"],
              type: "datadog_logs",
            },
          ],
          processorGroups: [
            {
              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: "Main Observability Pipeline",
      },
      type: "pipelines",
    },
  },
};

apiInstance
  .validatePipeline(params)
  .then((data: v2.ValidationResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

/**
 * Validate an observability pipeline with ClickHouse destination arrow_stream format returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration({
  authMethods: {
    AuthZ: {
      accessToken: process.env.DD_BEARER_TOKEN as string,
    },
  },
});
const apiInstance = new v2.ObservabilityPipelinesApi(configuration);

const params: v2.ObservabilityPipelinesApiValidatePipelineRequest = {
  body: {
    data: {
      attributes: {
        config: {
          destinations: [
            {
              id: "clickhouse-destination",
              inputs: ["my-processor-group"],
              type: "clickhouse",
              table: "application_logs",
              database: "my_database",
              format: "arrow_stream",
              batchEncoding: {
                codec: "arrow_stream",
                allowNullableFields: false,
              },
              compression: "gzip",
              auth: {
                strategy: "basic",
                usernameKey: "CLICKHOUSE_USERNAME",
                passwordKey: "CLICKHOUSE_PASSWORD",
              },
              batch: {
                maxEvents: 1000,
                timeoutSecs: 1,
              },
            },
          ],
          processorGroups: [
            {
              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 ClickHouse Destination Arrow Stream",
      },
      type: "pipelines",
    },
  },
};

apiInstance
  .validatePipeline(params)
  .then((data: v2.ValidationResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

Instructions

First install the library and its dependencies and then save the example to example.ts and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"