Repository navigation
Expand file tree
/
Copy pathclickhouse.toml
More file actions
128 lines (112 loc) · 3.83 KB
/
Copy pathclickhouse.toml
File metadata and controls
128 lines (112 loc) · 3.83 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
[sinks.clickhouse]
title = "Clickhouse"
noun = "Clickhouse"
beta = true
common = true
delivery_guarantee = "at_least_once"
descriptioon = """\
[ClickHouse][urls.clickhouse] is an open-source column-oriented database \
management system that manages extremely large volumes of data, including \
non-aggregated data, in a stable and sustainable manner and allows generating \
custom data reports in real time. The system is linearly scalable and can be \
scaled up to store and process trillions of rows and petabytes of data. This \
makes it an best-in-class storage for logs and metrics data.\
"""
features = [
"Send logs to ClickHouse.",
"Compress and batch data to maximize throughput.",
"Encode timestamps to ClickHouse supported formats.",
"Automatically retry failed requests, with backoff.",
"Buffer your data in-memory or on-disk for performance and durability.",
]
function_category = "transmit"
healthcheck = true
egress_method = "batching"
input_types = ["log"]
requirements.clickhouse = ">= 1.1.54378"
service_providers = ["Yandex"]
write_to_description = "[Clickhouse][urls.clickhouse] via the [`HTTP` Interface][urls.clickhouse_http]"
<%= render("_partials/fields/_component_options.toml", type: "sink", name: "clickhouse") %>
<%= render("_partials/fields/_batch_options.toml", namespace: "sinks.clickhouse.options", common: false, max_events: nil, max_size: 1049000, timeout_secs: 1) %>
<%= render(
"_partials/fields/_buffer_options.toml",
namespace: "sinks.clickhouse.options",
common: false
) %>
<%= render(
"_partials/fields/_request_options.toml",
namespace: "sinks.clickhouse.options",
common: false,
in_flight_limit: 5,
rate_limit_duration_secs: 1,
rate_limit_num: 5,
retry_attempts: -1,
retry_initial_backoff_secs: 1,
retry_max_duration_secs: 10,
timeout_secs: 30
) %>
[sinks.clickhouse.options.auth]
type = "table"
common = false
description = "Options for the authentication strategy."
[sinks.clickhouse.options.auth.children.strategy]
type = "string"
required = true
sort = 1
description = "The authentication strategy to use."
[sinks.clickhouse.options.auth.children.strategy.enum]
basic = "The [basic authentication strategy][urls.basic_auth]."
[sinks.clickhouse.options.auth.children.password]
type = "string"
examples = ["${CLICKHOUSE_PASSWORD}", "password"]
relevant_when = {strategy = "basic"}
required = true
description = "The basic authentication password."
[sinks.clickhouse.options.auth.children.user]
type = "string"
examples = ["${CLICKHOUSE_USERNAME}", "username"]
relevant_when = {strategy = "basic"}
required = true
description = "The basic authentication user name."
[sinks.clickhouse.options.compression]
type = "string"
category = "requests"
common = true
default = "none"
description = """\
The compression strategy used to compress the encoded event data before \
outputting.\
"""
[sinks.clickhouse.options.compression.enum]
none = "The payload will not be compressed."
gzip = "The payload will be compressed in [Gzip][urls.gzip] format before being sent."
[sinks.clickhouse.options.host]
type = "string"
common = true
examples = ["http://localhost:8123"]
required = true
description = "The host url of the [Clickhouse][urls.clickhouse] server."
[sinks.clickhouse.options.table]
type = "string"
common = true
examples = ["mytable"]
required = true
description = "The table that data will be inserted into."
<%= render(
"_partials/fields/_tls_connector_options.toml",
namespace: "sinks.clickhouse.options",
can_enable: false,
can_verify_certificate: true,
can_verify_hostname: true
) %>
[sinks.clickhouse.options.database]
type = "string"
common = true
examples = ["mydatabase"]
description = "The database that contains the stable that data will be inserted into."
<%= render(
"_partials/fields/_encoding_options.toml",
namespace: "sinks.clickhouse.options",
encodings: [],
common: ["timestamp_format"]
) %>