Elgato_dark/hyperdx
1
0
Fork 0
mirror of https://github.com/hyperdxio/hyperdx synced 2026-04-21 13:37:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

update docs spelling (#1365)

Browse source
This commit is contained in:
Mike Shi 2025-11-14 10:04:26 -05:00 committed by GitHub
parent 3fb5ef7083
commit 5e440ab390
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CONTRIBUTING.md
View file

@ -11,7 +11,7 @@ Service Descriptions:
OpAMP supervisor that dynamically pulls configuration from HyperDX API. OpAMP supervisor that dynamically pulls configuration from HyperDX API.
- ClickHouse (ch-server): ClickHouse database, stores all telemetry. - ClickHouse (ch-server): ClickHouse database, stores all telemetry.
- MongoDB (db): Stores user/saved search/alert/dashboard data. - MongoDB (db): Stores user/saved search/alert/dashboard data.
- HyperDX API (api): Node.js API, executes Clickhouse queries on behalf of the - HyperDX API (api): Node.js API, executes ClickHouse queries on behalf of the
frontend and serves the frontend. serves the frontend. Can also run alert frontend and serves the frontend. serves the frontend. Can also run alert
checker. checker.
- HyperDX UI (app): Next.js frontend, serves the UI. - HyperDX UI (app): Next.js frontend, serves the UI.

6
DEPLOY.md
View file

@ -2,7 +2,7 @@
[HyperDX](https://hyperdx.io) helps engineers quickly figure out why production [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 is broken by making it easy to search & visualize logs and traces on top of any
Clickhouse cluster (imagine Kibana, for Clickhouse). You can learn more about ClickHouse cluster (imagine Kibana, for ClickHouse). You can learn more about
HyperDX in our [README](/README.md). HyperDX in our [README](/README.md).
HyperDX can be deployed in a few different ways: HyperDX can be deployed in a few different ways:
@ -36,7 +36,7 @@ the URL your HyperDX instance is hosted on.
## All-in-one Docker Compose Stack ## All-in-one Docker Compose Stack
The easiest way to get started with HyperDX from scratch is to use our The easiest way to get started with HyperDX from scratch is to use our
all-in-one Docker Compose stack. This stack will start Clickhouse, an all-in-one Docker Compose stack. This stack will start ClickHouse, an
OpenTelemetry collector, and HyperDX with a MongoDB instance. OpenTelemetry collector, and HyperDX with a MongoDB instance.
To get started, clone this repository and run the following command: To get started, clone this repository and run the following command:
@ -62,7 +62,7 @@ variable to a random string.
HyperDX can also be deployed alongside your existing local development stack to HyperDX can also be deployed alongside your existing local development stack to
help you debug issues locally. This mode will start an OpenTelemetry collector, help you debug issues locally. This mode will start an OpenTelemetry collector,
Clickhouse, and HyperDX with a MongoDB in a single instance, without any ClickHouse, and HyperDX with a MongoDB in a single instance, without any
authentication or configuration persistence. authentication or configuration persistence.
To get started, spin up the local mode container: To get started, spin up the local mode container: