11
11
12
12
# HyperDX
13
13
14
- [ HyperDX] ( https://hyperdx.io ) helps engineers quickly figure out why production
15
- is broken by making it easy to search & visualize logs and traces on top of any
16
- Clickhouse cluster (imagine Kibana, for Clickhouse).
14
+ [ HyperDX] ( https://hyperdx.io ) , a core component of
15
+ [ ClickStack] ( https://clickhouse.com/use-cases/observability ) , helps engineers
16
+ quickly figure out why production is broken by making it easy to search &
17
+ visualize logs and traces on top of any ClickHouse cluster (imagine Kibana, for
18
+ ClickHouse).
17
19
18
20
<p align =" center " >
19
- <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 >
21
+ <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 >
20
22
</p >
21
23
22
24
- 🕵️ Correlate/search logs, metrics, session replays and traces all in one place
23
- - 📝 Schema agnostic, works on top of your existing Clickhouse schema
24
- - 🔥 Blazing fast searches & visualizations optimized for Clickhouse
25
+ - 📝 Schema agnostic, works on top of your existing ClickHouse schema
26
+ - 🔥 Blazing fast searches & visualizations optimized for ClickHouse
25
27
- 🔍 Intuitive full-text search and property search syntax (ex. ` level:err ` ),
26
28
SQL optional!
27
29
- 📊 Analyze trends in anomalies with event deltas
@@ -37,59 +39,31 @@ Clickhouse cluster (imagine Kibana, for Clickhouse).
37
39
38
40
## Spinning Up HyperDX
39
41
40
- HyperDX can be deployed in a few different ways depending on your needs. The
41
- easiest way to get started from scratch is to start the complete stack via
42
- Docker Compose. Which will start an OpenTelemetry collector, Clickhouse, and
43
- HyperDX with a MongoDB instance.
44
-
45
- After cloning this repository, simply start the stack with:
42
+ HyperDX can be deployed as part of ClickStack, which includes ClickHouse,
43
+ HyperDX, OpenTelemetry Collector and MongoDB.
46
44
47
45
``` bash
48
- docker compose up -d
46
+ docker run -p 8080:8080 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-all-in-one
49
47
```
50
48
51
49
Afterwards, you can visit http://localhost:8080 to access the HyperDX UI.
52
50
53
51
If you already have an existing ClickHouse instance, want to use a single
54
52
container locally, or are looking for production deployment instructions, you
55
- can view the different deployment options in our [ DEPLOY.md] ( /DEPLOY.md ) .
53
+ can view the different deployment options in our
54
+ [ deployment docs] ( https://clickhouse.com/docs/use-cases/observability/clickstack/deployment ) .
56
55
57
56
> If your server is behind a firewall, you'll need to open/forward port 8080,
58
57
> 8000 and 4318 on your firewall for the UI, API and OTel collector
59
58
> respectively.
60
59
61
60
> We recommend at least 4GB of RAM and 2 cores for testing.
62
61
63
- ### Local Mode
64
-
65
- > ** Note:** HyperDX v2 is currently in beta for local mode.
66
-
67
- You can get started by standing up the HyperDX local container, which will run
68
- an OpenTelemetry collector (on port 4317), Clickhouse (on port 8123), and the
69
- HyperDX UI (on port 8080).
70
-
71
- You can spin up the container with the following command:
72
-
73
- ``` bash
74
- docker run -p 8080:8080 -p 8123:8123 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-local:2-beta
75
- ```
76
-
77
- Afterwards, you can visit http://localhost:8080 to access the HyperDX UI. If
78
- you're connecting to an external Clickhouse cluster, you can simply just forward
79
- port 8080 and set up the connection in the UI.
62
+ ### Hosted ClickHouse Cloud
80
63
81
- > ** Safari & Brave Browser Users:** There are known issues with Safari & Brave's
82
- > CORS implementation that can prevent connecting to Clickhouse in local mode.
83
- > We recommend using another browser in the interim.
84
-
85
- > We recommend having _ at least_ 1GB of RAM and 1 CPU core available for the
86
- > container if using the included OpenTelemetry collector and Clickhouse server.
87
-
88
- ### Hosted Cloud
89
-
90
- HyperDX is also available as a hosted cloud service at
91
- [ hyperdx.io] ( https://hyperdx.io ) . You can sign up for a free account and start
92
- sending data in minutes.
64
+ You can also deploy HyperDX with ClickHouse Cloud, you can
65
+ [ sign up for free] ( https://console.clickhouse.cloud/signUp ) and get started in
66
+ just minutes.
93
67
94
68
## Instrumenting Your App
95
69
@@ -99,11 +73,13 @@ instance.
99
73
100
74
We provide a set of SDKs and integration options to make it easier to get
101
75
started with HyperDX, such as
102
- [ Browser] ( https://www.hyperdx.io/docs/install/browser ) ,
103
- [ Node.js] ( https://www.hyperdx.io/docs/install/javascript ) , and
104
- [ Python] ( https://www.hyperdx.io/docs/install/python )
76
+ [ Browser] ( https://clickhouse.com/docs/use-cases/observability/clickstack/sdks/browser ) ,
77
+ [ Node.js] ( https://clickhouse.com/docs/use-cases/observability/clickstack/sdks/nodejs ) ,
78
+ and
79
+ [ Python] ( https://clickhouse.com/docs/use-cases/observability/clickstack/sdks/python )
105
80
106
- You can find the full list in [ our docs] ( https://www.hyperdx.io/docs ) .
81
+ You can find the full list in
82
+ [ our docs] ( https://clickhouse.com/docs/use-cases/observability/clickstack ) .
107
83
108
84
** OpenTelemetry**
109
85
@@ -156,55 +132,14 @@ a few ways:
156
132
3 . They requiring hopping from tool to tool (logs, session replay, APM,
157
133
exceptions, etc.) to stitch together the clues yourself.
158
134
159
- We're still early on in our journey, but are building in the open to solve these
160
- key issues in observability. We hope you give HyperDX a try and let us know how
161
- we're doing!
162
-
163
- ## Open Source vs Hosted Cloud
164
-
165
- HyperDX is open core, with most of our features available here under an MIT
166
- license. We have a cloud-hosted version available at
167
- [ hyperdx.io] ( https://hyperdx.io ) with a few
168
- [ additional features] ( https://www.hyperdx.io/docs/oss-vs-cloud ) beyond what's
169
- offered in the open source version.
170
-
171
- Our cloud hosted version exists so that we can build a sustainable business and
172
- continue building HyperDX as an open source platform. We hope to have more
173
- comprehensive documentation on how we balance between cloud-only and open source
174
- features in the future. In the meantime, we're highly aligned with Gitlab's
175
- [ stewardship model] ( https://handbook.gitlab.com/handbook/company/stewardship/ ) .
135
+ We hope you give HyperDX in ClickStack a try and let us know how we're doing!
176
136
177
137
## Contact
178
138
179
139
- [ Open an Issue] ( https://github.com/hyperdxio/hyperdx/issues/new )
180
140
- [ Discord] ( https://discord.gg/FErRRKU78j )
181
141
- [ Email
] ( mailto:[email protected] )
182
142
183
- ## HyperDX V2 Roadmap
184
-
185
- HyperDX v2 is currently in beta, with the goals of accomplishing deployment
186
- simplicity, native SQL support, and improved performance for PB+ deployments.
187
- Currently we've released a subset of features with the goal of getting early
188
- feedback from the community.
189
-
190
- Here's a high-level list of support we're working on delivering as part of v2:
191
-
192
- - [x] Log & Trace Search w/ Lucene & SQL
193
- - [x] Charting & Dashboarding
194
- - [x] Event Deltas
195
- - [x] Performance Improvements
196
- - [x] Authentication & Saving Sources/Connections
197
- - [x] Saved Searches & Dashboards
198
- - [x] Alerting
199
- - [ ] PromQL-based Metrics
200
- - [x] OTLP/SQL-based Metrics
201
- - [x] Browser Monitoring/Session Replay
202
- - [ ] Raw SQL Charting
203
- - [x] Improved Custom Domain/TLS Support
204
- - [ ] Official Helm Chart
205
- - [ ] v1 Migration Tooling
206
- - [ ] Public API
207
-
208
143
## HyperDX Usage Data
209
144
210
145
HyperDX collects anonymized usage data for open source deployments. This data
0 commit comments