Skip to content

Commit c282f0b

Browse files
authored
Merge pull request #4713 from ClickHouse/clickstack-json-not-prod-ready
adding warning to make it even more clear that JSON is in beta
2 parents ef54044 + 48ddcca commit c282f0b

File tree

3 files changed

+17
-14
lines changed

3 files changed

+17
-14
lines changed

docs/use-cases/observability/clickstack/deployment/_snippets/_json_support.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,17 @@ import BetaBadge from '@theme/badges/BetaBadge';
44

55
<BetaBadge/>
66

7+
:::warning Beta Feature
8+
JSON type support in ClickStack is a **beta feature**. While it is under active development and supported by the ClickHouse team, it may have limitations, change in the future, or contain bugs.
9+
10+
**For production use**, ensure you are running **ClickHouse version 25.3 or later**, where the JSON type is production-ready. For earlier versions of ClickHouse, the JSON type is not recommended for production use.
11+
:::
12+
713
ClickStack has beta support for the [JSON type](/interfaces/formats/JSON) from version `2.0.4`.
814

915
For the benefits of this type see [Benefits of the JSON type](/use-cases/observability/clickstack/ingesting-data/otel-collector#benefits-json-type).
1016

1117
In order to enable support for the JSON type users must set the following environment variables:
1218

1319
- `OTEL_AGENT_FEATURE_GATE_ARG='--feature-gates=clickhouse.json'` - enables support in the OTel collector, ensuring schemas are created using the JSON type.
14-
- `BETA_CH_OTEL_JSON_SCHEMA_ENABLED=true` - enables support in the HyperDX application, allowing JSON data to be queried.
20+
- `BETA_CH_OTEL_JSON_SCHEMA_ENABLED=true` - enables support in the HyperDX application, allowing JSON data to be queried.

docs/use-cases/observability/clickstack/deployment/hyperdx-clickhouse-cloud.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import hyperdx_create_new_source from '@site/static/images/use-cases/observabili
2020
import hyperdx_create_trace_datasource from '@site/static/images/use-cases/observability/hyperdx_create_trace_datasource.png';
2121
import read_only from '@site/static/images/clickstack/read-only-access.png';
2222
import { TrackedLink } from '@site/src/components/GalaxyTrackedLink/GalaxyTrackedLink';
23+
import JSONSupport from '@site/docs/use-cases/observability/clickstack/deployment/_snippets/_json_support.md';
2324

2425
<PrivatePreviewBadge/>
2526

@@ -336,16 +337,6 @@ If using your own schema, we recommend creating a Logs source ensuring the requi
336337

337338
</VerticalStepper>
338339

339-
## JSON type support {#json-type-support}
340+
<JSONSupport/>
340341

341-
<BetaBadge/>
342-
343-
ClickStack has beta support for the [JSON type](/interfaces/formats/JSON) from version `2.0.4`.
344-
345-
For the benefits of this type, see [Benefits of the JSON type](/use-cases/observability/clickstack/ingesting-data/otel-collector#benefits-json-type).
346-
347-
In order to enable support for the JSON type, users must set the following environment variables:
348-
349-
- `OTEL_AGENT_FEATURE_GATE_ARG='--feature-gates=clickhouse.json'` - enables support in the OTel collector, ensuring schemas are created using the JSON type.
350-
351-
Additionally, users should contact support@clickhouse.com to ensure JSON is enabled on both their ClickHouse Cloud service.
342+
Additionally, users should contact support@clickhouse.com to ensure JSON is enabled on both their ClickHouse Cloud service.

docs/use-cases/observability/clickstack/ingesting-data/collector.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,12 @@ For agent instances responsible for shipping events to a gateway, and only setti
297297

298298
<BetaBadge/>
299299

300+
:::warning Beta Feature
301+
JSON type support in ClickStack is a **beta feature**. While it is under active development and supported by the ClickHouse team, it may have limitations, change in the future, or contain bugs.
302+
303+
**For production use**, ensure you are running **ClickHouse version 25.3 or later**, where the JSON type is production-ready. For earlier versions of ClickHouse, the JSON type is not recommended for production use.
304+
:::
305+
300306
ClickStack has beta support for the [JSON type](/interfaces/formats/JSON) from version `2.0.4`.
301307

302308
### Benefits of the JSON type {#benefits-json-type}
@@ -327,7 +333,7 @@ docker run -e OTEL_AGENT_FEATURE_GATE_ARG='--feature-gates=clickhouse.json' -e O
327333
### Migrating from map-based schemas to the JSON type {#migrating-from-map-based-schemas-to-json}
328334

329335
:::important Backwards compatibility
330-
The [JSON type](/interfaces/formats/JSON) type is not backwards compatible with existing map-based schemas. New tables will be created using the `JSON` type.
336+
The [JSON type](/interfaces/formats/JSON) is **not backwards compatible** with existing map-based schemas. Enabling this feature will create new tables using the `JSON` type and requires manual data migration.
331337
:::
332338

333339
To migrate from the Map-based schemas, follow these steps:

0 commit comments

Comments
 (0)