- HyperDX UI
- OpenTelemetry (OTel) collector
- ClickHouse
1
Deploy the stack with docker
The following will run an OpenTelemetry collector (on port 4317 and 4318), the HyperDX UI (on port 8080) and ClickHouse (8123).Image Name UpdateClickStack images are now published as
clickhouse/clickstack-* (previously docker.hyperdx.io/hyperdx/*).2
Navigate to the ClickStack UI
Visit http://localhost:8080 to access the ClickStack UI (HyperDX).Create a user, providing a username and password that meets the complexity requirements.HyperDX will automatically connect to the local cluster and create data sources for the logs, traces, metrics, and sessions - allowing you to explore the product immediately.3
Explore the product
With the stack deployed, try one of our same datasets.To continue using the local cluster:- Example dataset - Load an example dataset from our public demo. Diagnose a simple issue.
- Local files and metrics - Load local files and monitor system on OSX or Linux using a local OTel collector.
Alternatively, you can connect to a demo cluster where you can explore a larger dataset:
- Remote demo dataset - Explore a demo dataset in our demo ClickHouse service.
Alternative deployment models
Local mode
Local mode is a way to deploy HyperDX without needing to authenticate. Authentication isn’t supported. This mode is intended to be used for quick testing, development, demos and debugging use cases where authentication and settings persistence isn’t necessary. For further details on this deployment model, see “Local Mode Only”.Hosted version
You can use a hosted version of ClickStack in local mode available at play-clickstack.clickhouse.com.Self-hosted version
1
Run with docker
The self-hosted local mode image comes with an OpenTelemetry collector, the ClickStack UI and a ClickHouse server pre-configured as well. This makes it easy to consume telemetry data from your applications and visualize it with minimal external setup. To get started with the self-hosted version, simply run the Docker container with the appropriate ports forwarded:2