You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/use-cases/observability/clickstack/alerts.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,14 +13,14 @@ import search_alert from '@site/static/images/use-cases/observability/search_ale
13
13
14
14
## Search alerts {#search-alerts}
15
15
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
17
17
notified when the number of events (logs or spans) matching the search exceeds or falls below a threshold.
18
18
19
19
### Creating an Alert {#creating-an-alert}
20
20
21
21
You can create an alert by clicking the `Alerts` button on the top right of the `Search` page.
22
22
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).
24
24
25
25
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.
26
26
@@ -36,7 +36,7 @@ excess error occurs.
36
36
37
37
**Slow Operations:** You can set up a search for slow operations (ex.
38
38
`duration:>5000`) and then alert when there are too many slow operations
39
-
occuring.
39
+
occurring.
40
40
41
41
**User Events:** You can also set up alerts for customer-facing teams to be
42
42
notified when new users sign up, or a critical user action is performed.
Copy file name to clipboardExpand all lines: docs/use-cases/observability/clickstack/ingesting-data/collector.md
+23-19Lines changed: 23 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,17 +28,37 @@ OpenTelemetry collectors can be deployed in two principal roles:
28
28
29
29
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/).
30
30
31
-
## Configuring the collector {#configuring-the-collector}
31
+
## Deploying the collector {#configuring-the-collector}
32
32
33
33
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).
34
34
35
+
### Standalone {#standalone}
36
+
37
+
To deploy the ClickStack distribution of the OTel connector in a standalone mode, run the following docker command:
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.
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`:
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
-
70
74
#### Docker Compose {#docker-compose-otel}
71
75
72
76
With Docker Compose, modify the collector configuration using the same environment variables as above:
Copy file name to clipboardExpand all lines: docs/use-cases/observability/clickstack/ingesting-data/opentelemetry.md
+1-13Lines changed: 1 addition & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,19 +34,7 @@ If you're using the [HyperDX-only](/use-cases/observability/clickstack/deploymen
34
34
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.
35
35
:::
36
36
37
-
To deploy the connector, run the following docker command:
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).
50
38
51
39
## Sending OpenTelemetry data {#sending-otel-data}
0 commit comments