Skip to content

Commit d3a0e70

Browse files
BlargianBlargian
committed
fix build issues
1 parent 2c6055f commit d3a0e70

File tree

3 files changed

+429
-423
lines changed
  • i18n
    • jp/docusaurus-plugin-content-docs/current/use-cases/observability/clickstack/example-datasets
    • ru/docusaurus-plugin-content-docs/current/use-cases/observability/clickstack/example-datasets
    • zh/docusaurus-plugin-content-docs/current/use-cases/observability/clickstack/example-datasets

3 files changed

+429
-423
lines changed

‎i18n/jp/docusaurus-plugin-content-docs/current/use-cases/observability/clickstack/example-datasets/local-data.md‎

Lines changed: 143 additions & 141 deletions
Original file line numberDiff line numberDiff line change
@@ -23,154 +23,156 @@ import hyperdx_23 from '@site/static/images/use-cases/observability/hyperdx-23.p
2323
このサンプルデータセットは、記載されているとおり手順にわずかな調整を加えるだけで、ClickHouse Cloud 上の HyperDX でも使用できます。ClickHouse Cloud で HyperDX を使用する場合は、[このデプロイメントモデル向けの入門ガイド](/use-cases/observability/clickstack/deployment/hyperdx-clickhouse-cloud)で説明されているように、ローカルで実行される OpenTelemetry collector が必要です。
2424
:::
2525

