This issue tracks outstanding documentation needs for ClickStack. Each item represents a proposed or missing page or section that would help users better understand, deploy, and extend ClickStack.
—
Notes from planning meeting
Dominic
This week:
- Ramp time with ClickStack
- Go through getting started guide, sample datasets, make sure they work etc
- 1.5 PED
- Session replays, including examples
- 2 PED
- Permissions requirement for read-only org users (need sql console read only access at minimum)
- 1 hr PED
- Alerting - Better alerting docs
- Walk through alerting docs, create alerts, check that it works correctly
- Add good examples
- 1 PED
Start Oct 6
- Integration examples
- Create 3-5 examples of monitoring systems with ClickStack. Including how to ingest, and all other relevant steps, including a simple dashboard.
- https://signoz.io/docs/integrations/redis/
- 2 PED
- https://signoz.io/docs/integrations/nginx/
- 2 PED
- Kafka
- 2 PED
- Dashboards:
- For each one, create via Grafana (https://grafana.com/grafana/dashboards/11835-redis-dashboard-for-prometheus-redis-exporter-helm-stable-redis-ha) export, and include in docs
- Dale to circle back on additional ones
- https://signoz.io/docs/integrations/redis/
- Create 3-5 examples of monitoring systems with ClickStack. Including how to ingest, and all other relevant steps, including a simple dashboard.
- Landing page update
- 2 PED
Dale + Dominic
Will work together on this on Oct 2
- Extending the otel collector config
- Update the existing working examples to include the extended config
- Add an example about pulling events from Kafka
- Review docs, and flag/update areas that need to be updated
- 1.5 PED
- Data Enrichment — Dale has content locally, has to think through this first
- 1 PED
—
📚 Proposed Docs
- Cloud Integration
- Clarifying setup with OSS, using separate collector (Ref)
- Permissions requirement for read only org users (need sql console read only access at minimum)
- Session Replay — Dedicated documentation explaining how Session Replay works and how to enable it.
- RUM Event types/schema (Ref)
- Event Deltas — Explain what deltas are, why they matter, and how they’re used in session analysis. https://github.com/ClickHouse/clickhouse-docs/pull/4429
- Log Patterns — Guide on surfacing common log patterns, anomalies, and grouping strategies. https://github.com/ClickHouse/clickhouse-docs/pull/4418
- Monitoring Mobile Applications — Document how to monitor Android/iOS apps using ClickStack.
- Data Enrichment — How to enrich telemetry data, including:
- Using processors to transform events
- Creating and using materialized columns in ClickHouse for performance
- Using MVs to transform events
- IP to geo
- Parsing useragents
- Scaling ClickStack — Strategies for scaling ingestion, storage, and queries across large volumes.
- Filtering events — Document how to filter events at ingest time
- Custom Visualizations — Guide to building your own visualization tools (e.g. using Grafana, Notebooks, etc.).
- Production Security — Best practices for securing ClickStack deployments, including SSL and authentication.
- Exception Snippets — How to instrument and capture exception traces with code snippets across languages.
- Dashboards — Overview of dashboards, customization options. https://github.com/ClickHouse/clickhouse-docs/pull/4221
- Alerting - Better alerting docs
- Monitoring Kubernetes - Guide on how to monitor Kubernetes https://github.com/ClickHouse/clickhouse-docs/pull/4240
- Using secondary indices - For performance
- Using mvs and projections - For performance
- Extending the OTel collector config - needed for more advanced architectures
- Highlighted attributes
- Text to chart
Activity
12
jonfriesen1y agoThis seems like the place to add an item fixing the Local Mode Only docs. The Local Mode Only docs say:
Similar to the [all-in-one image](https://clickhouse.com/docs/use-cases/observability/clickstack/deployment/docker-compose), this comprehensive Docker image bundles all ClickStack components:
- ClickHouse
- HyperDX
- OpenTelemetry (OTel) collector (exposing OTLP on ports 4317 and 4318)
- MongoDB (for persistent application state)However, immediately below this it says:
Local mode deploys the HyperDX UI only, accessible on port 8080.Which appears to be incorrect and the local mode docker image does start ClickHouse, HyperDX, Otel collector, and MongoDB. This page could be the same as the All in one page with the auth parts removed.
jonfriesen1y agoThis seems like the place to add an item fixing the Local Mode Only docs. The Local Mode Only docs say:
Similar to the [all-in-one image](https://clickhouse.com/docs/use-cases/observability/clickstack/deployment/docker-compose), this comprehensive Docker image bundles all ClickStack components:
- ClickHouse
- HyperDX
- OpenTelemetry (OTel) collector (exposing OTLP on ports 4317 and 4318)
- MongoDB (for persistent application state)However, immediately below this it says:
Local mode deploys the HyperDX UI only, accessible on port 8080.Which appears to be incorrect and the local mode docker image does start ClickHouse, HyperDX, Otel collector, and MongoDB. This page could be the same as the All in one page with the auth parts removed.
jonfriesen1y agoThis seems like the place to add an item fixing the Local Mode Only docs. The Local Mode Only docs say:
Similar to the [all-in-one image](https://clickhouse.com/docs/use-cases/observability/clickstack/deployment/docker-compose), this comprehensive Docker image bundles all ClickStack components:
- ClickHouse
- HyperDX
- OpenTelemetry (OTel) collector (exposing OTLP on ports 4317 and 4318)
- MongoDB (for persistent application state)However, immediately below this it says:
Local mode deploys the HyperDX UI only, accessible on port 8080.Which appears to be incorrect and the local mode docker image does start ClickHouse, HyperDX, Otel collector, and MongoDB. This page could be the same as the All in one page with the auth parts removed.
jonfriesen1y agoThis seems like the place to add an item fixing the Local Mode Only docs. The Local Mode Only docs say:
Similar to the [all-in-one image](https://clickhouse.com/docs/use-cases/observability/clickstack/deployment/docker-compose), this comprehensive Docker image bundles all ClickStack components:
- ClickHouse
- HyperDX
- OpenTelemetry (OTel) collector (exposing OTLP on ports 4317 and 4318)
- MongoDB (for persistent application state)However, immediately below this it says:
Local mode deploys the HyperDX UI only, accessible on port 8080.Which appears to be incorrect and the local mode docker image does start ClickHouse, HyperDX, Otel collector, and MongoDB. This page could be the same as the All in one page with the auth parts removed.
jonfriesen1y agoThis seems like the place to add an item fixing the Local Mode Only docs. The Local Mode Only docs say:
Similar to the [all-in-one image](https://clickhouse.com/docs/use-cases/observability/clickstack/deployment/docker-compose), this comprehensive Docker image bundles all ClickStack components:
- ClickHouse
- HyperDX
- OpenTelemetry (OTel) collector (exposing OTLP on ports 4317 and 4318)
- MongoDB (for persistent application state)However, immediately below this it says:
Local mode deploys the HyperDX UI only, accessible on port 8080.Which appears to be incorrect and the local mode docker image does start ClickHouse, HyperDX, Otel collector, and MongoDB. This page could be the same as the All in one page with the auth parts removed.
jonfriesen1y agoThis seems like the place to add an item fixing the Local Mode Only docs. The Local Mode Only docs say:
Similar to the [all-in-one image](https://clickhouse.com/docs/use-cases/observability/clickstack/deployment/docker-compose), this comprehensive Docker image bundles all ClickStack components:
- ClickHouse
- HyperDX
- OpenTelemetry (OTel) collector (exposing OTLP on ports 4317 and 4318)
- MongoDB (for persistent application state)However, immediately below this it says:
Local mode deploys the HyperDX UI only, accessible on port 8080.Which appears to be incorrect and the local mode docker image does start ClickHouse, HyperDX, Otel collector, and MongoDB. This page could be the same as the All in one page with the auth parts removed.
jonfriesen1y agoThis seems like the place to add an item fixing the Local Mode Only docs. The Local Mode Only docs say:
Similar to the [all-in-one image](https://clickhouse.com/docs/use-cases/observability/clickstack/deployment/docker-compose), this comprehensive Docker image bundles all ClickStack components:
- ClickHouse
- HyperDX
- OpenTelemetry (OTel) collector (exposing OTLP on ports 4317 and 4318)
- MongoDB (for persistent application state)However, immediately below this it says:
Local mode deploys the HyperDX UI only, accessible on port 8080.Which appears to be incorrect and the local mode docker image does start ClickHouse, HyperDX, Otel collector, and MongoDB. This page could be the same as the All in one page with the auth parts removed.
jonfriesen1y agoThis seems like the place to add an item fixing the Local Mode Only docs. The Local Mode Only docs say:
Similar to the [all-in-one image](https://clickhouse.com/docs/use-cases/observability/clickstack/deployment/docker-compose), this comprehensive Docker image bundles all ClickStack components:
- ClickHouse
- HyperDX
- OpenTelemetry (OTel) collector (exposing OTLP on ports 4317 and 4318)
- MongoDB (for persistent application state)However, immediately below this it says:
Local mode deploys the HyperDX UI only, accessible on port 8080.Which appears to be incorrect and the local mode docker image does start ClickHouse, HyperDX, Otel collector, and MongoDB. This page could be the same as the All in one page with the auth parts removed.
jonfriesen1y agoThis seems like the place to add an item fixing the Local Mode Only docs. The Local Mode Only docs say:
Similar to the [all-in-one image](https://clickhouse.com/docs/use-cases/observability/clickstack/deployment/docker-compose), this comprehensive Docker image bundles all ClickStack components:
- ClickHouse
- HyperDX
- OpenTelemetry (OTel) collector (exposing OTLP on ports 4317 and 4318)
- MongoDB (for persistent application state)However, immediately below this it says:
Local mode deploys the HyperDX UI only, accessible on port 8080.Which appears to be incorrect and the local mode docker image does start ClickHouse, HyperDX, Otel collector, and MongoDB. This page could be the same as the All in one page with the auth parts removed.
jonfriesen1y agoThis seems like the place to add an item fixing the Local Mode Only docs. The Local Mode Only docs say:
Similar to the [all-in-one image](https://clickhouse.com/docs/use-cases/observability/clickstack/deployment/docker-compose), this comprehensive Docker image bundles all ClickStack components:
- ClickHouse
- HyperDX
- OpenTelemetry (OTel) collector (exposing OTLP on ports 4317 and 4318)
- MongoDB (for persistent application state)However, immediately below this it says:
Local mode deploys the HyperDX UI only, accessible on port 8080.Which appears to be incorrect and the local mode docker image does start ClickHouse, HyperDX, Otel collector, and MongoDB. This page could be the same as the All in one page with the auth parts removed.
jonfriesen1y agoThis seems like the place to add an item fixing the Local Mode Only docs. The Local Mode Only docs say:
Similar to the [all-in-one image](https://clickhouse.com/docs/use-cases/observability/clickstack/deployment/docker-compose), this comprehensive Docker image bundles all ClickStack components:
- ClickHouse
- HyperDX
- OpenTelemetry (OTel) collector (exposing OTLP on ports 4317 and 4318)
- MongoDB (for persistent application state)However, immediately below this it says:
Local mode deploys the HyperDX UI only, accessible on port 8080.Which appears to be incorrect and the local mode docker image does start ClickHouse, HyperDX, Otel collector, and MongoDB. This page could be the same as the All in one page with the auth parts removed.
This seems like the place to add an item fixing the Local Mode Only docs. The Local Mode Only docs say:
However, immediately below this it says:
Which appears to be incorrect and the local mode docker image does start ClickHouse, HyperDX, Otel collector, and MongoDB. This page could be the same as the All in one page with the auth parts removed.
code ref