Skip to content

Commit 6d0960e

Browse files
author
Oleksandr Kostenko
committed
Add readme entry.
1 parent d08f668 commit 6d0960e

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

exporter/clickhouseexporter/README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<!-- end autogenerated section -->
1414

1515

16-
This exporter supports sending OpenTelemetry data to [ClickHouse](https://clickhouse.com/).
16+
This exporter supports sending OpenTelemetry data to [ClickHouse](https://clickhouse.com/).
1717
> ClickHouse is an open-source, high performance columnar OLAP database management system for real-time analytics using
1818
> SQL.
1919
> Throughput can be measured in rows per second or megabytes per second.
@@ -302,6 +302,18 @@ Processing:
302302
- `max_elapsed_time` (default = 300s): The maximum amount of time spent trying to send a batch; ignored if `enabled`
303303
is `false`
304304

305+
Cluster definition:
306+
307+
- `cluster_name` (default = ): The cluster name allows to create database or table on cluster. When set '`ON CLUSTER cluster_name`' string is present in creation query.
308+
309+
Table engine:
310+
311+
- `table_engine`
312+
- `name` (default = MergeTree)
313+
- `params` (default = )
314+
315+
Modifies `ENGINE` definition when table is created. If not set then `ENGINE` defaults to `MergeTree` Combined with `cluster_name` allows to implement [replication for fault tolerance scenario](https://clickhouse.com/docs/en/architecture/replication).
316+
305317
## TLS
306318

307319
The exporter supports TLS. To enable TLS, you need to specify the `secure=true` query parameter in the `endpoint` URL or
@@ -334,6 +346,10 @@ exporters:
334346
initial_interval: 5s
335347
max_interval: 30s
336348
max_elapsed_time: 300s
349+
# Uncomment if there is a need for replication accross cluster instances
350+
# table_engine:
351+
# name: ReplicatedMergeTree
352+
# cluster_name: my_cluster
337353
service:
338354
pipelines:
339355
logs:

0 commit comments

Comments
 (0)