Skip to content

chore: Update docs for ClickStack and HyperDX v2 Launch #878

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 29, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 24 additions & 89 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,19 @@

# HyperDX

[HyperDX](https://hyperdx.io) helps engineers quickly figure out why production
is broken by making it easy to search & visualize logs and traces on top of any
Clickhouse cluster (imagine Kibana, for Clickhouse).
[HyperDX](https://hyperdx.io), a core component of
[ClickStack](https://clickhouse.com/use-cases/observability), helps engineers
quickly figure out why production is broken by making it easy to search &
visualize logs and traces on top of any ClickHouse cluster (imagine Kibana, for
ClickHouse).

<p align="center">
<a href="https://www.hyperdx.io/docs/v2/">Documentation</a> • <a href="https://hyperdx.io/discord">Chat on Discord</a> • <a href="https://play.hyperdx.io/search">Live Demo</a> • <a href="https://github.com/hyperdxio/hyperdx/issues/new">Bug Reports</a> • <a href="./CONTRIBUTING.md">Contributing</a> • <a href="https://hyperdx.io/v2">Website</a>
<a href="https://clickhouse.com/docs/use-cases/observability/clickstack/overview">Documentation</a> • <a href="https://hyperdx.io/discord">Chat on Discord</a> • <a href="https://play.hyperdx.io/search">Live Demo</a> • <a href="https://github.com/hyperdxio/hyperdx/issues/new">Bug Reports</a> • <a href="./CONTRIBUTING.md">Contributing</a> • <a href="https://clickhouse.com/use-cases/observability">Website</a>
</p>

- 🕵️ Correlate/search logs, metrics, session replays and traces all in one place
- 📝 Schema agnostic, works on top of your existing Clickhouse schema
- 🔥 Blazing fast searches & visualizations optimized for Clickhouse
- 📝 Schema agnostic, works on top of your existing ClickHouse schema
- 🔥 Blazing fast searches & visualizations optimized for ClickHouse
- 🔍 Intuitive full-text search and property search syntax (ex. `level:err`),
SQL optional!
- 📊 Analyze trends in anomalies with event deltas
Expand All @@ -37,59 +39,31 @@ Clickhouse cluster (imagine Kibana, for Clickhouse).

## Spinning Up HyperDX

HyperDX can be deployed in a few different ways depending on your needs. The
easiest way to get started from scratch is to start the complete stack via
Docker Compose. Which will start an OpenTelemetry collector, Clickhouse, and
HyperDX with a MongoDB instance.

After cloning this repository, simply start the stack with:
HyperDX can be deployed as part of ClickStack, which includes ClickHouse,
HyperDX, OpenTelemetry Collector and MongoDB.

```bash
docker compose up -d
docker run -p 8080:8080 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-all-in-one
```

Afterwards, you can visit http://localhost:8080 to access the HyperDX UI.

If you already have an existing ClickHouse instance, want to use a single
container locally, or are looking for production deployment instructions, you
can view the different deployment options in our [DEPLOY.md](/DEPLOY.md).
can view the different deployment options in our
[deployment docs](https://clickhouse.com/docs/use-cases/observability/clickstack/deployment).

> If your server is behind a firewall, you'll need to open/forward port 8080,
> 8000 and 4318 on your firewall for the UI, API and OTel collector
> respectively.
> We recommend at least 4GB of RAM and 2 cores for testing.
### Local Mode

> **Note:** HyperDX v2 is currently in beta for local mode.
You can get started by standing up the HyperDX local container, which will run
an OpenTelemetry collector (on port 4317), Clickhouse (on port 8123), and the
HyperDX UI (on port 8080).

You can spin up the container with the following command:

```bash
docker run -p 8080:8080 -p 8123:8123 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-local:2-beta
```

Afterwards, you can visit http://localhost:8080 to access the HyperDX UI. If
you're connecting to an external Clickhouse cluster, you can simply just forward
port 8080 and set up the connection in the UI.
### Hosted ClickHouse Cloud

> **Safari & Brave Browser Users:** There are known issues with Safari & Brave's
> CORS implementation that can prevent connecting to Clickhouse in local mode.
> We recommend using another browser in the interim.
> We recommend having _at least_ 1GB of RAM and 1 CPU core available for the
> container if using the included OpenTelemetry collector and Clickhouse server.
### Hosted Cloud

HyperDX is also available as a hosted cloud service at
[hyperdx.io](https://hyperdx.io). You can sign up for a free account and start
sending data in minutes.
You can also deploy HyperDX with ClickHouse Cloud, you can
[sign up for free](https://console.clickhouse.cloud/signUp) and get started in
just minutes.

## Instrumenting Your App

Expand All @@ -99,11 +73,13 @@ instance.

We provide a set of SDKs and integration options to make it easier to get
started with HyperDX, such as
[Browser](https://www.hyperdx.io/docs/install/browser),
[Node.js](https://www.hyperdx.io/docs/install/javascript), and
[Python](https://www.hyperdx.io/docs/install/python)
[Browser](https://clickhouse.com/docs/use-cases/observability/clickstack/sdks/browser),
[Node.js](https://clickhouse.com/docs/use-cases/observability/clickstack/sdks/nodejs),
and
[Python](https://clickhouse.com/docs/use-cases/observability/clickstack/sdks/python)

You can find the full list in [our docs](https://www.hyperdx.io/docs).
You can find the full list in
[our docs](https://clickhouse.com/docs/use-cases/observability/clickstack).

**OpenTelemetry**

Expand Down Expand Up @@ -156,55 +132,14 @@ a few ways:
3. They requiring hopping from tool to tool (logs, session replay, APM,
exceptions, etc.) to stitch together the clues yourself.

We're still early on in our journey, but are building in the open to solve these
key issues in observability. We hope you give HyperDX a try and let us know how
we're doing!

## Open Source vs Hosted Cloud

HyperDX is open core, with most of our features available here under an MIT
license. We have a cloud-hosted version available at
[hyperdx.io](https://hyperdx.io) with a few
[additional features](https://www.hyperdx.io/docs/oss-vs-cloud) beyond what's
offered in the open source version.

Our cloud hosted version exists so that we can build a sustainable business and
continue building HyperDX as an open source platform. We hope to have more
comprehensive documentation on how we balance between cloud-only and open source
features in the future. In the meantime, we're highly aligned with Gitlab's
[stewardship model](https://handbook.gitlab.com/handbook/company/stewardship/).
We hope you give HyperDX in ClickStack a try and let us know how we're doing!

## Contact

- [Open an Issue](https://github.com/hyperdxio/hyperdx/issues/new)
- [Discord](https://discord.gg/FErRRKU78j)
- [Email](mailto:support@hyperdx.io)

## HyperDX V2 Roadmap

HyperDX v2 is currently in beta, with the goals of accomplishing deployment
simplicity, native SQL support, and improved performance for PB+ deployments.
Currently we've released a subset of features with the goal of getting early
feedback from the community.

Here's a high-level list of support we're working on delivering as part of v2:

- [x] Log & Trace Search w/ Lucene & SQL
- [x] Charting & Dashboarding
- [x] Event Deltas
- [x] Performance Improvements
- [x] Authentication & Saving Sources/Connections
- [x] Saved Searches & Dashboards
- [x] Alerting
- [ ] PromQL-based Metrics
- [x] OTLP/SQL-based Metrics
- [x] Browser Monitoring/Session Replay
- [ ] Raw SQL Charting
- [x] Improved Custom Domain/TLS Support
- [ ] Official Helm Chart
- [ ] v1 Migration Tooling
- [ ] Public API

## HyperDX Usage Data

HyperDX collects anonymized usage data for open source deployments. This data
Expand Down