Skip to content

Commit 722cf54

Browse files
committed
spelling
1 parent 7d911f8 commit 722cf54

File tree

4 files changed

+28
-35
lines changed

4 files changed

+28
-35
lines changed

docs/use-cases/observability/clickstack/alerts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ import search_alert from '@site/static/images/use-cases/observability/search_ale
1313

1414
## Search alerts {#search-alerts}
1515

16-
Aftering entering a [search](/use-cases/observability/clickstack/search), you can create an alert to be
16+
After entering a [search](/use-cases/observability/clickstack/search), you can create an alert to be
1717
notified when the number of events (logs or spans) matching the search exceeds or falls below a threshold.
1818

1919
### Creating an Alert {#creating-an-alert}
2020

2121
You can create an alert by clicking the `Alerts` button on the top right of the `Search` page.
2222

23-
From here, you can name the alert, as well as set the threshold, duration, and notification method for the alert (Slack, Email, PagerDuty or Slack Webhook).
23+
From here, you can name the alert, as well as set the threshold, duration, and notification method for the alert (Slack, Email, PagerDuty or Slack webhook).
2424

2525
The `grouped by` value allows the search to be subject to an aggregation e.g. `ServiceName`, thus allowing potential multiple alerts to be triggered off the same search.
2626

@@ -36,7 +36,7 @@ excess error occurs.
3636

3737
**Slow Operations:** You can set up a search for slow operations (ex.
3838
`duration:>5000`) and then alert when there are too many slow operations
39-
occuring.
39+
occurring.
4040

4141
**User Events:** You can also set up alerts for customer-facing teams to be
4242
notified when new users sign up, or a critical user action is performed.

docs/use-cases/observability/clickstack/ingesting-data/collector.md

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,37 @@ OpenTelemetry collectors can be deployed in two principal roles:
2828

