Class: DatadogAPIClient::V2::ObservabilityPipelineClickhouseDestination

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v2/models/observability_pipeline_clickhouse_destination.rb

Overview

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

Supported pipeline types: logs.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



81
82
83
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_clickhouse_destination.rb', line 81

def additional_properties
  @additional_properties
end

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



28
29
30
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_clickhouse_destination.rb', line 28

def auth
  @auth
end

#batch ⇒ Object

Batching configuration for ClickHouse inserts.



31
32
33
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_clickhouse_destination.rb', line 31

def batch
  @batch
end

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



35
36
37
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_clickhouse_destination.rb', line 35

def batch_encoding
  @batch_encoding
end

#buffer ⇒ Object

Configuration for buffer settings on destination components.



38
39
40
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_clickhouse_destination.rb', line 38

def buffer
  @buffer
end

#compression ⇒ Object

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



43
44
45
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_clickhouse_destination.rb', line 43

def compression
  @compression
end

#database ⇒ Object

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



46
47
48
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_clickhouse_destination.rb', line 46

def database
  @database
end

#date_time_best_effort ⇒ Object

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



49
50
51
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_clickhouse_destination.rb', line 49

def date_time_best_effort
  @date_time_best_effort
end

#endpoint_url_key ⇒ Object

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



53
54
55
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_clickhouse_destination.rb', line 53

def endpoint_url_key
  @endpoint_url_key
end

#format ⇒ Object

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.


60
61
62
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_clickhouse_destination.rb', line 60

def format
  @format
end

#id ⇒ Object

The unique identifier for this component.



63
64
65
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_clickhouse_destination.rb', line 63

def id
  @id
end

#inputs ⇒ Object

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



66
67
68
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_clickhouse_destination.rb', line 66

def inputs
  @inputs
end

#skip_unknown_fields ⇒ Object

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.



70
71
72
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_clickhouse_destination.rb', line 70

def skip_unknown_fields
  @skip_unknown_fields
end

#table ⇒ Object

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



73
74
75
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_clickhouse_destination.rb', line 73

def table
  @table
end

#tls ⇒ Object

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



76
77
78
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_clickhouse_destination.rb', line 76

def tls
  @tls
end

#type ⇒ Object

The destination type. The value must be clickhouse.



79
80
81
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_clickhouse_destination.rb', line 79

def type
  @type
end