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
import hyperdx from '@site/static/images/use-cases/observability/hyperdx-1.png';
14
13
import hyperdx_20 from '@site/static/images/use-cases/observability/hyperdx-20.png';
15
-
import hyperdx_3 from '@site/static/images/use-cases/observability/hyperdx-3.png';
16
-
import hyperdx_4 from '@site/static/images/use-cases/observability/hyperdx-4.png';
17
14
import hyperdx_21 from '@site/static/images/use-cases/observability/hyperdx-21.png';
18
15
import hyperdx_22 from '@site/static/images/use-cases/observability/hyperdx-22.png';
19
16
import hyperdx_23 from '@site/static/images/use-cases/observability/hyperdx-23.png';
20
-
import copy_api_key from '@site/static/images/use-cases/observability/copy_api_key.png';
21
17
22
-
This getting started guide allows you collect local logs and metrics from your system, sending them to ClickStack for visualization and analysis.
18
+
This getting started guide allows you to collect local logs and metrics from your system, sending them to ClickStack for visualization and analysis.
23
19
24
20
**This example works on OSX and Linux systems only**
25
21
26
-
The following example assumes you have started ClickStack using the [instructions for the all-in-one image](/use-cases/observability/clickstack/getting-started) and connected to the [local ClickHouse instance](/use-cases/observability/clickstack/getting-started#complete-connection-credentials) or a [ClickHouse Cloud instance](/use-cases/observability/clickstack/getting-started#create-a-cloud-connection).
27
-
28
22
:::note HyperDX in ClickHouse Cloud
29
-
This sample dataset can also be used with HyperDX in ClickHouse Cloud, with only minor adjustments to the flow as noted. If using HyperDX in ClickHouse Cloud, users will require an Open Telemetry collector to be running locally as described in the [getting started guide for this deployment model](/use-cases/observability/clickstack/deployment/hyperdx-clickhouse-cloud).
23
+
This sample dataset can also be used with HyperDX in ClickHouse Cloud, with only minor adjustments to the flow as noted. If using HyperDX in ClickHouse Cloud, users will require an OpenTelemetry collector to be running locally as described in the [getting started guide for this deployment model](/use-cases/observability/clickstack/deployment/hyperdx-clickhouse-cloud).
30
24
:::
31
25
32
26
<VerticalStepper>
33
27
34
-
## Navigate to the HyperDX UI {#navigate-to-the-hyperdx-ui}
35
-
36
-
Visit [http://localhost:8080](http://localhost:8080) to access the HyperDX UI if deploying locally. If using HyperDX in ClickHouse Cloud, select your service and `HyperDX` from the left menu.
37
-
38
-
## Copy ingestion API key {#copy-ingestion-api-key}
39
-
40
-
:::note HyperDX in ClickHouse Cloud
41
-
This step is not required if using HyperDX in ClickHouse Cloud.
42
-
:::
43
-
44
-
Navigate to [`Team Settings`](http://localhost:8080/team) and copy the `Ingestion API Key` from the `API Keys` section. This API key ensures data ingestion through the OpenTelemetry collector is secure.
45
-
46
-
<Imageimg={copy_api_key}alt="Copy API key"size="lg"/>
47
-
48
28
## Create a custom OpenTelemetry configuration {#create-otel-configuration}
49
29
50
30
Create a `custom-local-config.yaml` file with the following content:
@@ -57,8 +37,9 @@ receivers:
57
37
- /host/var/log/syslog
58
38
- /host/var/log/messages
59
39
- /host/private/var/log/*.log # macOS logs from host
60
-
- /tmp/all_events.log # macOS - see below
61
-
start_at: beginning # modify to collect new files only
40
+
start_at: beginning
41
+
resource:
42
+
service.name: "system-logs"
62
43
63
44
hostmetrics:
64
45
collection_interval: 1s
@@ -124,11 +105,7 @@ To avoid this behavior, you can set the start position to `end` in the receiver
124
105
125
106
For more details on the OpenTelemetry (OTel) configuration structure, we recommend [the official guide](https://opentelemetry.io/docs/collector/configuration/).
126
107
127
-
:::note Detailed logs for OSX
128
-
Users wanting more detailed logs on OSX can run the command `log stream --debug --style ndjson >> /tmp/all_events.log` before starting the collector below. This will capture detailed operating system logs to the file `/tmp/all_events.log`, already included in the above configuration.
129
-
:::
130
-
131
-
## Start the collector {#start-the-collector}
108
+
## Start ClickStack with custom configuration {#start-clickstack}
132
109
133
110
Run the following docker command to start the all-in-one container with your custom configuration:
134
111
@@ -149,7 +126,6 @@ We run the collector as the root user to access all system logs—this is necess
149
126
Note that we mount the host's `/var/log` to `/host/var/log` inside the container to avoid conflicts with the container's own log files.
150
127
:::
151
128
152
-
:::note HyperDX in ClickHouse Cloud
153
129
If using HyperDX in ClickHouse Cloud with a standalone collector, use this command instead:
154
130
155
131
```shell
@@ -166,13 +142,16 @@ docker run -d \
166
142
-v /private/var/log:/host/private/var/log:ro \
167
143
docker.hyperdx.io/hyperdx/hyperdx-otel-collector
168
144
```
169
-
:::
170
145
171
146
The collector will immediately begin collecting local system logs and metrics.
172
147
148
+
## Navigate to the HyperDX UI {#navigate-to-the-hyperdx-ui}
149
+
150
+
Visit [http://localhost:8080](http://localhost:8080) to access the HyperDX UI if deploying locally. If using HyperDX in ClickHouse Cloud, select your service and `HyperDX` from the left menu.
151
+
173
152
## Explore system logs {#explore-system-logs}
174
153
175
-
Navigate to the HyperDX UI. The search UI should be populated with local system logs. Expand the filters to select the `system.log`:
154
+
The search UI should be populated with local system logs. Expand the filters to select the `system.log`:
176
155
177
156
<Image img={hyperdx_20} alt="HyperDX Local logs" size="lg"/>
0 commit comments