Class ObservabilityPipelineClickhouseDestination

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

Supported pipeline types: logs.

Hierarchy

  • ObservabilityPipelineClickhouseDestination

Constructors

constructor

Properties

additionalProperties? auth? batch? batchEncoding? buffer? compression? database? dateTimeBestEffort? endpointUrlKey? format? id inputs skipUnknownFields? table tls? type

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional auth

auth?: ObservabilityPipelineClickhouseDestinationAuth

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.

Optional batch

batch?: ObservabilityPipelineClickhouseDestinationBatch

Batching configuration for ClickHouse inserts.

Optional batchEncoding

batchEncoding?: ObservabilityPipelineClickhouseDestinationBatchEncoding

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

Optional buffer

buffer?: ObservabilityPipelineBufferOptions

Configuration for buffer settings on destination components.

Optional compression

compression?: ObservabilityPipelineClickhouseDestinationCompression

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

Optional database

database?: string

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

Optional dateTimeBestEffort

dateTimeBestEffort?: boolean

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

Optional endpointUrlKey

endpointUrlKey?: 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).

Optional format

format?: ObservabilityPipelineClickhouseDestinationFormat

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.

id

id: string

The unique identifier for this component.

inputs

inputs: string[]

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

Optional skipUnknownFields

skipUnknownFields?: 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

table: string

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

Optional tls

tls?: ObservabilityPipelineTls

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

type

type: ObservabilityPipelineClickhouseDestinationType

The destination type. The value must be clickhouse.

Settings

Member Visibility

Theme

Generated using TypeDoc