Skip to content

Commit e9c05ef

Browse files
wrn14897wrn14897
committed
refactor: deprecate clickhouse.json feature gate in favor of per-exporter json config
Replace the deprecated --feature-gates=clickhouse.json CLI flag with the per-exporter json: true config option, as recommended by the upstream OpenTelemetry ClickHouse exporter (v0.149.0). The old OTEL_AGENT_FEATURE_GATE_ARG env var is still supported for other feature gates. When it contains clickhouse.json, the entrypoint strips that specific gate, maps it to HYPERDX_OTEL_EXPORTER_CLICKHOUSE_JSON_ENABLE=true, and prints a deprecation warning. Any remaining feature gates are preserved and passed through to the collector binary as before. Changes: - Add HYPERDX_OTEL_EXPORTER_CLICKHOUSE_JSON_ENABLE env var as the new canonical config - Add json field to ClickHouse exporter configs in opampController.ts - Add json field to standalone config (config.standalone.yaml) - Strip clickhouse.json from OTEL_AGENT_FEATURE_GATE_ARG with deprecation warning, preserving other feature gates - Add smoke tests for JSON exporter: column type verification and data insertion Ref: HDX-3994
1 parent 6e9a553 commit e9c05ef

12 files changed

Lines changed: 173 additions & 3 deletions

File tree

‎docker/otel-collector/config.standalone.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ exporters:
3333
logs_table_name: hyperdx_sessions
3434
timeout: 5s
3535
create_schema: ${env:HYPERDX_OTEL_EXPORTER_CREATE_LEGACY_SCHEMA:-false}
36+
json: ${env:HYPERDX_OTEL_EXPORTER_CLICKHOUSE_JSON_ENABLE:-false}
3637
retry_on_failure:
3738
enabled: true
3839
initial_interval: 5s
@@ -46,6 +47,7 @@ exporters:
4647
ttl: 720h
4748
timeout: 5s
4849
create_schema: ${env:HYPERDX_OTEL_EXPORTER_CREATE_LEGACY_SCHEMA:-false}
50+
json: ${env:HYPERDX_OTEL_EXPORTER_CLICKHOUSE_JSON_ENABLE:-false}
4951
retry_on_failure:
5052
enabled: true
5153
initial_interval: 5s

‎docker/otel-collector/entrypoint.sh‎

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,26 @@
11
#!/bin/sh
22
set -e
33

4-
# Fall back to legacy schema when the ClickHouse JSON feature gate is enabled
4+
# DEPRECATED: The clickhouse.json feature gate has been removed upstream.
5+
# When OTEL_AGENT_FEATURE_GATE_ARG contains clickhouse.json, strip it and
6+
# map it to HYPERDX_OTEL_EXPORTER_CLICKHOUSE_JSON_ENABLE instead. Other feature gates
7+
# are preserved and passed through to the collector.
58
if echo "$OTEL_AGENT_FEATURE_GATE_ARG" | grep -q "clickhouse.json"; then
9+
echo "WARNING: '--feature-gates=clickhouse.json' is deprecated and no longer supported by the collector."
10+
echo "WARNING: Use HYPERDX_OTEL_EXPORTER_CLICKHOUSE_JSON_ENABLE=true instead. This flag will be removed in a future release."
11+
export HYPERDX_OTEL_EXPORTER_CLICKHOUSE_JSON_ENABLE=true
12+
13+
# Strip clickhouse.json from the feature gates, keeping any other gates
14+
REMAINING_GATES=$(echo "$OTEL_AGENT_FEATURE_GATE_ARG" | sed 's/--feature-gates=//' | tr ',' '\n' | grep -v 'clickhouse.json' | tr '\n' ',' | sed 's/,$//')
15+
if [ -n "$REMAINING_GATES" ]; then
16+
export OTEL_AGENT_FEATURE_GATE_ARG="--feature-gates=$REMAINING_GATES"
17+
else
18+
unset OTEL_AGENT_FEATURE_GATE_ARG
19+
fi
20+
fi
21+
22+
# Fall back to legacy schema when ClickHouse JSON exporter mode is enabled
23+
if [ "$HYPERDX_OTEL_EXPORTER_CLICKHOUSE_JSON_ENABLE" = "true" ]; then
624
export HYPERDX_OTEL_EXPORTER_CREATE_LEGACY_SCHEMA=true
725
fi
826

