Skip to content

Commit 7db1e20

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 9f4994a of spec repo
1 parent c1f424a commit 7db1e20

21 files changed

Lines changed: 1495 additions & 0 deletions

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

Lines changed: 195 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63735,6 +63735,200 @@ components:
6373563735
x-enum-varnames:
6373663736
- BLOCK
6373763737
- DROP_NEWEST
63738+
ObservabilityPipelineClickhouseDestination:
63739+
description: |-
63740+
The `clickhouse` destination sends log events to a ClickHouse database table over HTTP.
63741+
63742+
**Supported pipeline types:** logs.
63743+
properties:
63744+
auth:
63745+
$ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationAuth"
63746+
batch:
63747+
$ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationBatch"
63748+
batch_encoding:
63749+
$ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationBatchEncoding"
63750+
compression:
63751+
$ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationCompression"
63752+
database:
63753+
description: Optional ClickHouse database name. When omitted, the user's default database on the ClickHouse server is used.
63754+
example: my_database
63755+
type: string
63756+
date_time_best_effort:
63757+
description: When `true`, enables flexible DateTime parsing on the ClickHouse server side.
63758+
example: false
63759+
type: boolean
63760+
endpoint_url_key:
63761+
description: |-
63762+
Name of the environment variable or secret that holds the ClickHouse HTTP endpoint URL.
63763+
Defaults to `DESTINATION_CLICKHOUSE_ENDPOINT_URL` (prefixed with `DD_OP_` at runtime).
63764+
example: CLICKHOUSE_ENDPOINT_URL
63765+
type: string
63766+
format:
63767+
$ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationFormat"
63768+
id:
63769+
description: The unique identifier for this component. Used to reference this component from other parts of the pipeline.
63770+
example: clickhouse-destination
63771+
type: string
63772+
inputs:
63773+
description: A list of component IDs whose output is used as the `input` for this component.
63774+
example: ["filter-processor"]
63775+
items:
63776+
description: The ID of a component whose output is used as input for this destination.
63777+
type: string
63778+
type: array
63779+
skip_unknown_fields:
63780+
description: |-
63781+
When `true`, fields not present in the target table schema are dropped instead of causing insert errors.
63782+
When unset, the ClickHouse server's own `input_format_skip_unknown_fields` setting applies.
63783+
example: true
63784+
nullable: true
63785+
type: boolean
63786+
table:
63787+
description: Target ClickHouse table name. Events are inserted into this table.
63788+
example: application_logs
63789+
type: string
63790+
tls:
63791+
$ref: "#/components/schemas/ObservabilityPipelineTls"
63792+
type:
63793+
$ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationType"
63794+
required:
63795+
- id
63796+
- type
63797+
- inputs
63798+
- table
63799+
type: object
63800+
x-pipeline-types: [logs]
63801+
ObservabilityPipelineClickhouseDestinationAuth:
63802+
description: |-
63803+
HTTP Basic Authentication credentials for the ClickHouse destination.
63804+
When `strategy` is `basic`, provide `username_key` and `password_key` referencing
63805+
environment variables or secrets that hold the credentials.
63806+
properties:
63807+
password_key:
63808+
description: Name of the environment variable or secret that holds the ClickHouse password.
63809+
example: CLICKHOUSE_PASSWORD
63810+
type: string
63811+
strategy:
63812+
$ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationAuthStrategy"
63813+
username_key:
63814+
description: Name of the environment variable or secret that holds the ClickHouse username.
63815+
example: CLICKHOUSE_USERNAME
63816+
type: string
63817+
required:
63818+
- strategy
63819+
type: object
63820+
ObservabilityPipelineClickhouseDestinationAuthStrategy:
63821+
description: The authentication strategy for ClickHouse HTTP requests. Only `basic` is supported.
63822+
enum:
63823+
- basic
63824+
example: basic
63825+
type: string
63826+
x-enum-varnames:
63827+
- BASIC
63828+
ObservabilityPipelineClickhouseDestinationBatch:
63829+
description: Batching configuration for ClickHouse inserts.
63830+
properties:
63831+
max_events:
63832+
description: Maximum number of events per batch before it is flushed.
63833+
example: 1000
63834+
format: int64
63835+
minimum: 1
63836+
type: integer
63837+
timeout_secs:
63838+
description: Maximum number of seconds to wait before flushing a partial batch.
63839+
example: 1
63840+
format: int64
63841+
maximum: 65535
63842+
minimum: 1
63843+
type: integer
63844+
type: object
63845+
ObservabilityPipelineClickhouseDestinationBatchEncoding:
63846+
description: |-
63847+
Batch encoding configuration for the ClickHouse destination.
63848+
Required when `format` is `arrow_stream`. The `codec` field must be set to `arrow_stream`.
63849+
properties:
63850+
allow_nullable_fields:
63851+
description: |-
63852+
When `true`, null values are allowed for non-nullable fields in the ClickHouse schema.
63853+
When `false` (default), missing values for non-nullable columns cause encoding errors.
63854+
example: false
63855+
type: boolean
63856+
codec:
63857+
$ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationBatchEncodingCodec"
63858+
required:
63859+
- codec
63860+
type: object
63861+
ObservabilityPipelineClickhouseDestinationBatchEncodingCodec:
63862+
description: The codec used for batch encoding. Only `arrow_stream` is supported.
63863+
enum:
63864+
- arrow_stream
63865+
example: arrow_stream
63866+
type: string
63867+
x-enum-varnames:
63868+
- ARROW_STREAM
63869+
ObservabilityPipelineClickhouseDestinationCompression:
63870+
description: |-
63871+
Compression setting for outbound HTTP requests to ClickHouse.
63872+
Can be specified as a shorthand string (`"gzip"` or `"none"`) or as an object
63873+
with an `algorithm` field and an optional `level` (gzip only, 1–9).
63874+
oneOf:
63875+
- $ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationCompressionAlgorithm"
63876+
- $ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationCompressionObject"
63877+
ObservabilityPipelineClickhouseDestinationCompressionAlgorithm:
63878+
description: The compression algorithm applied to outbound HTTP requests.
63879+
enum:
63880+
- gzip
63881+
- none
63882+
example: gzip
63883+
type: string
63884+
x-enum-varnames:
63885+
- GZIP
63886+
- NONE
63887+
ObservabilityPipelineClickhouseDestinationCompressionObject:
63888+
description: |-
63889+
Structured compression configuration for the ClickHouse destination.
63890+
Use `algorithm` to specify the compression type and `level` (optional, gzip only) to control compression strength.
63891+
properties:
63892+
algorithm:
63893+
$ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationCompressionAlgorithm"
63894+
level:
63895+
description: Compression level (1–9). Only applicable when `algorithm` is `gzip`.
63896+
example: 6
63897+
format: int64
63898+
maximum: 9
63899+
minimum: 1
63900+
type: integer
63901+
required:
63902+
- algorithm
63903+
type: object
63904+
ObservabilityPipelineClickhouseDestinationFormat:
63905+
description: |-
63906+
Insert format for events sent to ClickHouse.
63907+
- `json_each_row`: Maps event fields to columns by name (ClickHouse `JSONEachRow`).
63908+
- `json_as_object`: Inserts each event into a single `Object('json')` / `JSON` column (ClickHouse `JSONAsObject`).
63909+
- `json_as_string`: Inserts each event into a single `String`-typed column as raw JSON (ClickHouse `JSONAsString`).
63910+
- `arrow_stream`: Batches events using Apache Arrow IPC streaming format. Requires `batch_encoding`.
63911+
enum:
63912+
- json_each_row
63913+
- json_as_object
63914+
- json_as_string
63915+
- arrow_stream
63916+
example: json_each_row
63917+
type: string
63918+
x-enum-varnames:
63919+
- JSON_EACH_ROW
63920+
- JSON_AS_OBJECT
63921+
- JSON_AS_STRING
63922+
- ARROW_STREAM
63923+
ObservabilityPipelineClickhouseDestinationType:
63924+
default: clickhouse
63925+
description: The destination type. The value must be `clickhouse`.
63926+
enum:
63927+
- clickhouse
63928+
example: clickhouse
63929+
type: string
63930+
x-enum-varnames:
63931+
- CLICKHOUSE
6373863932
ObservabilityPipelineCloudPremDestination:
6373963933
description: |-
6374063934
The `cloud_prem` destination sends logs to Datadog CloudPrem.
@@ -63834,6 +64028,7 @@ components:
6383464028
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericDestination"
6383564029
- $ref: "#/components/schemas/ObservabilityPipelineAmazonSecurityLakeDestination"
6383664030
- $ref: "#/components/schemas/AzureStorageDestination"
64031+
- $ref: "#/components/schemas/ObservabilityPipelineClickhouseDestination"
6383764032
- $ref: "#/components/schemas/ObservabilityPipelineCloudPremDestination"
6383864033
- $ref: "#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestination"
6383964034
- $ref: "#/components/schemas/ObservabilityPipelineDatadogLogsDestination"

