Skip to content

Commit 009ccce

Browse files
committed
removing sections that don't make sense
1 parent 2e39ec2 commit 009ccce

File tree

1 file changed

+11
-32
lines changed
  • docs/use-cases/observability/clickstack/example-datasets

1 file changed

+11
-32
lines changed

docs/use-cases/observability/clickstack/example-datasets/local-data.md

Lines changed: 11 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -10,41 +10,21 @@ keywords: ['clickstack', 'example data', 'sample dataset', 'logs', 'observabilit
1010
---
1111

1212
import Image from '@theme/IdealImage';
13-
import hyperdx from '@site/static/images/use-cases/observability/hyperdx-1.png';
1413
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';
1714
import hyperdx_21 from '@site/static/images/use-cases/observability/hyperdx-21.png';
1815
import hyperdx_22 from '@site/static/images/use-cases/observability/hyperdx-22.png';
1916
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';
2117

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.
2319

2420
**This example works on OSX and Linux systems only**
2521

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-
2822
:::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).
3024
:::
3125

3226
<VerticalStepper>
3327

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-
<Image img={copy_api_key} alt="Copy API key" size="lg"/>
47-
4828
## Create a custom OpenTelemetry configuration {#create-otel-configuration}
4929

5030
Create a `custom-local-config.yaml` file with the following content:
@@ -57,8 +37,9 @@ receivers:
5737
- /host/var/log/syslog
5838
- /host/var/log/messages
5939
- /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"
6243

6344
hostmetrics:
6445
collection_interval: 1s
@@ -124,11 +105,7 @@ To avoid this behavior, you can set the start position to `end` in the receiver
124105

125106
For more details on the OpenTelemetry (OTel) configuration structure, we recommend [the official guide](https://opentelemetry.io/docs/collector/configuration/).
126107

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}
132109

133110
Run the following docker command to start the all-in-one container with your custom configuration:
134111

@@ -149,7 +126,6 @@ We run the collector as the root user to access all system logs—this is necess
149126
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.
150127
:::
151128

152-
:::note HyperDX in ClickHouse Cloud
153129
If using HyperDX in ClickHouse Cloud with a standalone collector, use this command instead:
154130

155131
```shell
@@ -166,13 +142,16 @@ docker run -d \
166142
-v /private/var/log:/host/private/var/log:ro \
167143
docker.hyperdx.io/hyperdx/hyperdx-otel-collector
168144
```
169-
:::
170145

171146
The collector will immediately begin collecting local system logs and metrics.
172147

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+
173152
## Explore system logs {#explore-system-logs}
174153

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`:
176155

177156
<Image img={hyperdx_20} alt="HyperDX Local logs" size="lg"/>
178157

0 commit comments

Comments
 (0)