Skip to content

Commit 7be782d

Browse files
committed
notes
1 parent 9c5b2ad commit 7be782d

File tree

4 files changed

+15
-9
lines changed

4 files changed

+15
-9
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The following configuration options are available for each component of ClickSta
1919
If using the [All in One](/use-cases/observability/clickstack/deployment/all-in-one), [HyperDX Only](/use-cases/observability/clickstack/deployment/hyperdx-only) or [Local Mode](/use-cases/observability/clickstack/deployment/local-mode-only) simply pass the desired setting via an environment variable e.g.
2020

2121
```bash
22-
docker run -e HYPERDX_LOG_LEVEL='debug' -p 8080:8080 -p 8123:8123 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-all-in-one:2-nightly
22+
docker run -e HYPERDX_LOG_LEVEL='debug' -p 8080:8080 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-all-in-one:2-nightly
2323
```
2424

2525
### Docker compose {#docker-compose}

docs/use-cases/observability/clickstack/deployment/all-in-one.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ This option includes authentication, enabling the persistence of dashboards, ale
3232

3333
### Deploy with Docker {#deploy-with-docker}
3434

35-
The following will run an OpenTelemetry collector (on port 4317 and 4318), ClickHouse (on port 8123), and the HyperDX UI (on port 8080).
35+
The following will run an OpenTelemetry collector (on port 4317 and 4318) and the HyperDX UI (on port 8080).
3636

3737
```bash
38-
docker run -p 8080:8080 -p 8123:8123 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-all-in-one:2-nightly
38+
docker run -p 8080:8080 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-all-in-one:2-nightly
3939
```
4040

4141
### Navigate to the HyperDX UI {#navigate-to-hyperdx-ui}
@@ -66,7 +66,6 @@ mkdir -p .volumes/db .volumes/ch_data .volumes/ch_logs
6666
# modify command to mount paths
6767
docker run \
6868
-p 8080:8080 \
69-
-p 8123:8123 \
7069
-p 4317:4317 \
7170
-p 4318:4318 \
7271
-v "$(pwd)/.volumes/db:/data/db" \
@@ -89,7 +88,7 @@ If you need to customize the application (8080) or API (8000) ports that HyperDX
8988
Customizing the OpenTelemetry ports can simply be changed by modifying the port forwarding flags. For example, replacing `-p 4318:4318` with `-p 4999:4318` to change the OpenTelemetry HTTP port to 4999.
9089

9190
```bash
92-
docker run -p 8080:8080 -p 8123:8123 -p 4317:4317 -p 4999:4318 docker.hyperdx.io/hyperdx/hyperdx-all-in-one:2-nightly
91+
docker run -p 8080:8080 -p 4317:4317 -p 4999:4318 docker.hyperdx.io/hyperdx/hyperdx-all-in-one:2-nightly
9392
```
9493

9594
## Using ClickHouse Cloud {#using-clickhouse-cloud}

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

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ receivers:
4949
- /var/log/syslog
5050
- /var/log/messages
5151
- /private/var/log/*.log # macOS
52-
start_at: beginning
52+
start_at: beginning # modify to collect new files only
5353

5454
hostmetrics:
5555
collection_interval: 1s
@@ -105,6 +105,14 @@ service:
105105
106106
This configuration collects system logs and metric for OSX and Linux systems, sending the results to ClickStack via the OTLP endpoint on port 4317.
107107
108+
:::note Ingestion timestamps
109+
This configuration adjusts timestamps at ingest, assigning an updated time value to each event. Users should ideally [preprocess or parse timestamps](/use-cases/observability/clickstack/ingesting-data/otel-collector#processing-filtering-transforming-enriching) using OTel processors or operators in their log files to ensure accurate event time is retained.
110+
111+
With this example setup, if the receiver or file processor is configured to start at the beginning of the file, all existing log entries will be assigned the same adjusted timestamp - the time of processing rather than the original event time. Any new events appended to the file will receive timestamps approximating their actual generation time.
112+
113+
To avoid this behavior, you can set the start position to `end` in the receiver configuration. This ensures only new entries are ingested and timestamped near their true arrival time.
114+
:::
115+
108116
For more details on the OpenTelemetry (OTel) configuration structure, we recommend [the official guide](https://opentelemetry.io/docs/collector/configuration/).
109117

110118
## Start the collector {#start-the-collector}

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ This all-in-one image allows you to launch the full stack with a single command,
3838

3939
### Deploy stack with docker {#deploy-stack-with-docker}
4040

41-
The following will run an OpenTelemetry collector (on port 4317 and 4318), ClickHouse (on port 8123), and the HyperDX UI (on port 8080).
41+
The following will run an OpenTelemetry collector (on port 4317 and 4318) and the HyperDX UI (on port 8080).
4242

4343
```bash
44-
docker run -p 8080:8080 -p 8123:8123 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-all-in-one:2-nightly
44+
docker run -p 8080:8080 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-all-in-one:2-nightly
4545
```
4646

4747
:::note Persisting data and settings
@@ -53,7 +53,6 @@ mkdir -p .volumes/db .volumes/ch_data .volumes/ch_logs
5353
# modify command to mount paths
5454
docker run \
5555
-p 8080:8080 \
56-
-p 8123:8123 \
5756
-p 4317:4317 \
5857
-p 4318:4318 \
5958
-v "$(pwd)/.volumes/db:/data/db" \

0 commit comments

Comments
 (0)