‎cassettes/features/v2/observability_pipelines/Validate-an-observability-pipeline-with-ClickHouse-destination-arrow-stream-format-returns-OK-response.frozen‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2026-06-22T20:44:30.778Z

‎cassettes/features/v2/observability_pipelines/Validate-an-observability-pipeline-with-ClickHouse-destination-arrow-stream-format-returns-OK-response.yml‎

Lines changed: 27 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎cassettes/features/v2/observability_pipelines/Validate-an-observability-pipeline-with-ClickHouse-destination-returns-OK-response.frozen‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2026-06-22T20:44:32.514Z

‎cassettes/features/v2/observability_pipelines/Validate-an-observability-pipeline-with-ClickHouse-destination-returns-OK-response.yml‎

Lines changed: 27 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎examples/v2/observability-pipelines/ValidatePipeline_1238441879.rb‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Validate an observability pipeline with ClickHouse destination returns "OK" response
2+
3+
require "datadog_api_client"
4+
api_instance = DatadogAPIClient::V2::ObservabilityPipelinesAPI.new
5+
6+
body = DatadogAPIClient::V2::ObservabilityPipelineSpec.new({
7+
data: DatadogAPIClient::V2::ObservabilityPipelineSpecData.new({
8+
attributes: DatadogAPIClient::V2::ObservabilityPipelineDataAttributes.new({
9+
config: DatadogAPIClient::V2::ObservabilityPipelineConfig.new({
10+
destinations: [
11+
DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestination.new({
12+
id: "clickhouse-destination",
13+
inputs: [
14+
"my-processor-group",
15+
],
16+
type: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationType::CLICKHOUSE,
17+
table: "application_logs",
18+
database: "my_database",
19+
compression: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationCompressionAlgorithm::GZIP,
20+
auth: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationAuth.new({
21+
strategy: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationAuthStrategy::BASIC,
22+
username_key: "CLICKHOUSE_USERNAME",
23+
password_key: "CLICKHOUSE_PASSWORD",
24+
}),
25+
batch: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationBatch.new({
26+
max_events: 1000,
27+
timeout_secs: 1,
28+
}),
29+
}),
30+
],
31+
processor_groups: [
32+
DatadogAPIClient::V2::ObservabilityPipelineConfigProcessorGroup.new({
33+
enabled: true,
34+
id: "my-processor-group",
35+
include: "service:my-service",
36+
inputs: [
37+
"datadog-agent-source",
38+
],
39+
processors: [
40+
DatadogAPIClient::V2::ObservabilityPipelineFilterProcessor.new({
41+
enabled: true,
42+
id: "filter-processor",
43+
include: "status:error",
44+
type: DatadogAPIClient::V2::ObservabilityPipelineFilterProcessorType::FILTER,
45+
}),
46+
],
47+
}),
48+
],
49+
sources: [
50+
DatadogAPIClient::V2::ObservabilityPipelineDatadogAgentSource.new({
51+
id: "datadog-agent-source",
52+
type: DatadogAPIClient::V2::ObservabilityPipelineDatadogAgentSourceType::DATADOG_AGENT,
53+
}),
54+
],
55+
}),
56+
name: "Pipeline with ClickHouse Destination",
57+
}),
58+
type: "pipelines",
59+
}),
60+
})
61+
p api_instance.validate_pipeline(body)