@@ -39,7 +57,7 @@ if [ -z "$OPAMP_SERVER_URL" ]; then
3957
COLLECTOR_ARGS="$COLLECTOR_ARGS --config $CUSTOM_OTELCOL_CONFIG_FILE"
4058
fi
4159

42-
# Pass feature gates to the collector in standalone mode
60+
# Pass remaining feature gates to the collector in standalone mode
4361
if [ -n "$OTEL_AGENT_FEATURE_GATE_ARG" ]; then
4462
COLLECTOR_ARGS="$COLLECTOR_ARGS $OTEL_AGENT_FEATURE_GATE_ARG"
4563
fi

‎docker/otel-collector/supervisor_docker.yaml.tmpl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ agent:
2323
{{- if getenv "CUSTOM_OTELCOL_CONFIG_FILE" }}
2424
- {{ getenv "CUSTOM_OTELCOL_CONFIG_FILE" }}
2525
{{- end }}
26-
args:
2726
{{- if getenv "OTEL_AGENT_FEATURE_GATE_ARG" }}
27+
args:
2828
- {{ getenv "OTEL_AGENT_FEATURE_GATE_ARG" }}
2929
{{- end }}
3030

‎packages/api/src/opamp/controllers/opampController.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ type CollectorConfig = {
8282
logs_table_name: string;
8383
timeout: string;
8484
create_schema: string;
85+
json: string;
8586
retry_on_failure: {
8687
enabled: boolean;
8788
initial_interval: string;
@@ -97,6 +98,7 @@ type CollectorConfig = {
9798
ttl: string;
9899
timeout: string;
99100
create_schema: string;
101+
json: string;
100102
retry_on_failure: {
101103
enabled: boolean;
102104
initial_interval: string;
@@ -205,6 +207,7 @@ export const buildOtelCollectorConfig = (
205207
timeout: '5s',
206208
create_schema:
207209
'${env:HYPERDX_OTEL_EXPORTER_CREATE_LEGACY_SCHEMA:-false}',
210+
json: '${env:HYPERDX_OTEL_EXPORTER_CLICKHOUSE_JSON_ENABLE:-false}',
208211
retry_on_failure: {
209212
enabled: true,
210213
initial_interval: '5s',
@@ -221,6 +224,7 @@ export const buildOtelCollectorConfig = (
221224
timeout: '5s',
222225
create_schema:
223226
'${env:HYPERDX_OTEL_EXPORTER_CREATE_LEGACY_SCHEMA:-false}',
227+
json: '${env:HYPERDX_OTEL_EXPORTER_CLICKHOUSE_JSON_ENABLE:-false}',
224228
retry_on_failure: {
225229
enabled: true,
226230
initial_interval: '5s',

‎smoke-tests/otel-collector/data/json-exporter/basic-insert/assert_query.sql‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
SELECT
2+
Body,
3+
toString(LogAttributes.`user.id`),
4+
toString(LogAttributes.`request.method`),
5+
toString(LogAttributes.`http.status_code`),
6+
toString(LogAttributes.error)
7+
FROM otel_json.otel_logs
8+
WHERE toString(ResourceAttributes.`suite-id`) = 'json-exporter'
9+
AND toString(ResourceAttributes.`test-id`) = 'basic-insert'
10+
ORDER BY Timestamp
11+
FORMAT CSV

‎smoke-tests/otel-collector/data/json-exporter/basic-insert/expected.snap‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
"JSON exporter log with string attributes","user-123","GET","",""
2+
"JSON exporter log with integer attribute","","","200",""
3+
"JSON exporter log with boolean attribute","","","","false"

‎smoke-tests/otel-collector/data/json-exporter/basic-insert/input.json‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
{
2+
"resourceLogs": [
3+
{
4+
"resource": {
5+
"attributes": [
6+
{
7+
"key": "suite-id",
8+
"value": {
9+
"stringValue": "json-exporter"
10+
}
11+
},
12+
{
13+
"key": "test-id",
14+
"value": {
15+
"stringValue": "basic-insert"
16+
}
17+
},
18+
{
19+
"key": "service.name",
20+
"value": {
21+
"stringValue": "test-service"
22+
}
23+
}
24+
]
25+
},
26+
"scopeLogs": [
27+
{
28+
"scope": {},
29+
"logRecords": [
30+
{
31+
"timeUnixNano": "1901999590000000000",
32+
"body": {
33+
"stringValue": "JSON exporter log with string attributes"
34+
},
35+
"attributes": [
36+
{
37+
"key": "user.id",
38+
"value": {
39+
"stringValue": "user-123"
40+
}
41+
},
42+
{
43+
"key": "request.method",
44+
"value": {
45+
"stringValue": "GET"
46+
}
47+
}
48+
]
49+
},
50+
{
51+
"timeUnixNano": "1901999590000000001",
52+
"body": {
53+
"stringValue": "JSON exporter log with integer attribute"
54+
},
55+
"attributes": [
56+
{
57+
"key": "http.status_code",
58+
"value": {
59+
"intValue": "200"
60+
}
61+
}
62+
]
63+
},
64+
{
65+
"timeUnixNano": "1901999590000000002",
66+
"body": {
67+
"stringValue": "JSON exporter log with boolean attribute"
68+
},
69+
"attributes": [
70+
{
71+
"key": "error",
72+
"value": {
73+
"boolValue": false
74+
}
75+
}
76+
]
77+
}
78+
]
79+
}
80+
]
81+
}
82+
]
83+
}

‎smoke-tests/otel-collector/data/json-exporter/column-types/assert_query.sql‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
SELECT name, type
2+
FROM system.columns
3+
WHERE database = 'otel_json'
4+
AND table = 'otel_logs'
5+
AND name IN ('ResourceAttributes', 'LogAttributes')
6+
ORDER BY name
7+
FORMAT CSV

‎smoke-tests/otel-collector/data/json-exporter/column-types/expected.snap‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
"LogAttributes","JSON"
2+
"ResourceAttributes","JSON"

‎smoke-tests/otel-collector/docker-compose.yaml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,31 @@ services:
4343
ch-server:
4444
condition: service_healthy
4545

46+
otel-collector-json:
47+
build:
48+
context: ../..
49+
dockerfile: docker/otel-collector/Dockerfile
50+
target: dev
51+
args:
52+
OTEL_COLLECTOR_VERSION: ${OTEL_COLLECTOR_VERSION:-0.149.0}
53+
OTEL_COLLECTOR_CORE_VERSION: ${OTEL_COLLECTOR_CORE_VERSION:-1.55.0}
54+
environment:
55+
- CLICKHOUSE_ENDPOINT=tcp://ch-server:9000?dial_timeout=10s
56+
- CLICKHOUSE_PROMETHEUS_METRICS_ENDPOINT=ch-server:9363
57+
- CLICKHOUSE_USER=default
58+
- CLICKHOUSE_PASSWORD=
59+
- HYPERDX_OTEL_EXPORTER_CLICKHOUSE_DATABASE=otel_json
60+
- HYPERDX_OTEL_EXPORTER_CLICKHOUSE_JSON_ENABLE=true
61+
- HYPERDX_LOG_LEVEL=info
62+
# OPAMP_SERVER_URL is intentionally not set to run in standalone mode
63+
ports:
64+
- 14318:4318 # OTLP http receiver
65+
networks:
66+
- internal
67+
depends_on:
68+
ch-server:
69+
condition: service_healthy
70+
4671
networks:
4772
internal:
4873
name: 'smoke-test-internal-network'

0 commit comments

Comments
 (0)