2929
Users deploying OTel collectors in the agent role will typically use the [default contrib distribution of the collector](https://github.com/open-telemetry/opentelemetry-collector-contrib) and not the ClickStack version but are free to use other OTLP compatible technologies such as [Fluentd](https://www.fluentd.org/) and [Vector](https://vector.dev/).
3030

31-
## Configuring the collector {#configuring-the-collector}
31+
## Deploying the collector {#configuring-the-collector}
3232

3333
If you are managing your own OpenTelemetry collector in a standalone deployment - such as when using the HyperDX-only distribution - we [recommend still using the official ClickStack distribution of the collector](/use-cases/observability/clickstack/deployment/hyperdx-only#otel-collector) for the gateway role where possible, but if you choose to bring your own, ensure it includes the [ClickHouse exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/clickhouseexporter).
3434

35+
### Standalone {#standalone}
36+
37+
To deploy the ClickStack distribution of the OTel connector in a standalone mode, run the following docker command:
38+
39+
```bash
40+
docker run -e OPAMP_SERVER_URL=${OPAMP_SERVER_URL} -e CLICKHOUSE_ENDPOINT=${CLICKHOUSE_ENDPOINT} -e CLICKHOUSE_USER=default -e CLICKHOUSE_PASSWORD=${CLICKHOUSE_PASSWORD} -p 8080:8080 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-otel-collector:2-nightly
41+
```
42+
43+
Note that we can overwrite the target ClickHouse instance with environment variables for `CLICKHOUSE_ENDPOINT`, `CLICKHOUSE_USERNAME`, and `CLICKHOUSE_PASSWORD`. The `CLICKHOUSE_ENDPOINT` should be the full ClickHouse HTTP endpoint, including the protocol and port—for example, `http://localhost:8123`.
44+
45+
**These environment variables can be used with any of the docker distributions which include the connector.**
46+
47+
The `OPAMP_SERVER_URL` should point to your HyperDX deployment - for example, `http://localhost:4320`. HyperDX exposes an OpAMP (Open Agent Management Protocol) server at `/v1/opamp` on port `4320` by default. Make sure to expose this port from the container running HyperDX (e.g., using `-p 4320:4320`).
48+
49+
:::note Exposing and connecting to the OpAMP port
50+
For the collector to connect to the OpAMP port it must be exposed by the HyperDX container e.g. `-p 4320:4320`. For local testing, OSX users can then set `OPAMP_SERVER_URL=http://host.docker.internal:4320`. Linux users can start the collector container with `--network=host`.
51+
:::
52+
53+
Users should use a user with the [appropriate credentials](/use-cases/observability/clickstack/ingesting-data/otel-collector#creating-an-ingestion-user) in production.
54+
3555
### Modifying configuration {#modifying-otel-collector-configuration}
3656

3757
#### Using docker {#using-docker}
3858

39-
All docker images, which include the OpenTelemetry collector, can be configured to use a clickhouse instance via the environment variables `CLICKHOUSE_ENDPOINT`, `CLICKHOUSE_USERNAME` and `CLICKHOUSE_PASSWORD`:
59+
All docker images, which include the OpenTelemetry collector, can be configured to use a clickhouse instance via the environment variables `OPAMP_SERVER_URL`,`CLICKHOUSE_ENDPOINT`, `CLICKHOUSE_USERNAME` and `CLICKHOUSE_PASSWORD`:
4060

41-
Set these variables:
61+
For example the all-in-one image:
4262

4363
```bash
4464
export OPAMP_SERVER_URL=<OPAMP_SERVER_URL>
@@ -47,26 +67,10 @@ export CLICKHOUSE_USER=<CLICKHOUSE_USER>
4767
export CLICKHOUSE_PASSWORD=<CLICKHOUSE_PASSWORD>
4868
```
4969

50-
The `CLICKHOUSE_ENDPOINT` should be the full ClickHouse HTTP endpoint, including the protocol and port—for example, `http://localhost:8123`.
51-
52-
For example the all-in-one image:
53-
5470
```bash
5571
docker run -e OPAMP_SERVER_URL=${OPAMP_SERVER_URL} -e CLICKHOUSE_ENDPOINT=${CLICKHOUSE_ENDPOINT} -e CLICKHOUSE_USER=default -e CLICKHOUSE_PASSWORD=${CLICKHOUSE_PASSWORD} -p 8080:8080 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-all-in-one:2-nightly
5672
```
5773

58-
Or the standalone image:
59-
60-
```bash
61-
docker run -e OPAMP_SERVER_URL=${OPAMP_SERVER_URL} -e CLICKHOUSE_ENDPOINT=${CLICKHOUSE_ENDPOINT} -e CLICKHOUSE_USER=default -e CLICKHOUSE_PASSWORD=${CLICKHOUSE_PASSWORD} -p 8080:8080 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-otel-collector:2-nightly
62-
```
63-
64-
The `OPAMP_SERVER_URL` should point to your HyperDX deployment - for example, `http://localhost:4320`. HyperDX exposes an OpAMP (Open Agent Management Protocol) server at `/v1/opamp` on port `4320` by default, ensuring the collector is configured securely to use the ingestion API key. For details, see [Securing the collector](/use-cases/observability/clickstack/ingesting-data/otel-collector#securing-the-collector).
65-
66-
:::note Connecting to and exposing the OpAMP port
67-
For the collector to connect to the OpAMP port it must be exposed by the HyperDX container e.g. `-p 4320:4320`. For local testing, OSX users can then set `OPAMP_SERVER_URL=http://host.docker.internal:4320`. Linux users can start the collector container with `--network=host`.
68-
:::
69-
7074
#### Docker Compose {#docker-compose-otel}
7175

7276
With Docker Compose, modify the collector configuration using the same environment variables as above:

docs/use-cases/observability/clickstack/ingesting-data/opentelemetry.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,7 @@ If you're using the [HyperDX-only](/use-cases/observability/clickstack/deploymen
3434
This allows users to benefit from standardized ingestion, enforced schemas, and out-of-the-box compatibility with the HyperDX UI. Using the default schema enables automatic source detection and preconfigured column mappings.
3535
:::
3636

37-
To deploy the connector, run the following docker command:
38-
39-
```bash
40-
docker run -e OPAMP_SERVER_URL=${OPAMP_SERVER_URL} -e CLICKHOUSE_ENDPOINT=${CLICKHOUSE_ENDPOINT} -e CLICKHOUSE_USER=default -e CLICKHOUSE_PASSWORD=${CLICKHOUSE_PASSWORD} -p 8080:8080 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-otel-collector:2-nightly
41-
```
42-
43-
Note that we can overwrite the target ClickHouse instance with environment variables for `CLICKHOUSE_ENDPOINT`, `CLICKHOUSE_USERNAME`, and `CLICKHOUSE_PASSWORD`. The `CLICKHOUSE_ENDPOINT` should be the full ClickHouse HTTP endpoint, including the protocol and port—for example, `http://localhost:8123`.
44-
45-
**These environment variables can be used with any of the docker distributions which include the connector.**
46-
47-
The `OPAMP_SERVER_URL` should point to your HyperDX deployment - for example, `http://localhost:4320`. HyperDX exposes an OpAMP (Open Agent Management Protocol) server at `/v1/opamp` on port `4320` by default. Make sure to expose this port from the container running HyperDX (e.g., using `-p 4320:4320`).
48-
49-
Users should use a user with the [appropriate credentials](/use-cases/observability/clickstack/ingesting-data/otel-collector#creating-an-ingestion-user) in production.
37+
For further details see ["Deploying the collector"](/use-cases/observability/clickstack/ingesting-data/otel-collector).
5038

5139
## Sending OpenTelemetry data {#sending-otel-data}
5240

scripts/aspell-ignore/en/aspell-dict.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3444,6 +3444,7 @@ vruntime
34443444
walkthrough
34453445
wchc
34463446
wchs
3447+
webhook
34473448
webpage
34483449
webserver
34493450
weekyear

0 commit comments

Comments
 (0)