‎examples/v2/observability-pipelines/ValidatePipeline_620504950.rb‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Validate an observability pipeline with ClickHouse destination arrow_stream format returns "OK" response
2+
3+
require "datadog_api_client"
4+
api_instance = DatadogAPIClient::V2::ObservabilityPipelinesAPI.new
5+
6+
body = DatadogAPIClient::V2::ObservabilityPipelineSpec.new({
7+
data: DatadogAPIClient::V2::ObservabilityPipelineSpecData.new({
8+
attributes: DatadogAPIClient::V2::ObservabilityPipelineDataAttributes.new({
9+
config: DatadogAPIClient::V2::ObservabilityPipelineConfig.new({
10+
destinations: [
11+
DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestination.new({
12+
id: "clickhouse-destination",
13+
inputs: [
14+
"my-processor-group",
15+
],
16+
type: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationType::CLICKHOUSE,
17+
table: "application_logs",
18+
database: "my_database",
19+
format: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationFormat::ARROW_STREAM,
20+
batch_encoding: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationBatchEncoding.new({
21+
codec: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationBatchEncodingCodec::ARROW_STREAM,
22+
allow_nullable_fields: false,
23+
}),
24+
compression: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationCompressionAlgorithm::GZIP,
25+
auth: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationAuth.new({
26+
strategy: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationAuthStrategy::BASIC,
27+
username_key: "CLICKHOUSE_USERNAME",
28+
password_key: "CLICKHOUSE_PASSWORD",
29+
}),
30+
batch: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestinationBatch.new({
31+
max_events: 1000,
32+
timeout_secs: 1,
33+
}),
34+
}),
35+
],
36+
processor_groups: [
37+
DatadogAPIClient::V2::ObservabilityPipelineConfigProcessorGroup.new({
38+
enabled: true,
39+
id: "my-processor-group",
40+
include: "service:my-service",
41+
inputs: [
42+
"datadog-agent-source",
43+
],
44+
processors: [
45+
DatadogAPIClient::V2::ObservabilityPipelineFilterProcessor.new({
46+
enabled: true,
47+
id: "filter-processor",
48+
include: "status:error",
49+
type: DatadogAPIClient::V2::ObservabilityPipelineFilterProcessorType::FILTER,
50+
}),
51+
],
52+
}),
53+
],
54+
sources: [
55+
DatadogAPIClient::V2::ObservabilityPipelineDatadogAgentSource.new({
56+
id: "datadog-agent-source",
57+
type: DatadogAPIClient::V2::ObservabilityPipelineDatadogAgentSourceType::DATADOG_AGENT,
58+
}),
59+
],
60+
}),
61+
name: "Pipeline with ClickHouse Destination Arrow Stream",
62+
}),
63+
type: "pipelines",
64+
}),
65+
})
66+
p api_instance.validate_pipeline(body)

0 commit comments

Comments
 (0)