Skip to content

Commit 6e4aeb9

Browse files
committed
root user note
1 parent 7be782d commit 6e4aeb9

File tree

3 files changed

+15
-6
lines changed

3 files changed

+15
-6
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ The following settings are available for each source:
164164
| `Service Name Expression` | Expression or column for the service name. | Yes | Yes | `ServiceName` |
165165
| `Resource Attributes Expression`| Expression or column for resource-level attributes. | Yes | Yes | `ResourceAttributes` |
166166
| `Event Attributes Expression` | Expression or column for event attributes. | Yes | Yes | `SpanAttributes` |
167-
| `Span Events Expression` | Expression to extract span events. Typically a `Nested` type column. | Yes | Yes | `Events` |
167+
| `Span Events Expression` | Expression to extract span events. Typically a `Nested` type column. This allows rendering of exception stack traces with supported language SDKs. | Yes | Yes | `Events` |
168168
| `Implicit Column Expression` | Column used for full-text search if no field is specified (Lucene-style). Typically the log body. | Yes | Yes | `SpanName`|
169169

170170

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

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,11 +87,15 @@ receivers:
8787

8888
exporters:
8989
otlp:
90-
endpoint: host.docker.internal:4317
90+
endpoint: localhost:4317
9191
headers:
9292
authorization: <YOUR_INGESTION_API_KEY>
9393
tls:
9494
insecure: true
95+
sending_queue:
96+
enabled: true
97+
num_consumers: 10
98+
queue_size: 262144 # 262,144 items × ~8 KB per item ≈ 2 GB
9599

96100
service:
97101
pipelines:
@@ -120,14 +124,19 @@ For more details on the OpenTelemetry (OTel) configuration structure, we recomme
120124
Run the following docker command to start an instance of the OTel collector.
121125

122126
```bash
123-
docker run --rm -it \
127+
docker run --network=host --rm -it \
128+
--user 0:0 \
124129
-v "$(pwd)/otel-file-collector.yaml":/etc/otel/config.yaml \
125130
-v /var/log:/var/log:ro \
126131
-v /private/var/log:/private/var/log:ro \
127132
otel/opentelemetry-collector-contrib:latest \
128133
--config /etc/otel/config.yaml
129134
```
130135

136+
:::note Root user
137+
We run the collector as the root user to access all system logs—this is necessary to capture logs from protected paths on Linux-based systems. However, this approach is not recommended for production. In production environments, the OpenTelemetry Collector should be deployed as a local agent with only the minimal permissions required to access the intended log sources.
138+
:::
139+
131140
The collector will immediately begin collecting local system logs and metrics.
132141

133142
## Explore system logs {#explore-system-logs}

docs/use-cases/observability/clickstack/getting-started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ docker run -p 8080:8080 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hype
4545
```
4646

4747
:::note Persisting data and settings
48-
To persist data and settings across restarts of the container, users can modify the above docker command to mount the paths `/data/db`, `/var/lib/clickhouse` and `/var/log/clickhouse-server`. For example:
48+
To persist data and settings across restarts of the container, users can modify the above docker command to mount the paths `/data/db`, `/var/lib/clickhouse` and `/var/log/clickhouse-server`.
49+
50+
For example:
4951

5052
```bash
51-
# ensure directories exist
52-
mkdir -p .volumes/db .volumes/ch_data .volumes/ch_logs
5353
# modify command to mount paths
5454
docker run \
5555
-p 8080:8080 \

0 commit comments

Comments
 (0)