26-
<VerticalStepper>
27-
## カスタムOpenTelemetry設定を作成する {#create-otel-configuration}
28-
29-
以下の内容で `custom-local-config.yaml` ファイルを作成します：
30-
31-
```yaml
32-
receivers:
33-
filelog:
34-
include:
35-
- /host/var/log/**/*.log # ホストからのLinuxログ
36-
- /host/var/log/syslog
37-
- /host/var/log/messages
38-
- /host/private/var/log/*.log # ホストからのmacOSログ
39-
start_at: beginning
40-
resource:
41-
service.name: "system-logs"
42-
43-
hostmetrics:
44-
collection_interval: 1s
45-
scrapers:
46-
cpu:
47-
metrics:
48-
system.cpu.time:
49-
enabled: true
50-
system.cpu.utilization:
51-
enabled: true
52-
memory:
53-
metrics:
54-
system.memory.usage:
55-
enabled: true
56-
system.memory.utilization:
57-
enabled: true
58-
filesystem:
59-
metrics:
60-
system.filesystem.usage:
61-
enabled: true
62-
system.filesystem.utilization:
63-
enabled: true
64-
paging:
65-
metrics:
66-
system.paging.usage:
67-
enabled: true
68-
system.paging.utilization:
69-
enabled: true
70-
system.paging.faults:
71-
enabled: true
72-
disk:
73-
load:
74-
network:
75-
processes:
76-
77-
service:
78-
pipelines:
79-
logs/local:
80-
receivers: [filelog]
81-
processors:
82-
- memory_limiter
83-
- batch
84-
exporters:
85-
- clickhouse
86-
metrics/hostmetrics:
87-
receivers: [hostmetrics]
88-
processors:
89-
- memory_limiter
90-
- batch
91-
exporters:
92-
- clickhouse
93-
```
94-
95-
この設定は、macOSおよびLinuxシステムのシステムログとメトリクスを収集し、結果をClickStackに送信します。この設定では、新しいレシーバーとパイプラインを追加することでClickStackコレクターを拡張します。ベースのClickStackコレクターで既に設定されている`clickhouse`エクスポーターとプロセッサー（`memory_limiter`、`batch`）を参照してください。
96-
97-
:::note インジェストのタイムスタンプ
98-
この設定はインジェスト時にタイムスタンプを調整し、各イベントに更新された時刻値を割り当てます。正確なイベント時刻を保持するために、ユーザーはログファイル内の[タイムスタンプを前処理または解析](/use-cases/observability/clickstack/ingesting-data/otel-collector#processing-filtering-transforming-enriching)する際に、OTelプロセッサーまたはオペレーターを使用することを推奨します。
99-
100-
この設定例では、receiverまたはfileプロセッサがファイルの先頭から開始するように構成されている場合、既存のすべてのログエントリには同一の調整済みタイムスタンプ（元のイベント時刻ではなく処理時刻）が割り当てられます。ファイルに追加される新しいイベントには、実際の生成時刻に近似したタイムスタンプが付与されます。
101-
102-
この動作を回避するには、レシーバー設定で開始位置を `end` に設定します。これにより、新しいエントリのみが取り込まれ、実際の到着時刻に近いタイムスタンプが付与されます。
103-
:::
104-
105-
OpenTelemetry (OTel) の設定構造の詳細については、[公式ガイド](https://opentelemetry.io/docs/collector/configuration/)を参照してください。
106-
107-
## カスタム設定でClickStackを起動する {#start-clickstack}
108-
109-
カスタム設定でオールインワンコンテナを起動するには、以下のdockerコマンドを実行します:
110-
111-
```shell
112-
docker run -d --name clickstack \
113-
-p 8080:8080 -p 4317:4317 -p 4318:4318 \
114-
--user 0:0 \
115-
-e CUSTOM_OTELCOL_CONFIG_FILE=/etc/otelcol-contrib/custom.config.yaml \
116-
-v "$(pwd)/custom-local-config.yaml:/etc/otelcol-contrib/custom.config.yaml:ro" \
117-
-v /var/log:/host/var/log:ro \
118-
-v /private/var/log:/host/private/var/log:ro \
119-
clickhouse/clickstack-all-in-one:latest
120-
```
121-
122-
:::note rootユーザー
123-
すべてのシステムログにアクセスするため、コレクターをrootユーザーとして実行します。これは、Linuxベースのシステムにおいて保護されたパスからログを取得するために必要です。ただし、この方法は本番環境では推奨されません。本番環境では、OpenTelemetry Collectorは、意図するログソースへのアクセスに必要な最小限の権限のみを持つローカルエージェントとしてデプロイする必要があります。
124-
125-
ホストの `/var/log` をコンテナ内の `/host/var/log` にマウントすることで、コンテナ自身のログファイルとの競合を回避しています。
126-
:::
127-
128-
スタンドアロンコレクターでClickHouse CloudのHyperDXを使用する場合は、代わりに以下のコマンドを使用してください：
129-
130-
```shell
131-
docker run -d \
132-
-p 4317:4317 -p 4318:4318 \
133-
--user 0:0 \
134-
-e CUSTOM_OTELCOL_CONFIG_FILE=/etc/otelcol-contrib/custom.config.yaml \
135-
-e OPAMP_SERVER_URL=${OPAMP_SERVER_URL} \
136-
-e CLICKHOUSE_ENDPOINT=${CLICKHOUSE_ENDPOINT} \
137-
-e CLICKHOUSE_USER=${CLICKHOUSE_USER} \
138-
-e CLICKHOUSE_PASSWORD=${CLICKHOUSE_PASSWORD} \
139-
-v "$(pwd)/custom-local-config.yaml:/etc/otelcol-contrib/custom.config.yaml:ro" \
140-
-v /var/log:/host/var/log:ro \
141-
-v /private/var/log:/host/private/var/log:ro \
142-
clickhouse/clickstack-otel-collector:latest
143-
```
144-
145-
コレクターは即座にローカルシステムのログとメトリクスの収集を開始します。
146-
147-
## HyperDX UIへ移動する {#navigate-to-the-hyperdx-ui}
148-
149-
ローカルにデプロイする場合は、[http://localhost:8080](http://localhost:8080)にアクセスしてHyperDX UIを開きます。ClickHouse CloudでHyperDXを使用する場合は、サービスを選択し、左メニューから`HyperDX`を選択します。
150-
151-
## システムログの確認 {#explore-system-logs}
152-
153-
検索UIにローカルシステムログが表示されます。フィルタを展開して`system.log`を選択します：
154-
155-
<Image img={hyperdx_20} alt="HyperDX ローカルログ" size="lg" />
156-
157-
## システムメトリクスを確認する {#explore-system-metrics}
26+
<VerticalStepper headerLevel="h2">
27+
28+
## カスタムOpenTelemetry設定を作成する {#create-otel-configuration}
29+
30+
以下の内容で `custom-local-config.yaml` ファイルを作成します：
31+
32+
```yaml
33+
receivers:
34+
filelog:
35+
include:
36+
- /host/var/log/**/*.log # ホストからのLinuxログ
37+
- /host/var/log/syslog
38+
- /host/var/log/messages
39+
- /host/private/var/log/*.log # ホストからのmacOSログ
40+
start_at: beginning
41+
resource:
42+
service.name: "system-logs"
43+
44+
hostmetrics:
45+
collection_interval: 1s
46+
scrapers:
47+
cpu:
48+
metrics:
49+
system.cpu.time:
50+
enabled: true
51+
system.cpu.utilization:
52+
enabled: true
53+
memory:
54+
metrics:
55+
system.memory.usage:
56+
enabled: true
57+
system.memory.utilization:
58+
enabled: true
59+
filesystem:
60+
metrics:
61+
system.filesystem.usage:
62+
enabled: true
63+
system.filesystem.utilization:
64+
enabled: true
65+
paging:
66+
metrics:
67+
system.paging.usage:
68+
enabled: true
69+
system.paging.utilization:
70+
enabled: true
71+
system.paging.faults:
72+
enabled: true
73+
disk:
74+
load:
75+
network:
76+
processes:
77+
78+
service:
79+
pipelines:
80+
logs/local:
81+
receivers: [filelog]
82+
processors:
83+
- memory_limiter
84+
- batch
85+
exporters:
86+
- clickhouse
87+
metrics/hostmetrics:
88+
receivers: [hostmetrics]
89+
processors:
90+
- memory_limiter
91+
- batch
92+
exporters:
93+
- clickhouse
94+
```
95+
96+
この設定は、macOSおよびLinuxシステムのシステムログとメトリクスを収集し、結果をClickStackに送信します。この設定では、新しいレシーバーとパイプラインを追加することでClickStackコレクターを拡張します。ベースのClickStackコレクターで既に設定されている`clickhouse`エクスポーターとプロセッサー（`memory_limiter`、`batch`）を参照してください。
97+
98+
:::note インジェストのタイムスタンプ
99+
この設定はインジェスト時にタイムスタンプを調整し、各イベントに更新された時刻値を割り当てます。正確なイベント時刻を保持するために、ユーザーはログファイル内の[タイムスタンプを前処理または解析](/use-cases/observability/clickstack/ingesting-data/otel-collector#processing-filtering-transforming-enriching)する際に、OTelプロセッサーまたはオペレーターを使用することを推奨します。
100+
101+
この設定例では、receiverまたはfileプロセッサがファイルの先頭から開始するように構成されている場合、既存のすべてのログエントリには同一の調整済みタイムスタンプ（元のイベント時刻ではなく処理時刻）が割り当てられます。ファイルに追加される新しいイベントには、実際の生成時刻に近似したタイムスタンプが付与されます。
102+
103+
この動作を回避するには、レシーバー設定で開始位置を `end` に設定します。これにより、新しいエントリのみが取り込まれ、実際の到着時刻に近いタイムスタンプが付与されます。
104+
:::
105+
106+
OpenTelemetry (OTel) の設定構造の詳細については、[公式ガイド](https://opentelemetry.io/docs/collector/configuration/)を参照してください。
107+
108+
## カスタム設定でClickStackを起動する {#start-clickstack}
109+
110+
カスタム設定でオールインワンコンテナを起動するには、以下のdockerコマンドを実行します:
111+
112+
```shell
113+
docker run -d --name clickstack \
114+
-p 8080:8080 -p 4317:4317 -p 4318:4318 \
115+
--user 0:0 \
116+
-e CUSTOM_OTELCOL_CONFIG_FILE=/etc/otelcol-contrib/custom.config.yaml \
117+
-v "$(pwd)/custom-local-config.yaml:/etc/otelcol-contrib/custom.config.yaml:ro" \
118+
-v /var/log:/host/var/log:ro \
119+
-v /private/var/log:/host/private/var/log:ro \
120+
clickhouse/clickstack-all-in-one:latest
121+
```
122+
123+
:::note rootユーザー
124+
すべてのシステムログにアクセスするため、コレクターをrootユーザーとして実行します。これは、Linuxベースのシステムにおいて保護されたパスからログを取得するために必要です。ただし、この方法は本番環境では推奨されません。本番環境では、OpenTelemetry Collectorは、意図するログソースへのアクセスに必要な最小限の権限のみを持つローカルエージェントとしてデプロイする必要があります。
125+
126+
ホストの `/var/log` をコンテナ内の `/host/var/log` にマウントすることで、コンテナ自身のログファイルとの競合を回避しています。
127+
:::
128+
129+
スタンドアロンコレクターでClickHouse CloudのHyperDXを使用する場合は、代わりに以下のコマンドを使用してください：
130+
131+
```shell
132+
docker run -d \
133+
-p 4317:4317 -p 4318:4318 \
134+
--user 0:0 \
135+
-e CUSTOM_OTELCOL_CONFIG_FILE=/etc/otelcol-contrib/custom.config.yaml \
136+
-e OPAMP_SERVER_URL=${OPAMP_SERVER_URL} \
137+
-e CLICKHOUSE_ENDPOINT=${CLICKHOUSE_ENDPOINT} \
138+
-e CLICKHOUSE_USER=${CLICKHOUSE_USER} \
139+
-e CLICKHOUSE_PASSWORD=${CLICKHOUSE_PASSWORD} \
140+
-v "$(pwd)/custom-local-config.yaml:/etc/otelcol-contrib/custom.config.yaml:ro" \
141+
-v /var/log:/host/var/log:ro \
142+
-v /private/var/log:/host/private/var/log:ro \
143+
clickhouse/clickstack-otel-collector:latest
144+
```
145+
146+
コレクターは即座にローカルシステムのログとメトリクスの収集を開始します。
147+
148+
## HyperDX UIへ移動する {#navigate-to-the-hyperdx-ui}
149+
150+
ローカルにデプロイする場合は、[http://localhost:8080](http://localhost:8080)にアクセスしてHyperDX UIを開きます。ClickHouse CloudでHyperDXを使用する場合は、サービスを選択し、左メニューから`HyperDX`を選択します。
151+
152+
## システムログの確認 {#explore-system-logs}
153+
154+
検索UIにローカルシステムログが表示されます。フィルタを展開して`system.log`を選択します：
155+
156+
<Image img={hyperdx_20} alt="HyperDX ローカルログ" size="lg" />
157+
158+
## システムメトリクスを確認する {#explore-system-metrics}
159+
160+
チャートを使用してメトリクスを確認できます。
158161

159-
チャートを使用してメトリクスを確認できます。
162+
左側のメニューから Chart Explorer に移動します。ソースとして `Metrics` を選択し、集計タイプとして `Maximum` を選択します。
160163

161-
左側のメニューから Chart Explorer に移動します。ソースとして `Metrics` を選択し、集計タイプとして `Maximum` を選択します。
164+
`Select a Metric`メニューで、`system.memory.utilization (Gauge)`を選択する前に`memory`と入力します。
162165

163-
`Select a Metric`メニューで、`system.memory.utilization (Gauge)`を選択する前に`memory`と入力します。
166+
実行ボタンを押して、時系列でのメモリ使用率を可視化します。
164167

165-
実行ボタンを押して、時系列でのメモリ使用率を可視化します。
168+
<Image img={hyperdx_21} alt="メモリ使用量の推移" size="lg" />
166169

167-
<Image img={hyperdx_21} alt="メモリ使用量の推移" size="lg" />
170+
数値は浮動小数点の`%`として返されます。より明確に表示するには、`数値形式を設定`を選択してください。
168171

169-
数値は浮動小数点の`%`として返されます。より明確に表示するには、`数値形式を設定`を選択してください。
172+
<Image img={hyperdx_22} alt="数値形式" size="lg" />
170173

171-
<Image img={hyperdx_22} alt="数値形式" size="lg" />
174+
表示されたメニューで、`Output format`ドロップダウンから`Percentage`を選択し、`Apply`をクリックします。
172175

173-
表示されたメニューで、`Output format`ドロップダウンから`Percentage`を選択し、`Apply`をクリックします。
176+
<Image img={hyperdx_23} alt="メモリに費やした時間の割合（％）" size="lg" />
174177

175-
<Image img={hyperdx_23} alt="メモリに費やした時間の割合（％）" size="lg" />
176178
</VerticalStepper>

0 commit comments

Comments
 (0)