Repository navigation
Expand file tree
/
Copy pathclickhouse.toml
More file actions
112 lines (94 loc) · 3.39 KB
/
Copy pathclickhouse.toml
File metadata and controls
112 lines (94 loc) · 3.39 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
[sinks.clickhouse]
title = "Clickhouse"
beta = true
common = true
delivery_guarantee = "best_effort"
function_category = "transmit"
healthcheck = true
egress_method = "batching"
input_types = ["log"]
min_version = "1.1.54378"
requirements = {}
write_to_description = "[Clickhouse][urls.clickhouse] via the [`HTTP` Interface][urls.clickhouse_http]"
<%= render("_partials/_component_options.toml", type: "sink", name: "clickhouse") %>
<%= render("_partials/_batch_options.toml", namespace: "sinks.clickhouse.options", common: false, max_events: nil, max_size: 1049000, timeout_secs: 1) %>
<%= render("_partials/_buffer_options.toml", namespace: "sinks.clickhouse.options") %>
<%= render(
"_partials/_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 = ["${PASSWORD_ENV_VAR}", "password"]
required = true
relevant_when = {strategy = "basic"}
description = "The basic authentication password."
[sinks.clickhouse.options.auth.children.user]
type = "string"
examples = ["${USERNAME_ENV_VAR}", "username"]
required = true
relevant_when = {strategy = "basic"}
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/_tls_connector_options.toml", namespace: "sinks.clickhouse.options", can_enable: false, can_verify: true) %>
[sinks.clickhouse.options.database]
type = "string"
common = true
examples = ["mydatabase"]
description = "The database that contains the stable that data will be inserted into."
[sinks.clickhouse.options.encoding]
type = "table"
common = true
required = false
description = "Customize how events are encoded."
[sinks.clickhouse.options.encoding.children.timestamp_format]
type = "string"
common = true
required = false
default = "rfc3339"
description = "How to format event timestamps. Formats such as unix can be parsed as a Clickhouse DateTime, however, this loses precision as DateTimes are defined in seconds."
[sinks.clickhouse.options.encoding.children.timestamp_format.enum]
rfc3339 = "Format as an RFC3339 string"
unix = "Format as a unix timestamp, can be parsed as a Clickhouse DateTime"