Skip to content

Commit 705cac3

Browse files
ElderMaelatoulmesongy23
authored
docs(clickhouseexporter): add examples of missing DDL tables (#35903)
#### Description Add Missing Examples Of DDL For Clickhouse Exporter #### Testing N/A #### Documentation Added two files with the example DDL of two tables: `otel_metrics_exponential_histogram` and `otel_metrics_gauge`. These were not in the examples but they are indeed created by the exporter. This was confusing as we do manage our own schema. The docs had incomplete examples. See https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/clickhouseexporter#schema-management --------- Co-authored-by: Antoine Toulme <[email protected]> Co-authored-by: Antoine Toulme <[email protected]> Co-authored-by: Yang Song <[email protected]>
1 parent 23f6622 commit 705cac3

File tree

3 files changed

+105
-0
lines changed

3 files changed

+105
-0
lines changed

‎.chloggen/clickhouse_examples.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: enhancement
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
7+
component: exporter/clickhouse
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: Adding missing examples of DDL created by the clickhouse exporter
11+
12+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
13+
issues: [35903]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext:
19+
20+
# If your change doesn't affect end users or the exported elements of any package,
21+
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
22+
# Optional: The change log or logs in which this entry should be included.
23+
# e.g. '[user]' or '[user, api]'
24+
# Include 'user' if the change is relevant to end users.
25+
# Include 'api' if there is a change to a library API.
26+
# Default: '[user]'
27+
change_logs: []

‎exporter/clickhouseexporter/example/default_ddl/exponential_histogram.sql

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
CREATE TABLE IF NOT EXISTS otel_metrics_exponential_histogram
2+
(
3+
ResourceAttributes Map(LowCardinality(String), String) CODEC (ZSTD(1)),
4+
ResourceSchemaUrl String CODEC (ZSTD(1)),
5+
ScopeName String CODEC (ZSTD(1)),
6+
ScopeVersion String CODEC (ZSTD(1)),
7+
ScopeAttributes Map(LowCardinality(String), String) CODEC (ZSTD(1)),
8+
ScopeDroppedAttrCount UInt32 CODEC (ZSTD(1)),
9+
ScopeSchemaUrl String CODEC (ZSTD(1)),
10+
ServiceName LowCardinality(String) CODEC (ZSTD(1)),
11+
MetricName String CODEC (ZSTD(1)),
12+
MetricDescription String CODEC (ZSTD(1)),
13+
MetricUnit String CODEC (ZSTD(1)),
14+
Attributes Map(LowCardinality(String), String) CODEC (ZSTD(1)),
15+
StartTimeUnix DateTime64(9) CODEC (Delta, ZSTD(1)),
16+
TimeUnix DateTime64(9) CODEC (Delta, ZSTD(1)),
17+
Count UInt64 CODEC (Delta, ZSTD(1)),
18+
Sum Float64 CODEC (ZSTD(1)),
19+
Scale Int32 CODEC (ZSTD(1)),
20+
ZeroCount UInt64 CODEC (ZSTD(1)),
21+
PositiveOffset Int32 CODEC (ZSTD(1)),
22+
PositiveBucketCounts Array(UInt64) CODEC (ZSTD(1)),
23+
NegativeOffset Int32 CODEC (ZSTD(1)),
24+
NegativeBucketCounts Array(UInt64) CODEC (ZSTD(1)),
25+
Exemplars Nested(FilteredAttributes Map(LowCardinality(String), String),
26+
TimeUnix DateTime64(9),
27+
Value Float64,
28+
SpanId String,
29+
TraceId String) CODEC (ZSTD(1)),
30+
Flags UInt32 CODEC (ZSTD(1)),
31+
Min Float64 CODEC (ZSTD(1)),
32+
Max Float64 CODEC (ZSTD(1)),
33+
AggregationTemporality Int32 CODEC (ZSTD(1)),
34+
INDEX idx_res_attr_key mapKeys(ResourceAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
35+
INDEX idx_res_attr_value mapValues(ResourceAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
36+
INDEX idx_scope_attr_key mapKeys(ScopeAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
37+
INDEX idx_scope_attr_value mapValues(ScopeAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
38+
INDEX idx_attr_key mapKeys(Attributes) TYPE bloom_filter(0.01) GRANULARITY 1,
39+
INDEX idx_attr_value mapValues(Attributes) TYPE bloom_filter(0.01) GRANULARITY 1
40+
) ENGINE = MergeTree
41+
TTL toDateTime(TimeUnix) + toIntervalDay(180)
42+
PARTITION BY toDate(TimeUnix)
43+
ORDER BY (ServiceName, MetricName, Attributes, toUnixTimestamp64Nano(TimeUnix))
44+
SETTINGS index_granularity = 8192, ttl_only_drop_parts = 1;

‎exporter/clickhouseexporter/example/default_ddl/metrics_gauge.sql

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
CREATE TABLE IF NOT EXISTS otel_metrics_gauge
2+
(
3+
ResourceAttributes Map(LowCardinality(String), String) CODEC (ZSTD(1)),
4+
ResourceSchemaUrl String CODEC (ZSTD(1)),
5+
ScopeName String CODEC (ZSTD(1)),
6+
ScopeVersion String CODEC (ZSTD(1)),
7+
ScopeAttributes Map(LowCardinality(String), String) CODEC (ZSTD(1)),
8+
ScopeDroppedAttrCount UInt32 CODEC (ZSTD(1)),
9+
ScopeSchemaUrl String CODEC (ZSTD(1)),
10+
ServiceName LowCardinality(String) CODEC (ZSTD(1)),
11+
MetricName String CODEC (ZSTD(1)),
12+
MetricDescription String CODEC (ZSTD(1)),
13+
MetricUnit String CODEC (ZSTD(1)),
14+
Attributes Map(LowCardinality(String), String) CODEC (ZSTD(1)),
15+
StartTimeUnix DateTime64(9) CODEC (Delta, ZSTD(1)),
16+
TimeUnix DateTime64(9) CODEC (Delta, ZSTD(1)),
17+
Value Float64 CODEC (ZSTD(1)),
18+
Flags UInt32 CODEC (ZSTD(1)),
19+
Exemplars Nested(FilteredAttributes Map(LowCardinality(String), String),
20+
TimeUnix DateTime64(9),
21+
Value Float64,
22+
SpanId String,
23+
TraceId String) CODEC (ZSTD(1)),
24+
INDEX idx_res_attr_key mapKeys(ResourceAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
25+
INDEX idx_res_attr_value mapValues(ResourceAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
26+
INDEX idx_scope_attr_key mapKeys(ScopeAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
27+
INDEX idx_scope_attr_value mapValues(ScopeAttributes) TYPE bloom_filter(0.01) GRANULARITY 1,
28+
INDEX idx_attr_key mapKeys(Attributes) TYPE bloom_filter(0.01) GRANULARITY 1,
29+
INDEX idx_attr_value mapValues(Attributes) TYPE bloom_filter(0.01) GRANULARITY 1
30+
) ENGINE = MergeTree
31+
PARTITION BY toDate(TimeUnix)
32+
ORDER BY (ServiceName, MetricName, Attributes, toUnixTimestamp64Nano(TimeUnix))
33+
TTL toDateTime(TimeUnix) + toIntervalDay(180)
34+
SETTINGS index_granularity = 8192, ttl_only_drop_parts = 1;

0 commit comments

Comments
 (0)