Skip to content

Commit 7d5970b

Browse files
committed
fix build
1 parent d3a0e70 commit 7d5970b

File tree

1 file changed

+97
-95
lines changed
  • i18n/jp/docusaurus-plugin-content-docs/current/use-cases/observability/clickstack/integration-examples

1 file changed

+97
-95
lines changed

i18n/jp/docusaurus-plugin-content-docs/current/use-cases/observability/clickstack/integration-examples/redis-metrics.md

Lines changed: 97 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ import { TrackedLink } from '@site/src/components/GalaxyTrackedLink/GalaxyTracke
4444
- 認証を有効にしている場合の Redis パスワード
4545

4646
<VerticalStepper headerLevel="h4">
47+
4748
#### Redis接続の確認
4849

4950
まず、Redisに接続できること、およびINFOコマンドが機能することを確認します:
@@ -66,9 +67,9 @@ import { TrackedLink } from '@site/src/components/GalaxyTrackedLink/GalaxyTracke
6667

6768
**一般的なRedisエンドポイント:**
6869

69-
* **ローカルインストール**: `localhost:6379`
70-
* **Docker**: コンテナ名またはサービス名を指定します(例: `redis:6379`
71-
* **リモート**: `<redis-host>:6379`
70+
* **ローカルインストール**: `localhost:6379`
71+
* **Docker**: コンテナ名またはサービス名を指定します(例: `redis:6379`
72+
* **リモート**: `<redis-host>:6379`
7273

7374
#### カスタムOTel collector設定を作成する
7475

@@ -122,110 +123,111 @@ import { TrackedLink } from '@site/src/components/GalaxyTrackedLink/GalaxyTracke
122123
123124
この設定では:
124125
125-
* `localhost:6379` 上の Redis に接続します(ご利用の環境に合わせてエンドポイントを調整してください)
126-
* 10秒ごとにメトリクスを収集します
127-
* 主要なパフォーマンスメトリクス(コマンド、クライアント、メモリ、キー空間の統計)を収集
128-
* [OpenTelemetry semantic conventions](https://opentelemetry.io/docs/specs/semconv/resource/#service) に従い、**必須の `service.name` リソース属性を設定します**
129-
* 専用パイプライン経由でメトリクスを ClickHouse エクスポーターに送信します
126+
* `localhost:6379` 上の Redis に接続します(ご利用の環境に合わせてエンドポイントを調整してください)
127+
* 10秒ごとにメトリクスを収集します
128+
* 主要なパフォーマンスメトリクス(コマンド、クライアント、メモリ、キー空間の統計)を収集
129+
* [OpenTelemetry semantic conventions](https://opentelemetry.io/docs/specs/semconv/resource/#service) に従い、**必須の `service.name` リソース属性を設定します**
130+
* 専用パイプライン経由でメトリクスを ClickHouse エクスポーターに送信します
130131

131132
**収集される主要メトリクス:**
132133

133-
* `redis.commands.processed` - 1秒あたりの処理済みコマンド数
134-
* `redis.clients.connected` - 接続中のクライアント数
135-
* `redis.clients.blocked` - ブロッキングコールでブロックされているクライアント数
136-
* `redis.memory.used` - Redis が使用しているメモリ(バイト単位)
137-
* `redis.memory.peak` - 最大メモリ使用量
138-
* `redis.keyspace.hits` - 成功したキー参照数
139-
* `redis.keyspace.misses` - キー検索の失敗数(キャッシュヒット率の算出に使用)
140-
* `redis.keys.expired` - 期限切れになったキー
141-
* `redis.keys.evicted` - メモリ不足により破棄されたキー数
142-
* `redis.connections.received` - 受信した接続の総数
143-
* `redis.connections.rejected` - 拒否された接続数
134+
* `redis.commands.processed` - 1秒あたりの処理済みコマンド数
135+
* `redis.clients.connected` - 接続中のクライアント数
136+
* `redis.clients.blocked` - ブロッキングコールでブロックされているクライアント数
137+
* `redis.memory.used` - Redis が使用しているメモリ(バイト単位)
138+
* `redis.memory.peak` - 最大メモリ使用量
139+
* `redis.keyspace.hits` - 成功したキー参照数
140+
* `redis.keyspace.misses` - キー検索の失敗数(キャッシュヒット率の算出に使用)
141+
* `redis.keys.expired` - 期限切れになったキー
142+
* `redis.keys.evicted` - メモリ不足により破棄されたキー数
143+
* `redis.connections.received` - 受信した接続の総数
144+
* `redis.connections.rejected` - 拒否された接続数
144145

145146
:::note
146147

147-
* カスタム設定では、新しい receiver、processor、pipeline のみを定義します
148-
* `memory_limiter` と `batch` の各 processor、および `clickhouse` exporter は、ベースの ClickStack 構成内ですでに定義されているため、名前を指定するだけで参照できます
149-
* `resource` プロセッサは、OpenTelemetry のセマンティック規約に従い、必須の `service.name` 属性を設定します
150-
* 認証付きの本番運用環境では、パスワードを環境変数 `${env:REDIS_PASSWORD}` に保存してください。
151-
* 必要に応じて `collection_interval` を調整します(デフォルトは 10s。値を小さくするとデータ量が増加します)
152-
* 複数の Redis インスタンスがある場合は、それらを区別するために `service.name` をカスタマイズしてください(例: `"redis-cache"`、`"redis-sessions"`)
148+
* カスタム設定では、新しい receiver、processor、pipeline のみを定義します
149+
* `memory_limiter` と `batch` の各 processor、および `clickhouse` exporter は、ベースの ClickStack 構成内ですでに定義されているため、名前を指定するだけで参照できます
150+
* `resource` プロセッサは、OpenTelemetry のセマンティック規約に従い、必須の `service.name` 属性を設定します
151+
* 認証付きの本番運用環境では、パスワードを環境変数 `${env:REDIS_PASSWORD}` に保存してください。
152+
* 必要に応じて `collection_interval` を調整します(デフォルトは 10s。値を小さくするとデータ量が増加します)
153+
* 複数の Redis インスタンスがある場合は、それらを区別するために `service.name` をカスタマイズしてください(例: `"redis-cache"`、`"redis-sessions"`)
153154

154155
#### ClickStackにカスタム設定を読み込ませる
155156

156157
既存のClickStackデプロイメントでカスタムコレクター設定を有効にするには、次の手順を実行してください:
157158

158-
1. カスタム構成ファイルを `/etc/otelcol-contrib/custom.config.yaml` にマウントします。
159-
2. 環境変数 `CUSTOM_OTELCOL_CONFIG_FILE=/etc/otelcol-contrib/custom.config.yaml` を設定してください
160-
3. ClickStack と Redis 間のネットワーク接続を確保する
161-
162-
##### オプション1: Docker Compose
163-
164-
ClickStackのデプロイメント設定を更新します:
165-
166-
```yaml
167-
services:
168-
clickstack:
169-
# ... 既存の設定 ...
170-
environment:
171-
- CUSTOM_OTELCOL_CONFIG_FILE=/etc/otelcol-contrib/custom.config.yaml
172-
# オプション: Redis で認証が必要な場合
173-
# - REDIS_PASSWORD=your-redis-password
174-
# ... その他の環境変数 ...
175-
volumes:
176-
- ./redis-metrics.yaml:/etc/otelcol-contrib/custom.config.yaml:ro
177-
# ... その他のボリューム ...
178-
# Redis が同じ compose ファイル内にある場合:
179-
depends_on:
180-
- redis
181-
182-
redis:
183-
image: redis:7-alpine
184-
ports:
185-
- "6379:6379"
186-
# オプション: 認証を有効にする
187-
# command: redis-server --requirepass your-redis-password
188-
```
189-
190-
##### オプション2:Docker run(オールインワンイメージ)
191-
192-
`docker run`でオールインワンイメージを使用する場合:
193-
194-
```bash
195-
docker run --name clickstack \
196-
-p 8080:8080 -p 4317:4317 -p 4318:4318 \
197-
-e CUSTOM_OTELCOL_CONFIG_FILE=/etc/otelcol-contrib/custom.config.yaml \
198-
-v "$(pwd)/redis-metrics.yaml:/etc/otelcol-contrib/custom.config.yaml:ro" \
199-
clickhouse/clickstack-all-in-one:latest
200-
```
201-
202-
**重要:** Redisが別のコンテナで実行されている場合は、Dockerネットワーキングを使用してください:
203-
204-
```bash
205-
# ネットワークを作成
206-
docker network create monitoring
207-
208-
# ネットワーク上でRedisを実行
209-
docker run -d --name redis --network monitoring redis:7-alpine
210-
211-
# 同じネットワーク上でClickStackを実行(設定ファイル内のエンドポイントを "redis:6379" に更新)
212-
docker run --name clickstack \
213-
--network monitoring \
214-
-p 8080:8080 -p 4317:4317 -p 4318:4318 \
215-
-e CUSTOM_OTELCOL_CONFIG_FILE=/etc/otelcol-contrib/custom.config.yaml \
216-
-v "$(pwd)/redis-metrics.yaml:/etc/otelcol-contrib/custom.config.yaml:ro" \
217-
clickhouse/clickstack-all-in-one:latest
218-
```
219-
220-
#### HyperDXでメトリクスを確認する
221-
222-
設定完了後、HyperDXにログインし、メトリクスが正常に送信されていることを確認します:
223-
224-
1. 「Metrics explorer」に移動します
225-
2. `redis.` で始まるメトリクス(例: `redis.commands.processed`, `redis.memory.used`)を検索します。
226-
3. 設定した収集間隔でメトリクスのデータポイントが表示されるはずです
159+
1. カスタム構成ファイルを `/etc/otelcol-contrib/custom.config.yaml` にマウントします。
160+
2. 環境変数 `CUSTOM_OTELCOL_CONFIG_FILE=/etc/otelcol-contrib/custom.config.yaml` を設定してください
161+
3. ClickStack と Redis 間のネットワーク接続を確保する
162+
163+
##### オプション1: Docker Compose
164+
165+
ClickStackのデプロイメント設定を更新します:
166+
167+
```yaml
168+
services:
169+
clickstack:
170+
# ... 既存の設定 ...
171+
environment:
172+
- CUSTOM_OTELCOL_CONFIG_FILE=/etc/otelcol-contrib/custom.config.yaml
173+
# オプション: Redis で認証が必要な場合
174+
# - REDIS_PASSWORD=your-redis-password
175+
# ... その他の環境変数 ...
176+
volumes:
177+
- ./redis-metrics.yaml:/etc/otelcol-contrib/custom.config.yaml:ro
178+
# ... その他のボリューム ...
179+
# Redis が同じ compose ファイル内にある場合:
180+
depends_on:
181+
- redis
182+
183+
redis:
184+
image: redis:7-alpine
185+
ports:
186+
- "6379:6379"
187+
# オプション: 認証を有効にする
188+
# command: redis-server --requirepass your-redis-password
189+
```
190+
191+
##### オプション2:Docker run(オールインワンイメージ)
192+
193+
`docker run`でオールインワンイメージを使用する場合:
194+
195+
```bash
196+
docker run --name clickstack \
197+
-p 8080:8080 -p 4317:4317 -p 4318:4318 \
198+
-e CUSTOM_OTELCOL_CONFIG_FILE=/etc/otelcol-contrib/custom.config.yaml \
199+
-v "$(pwd)/redis-metrics.yaml:/etc/otelcol-contrib/custom.config.yaml:ro" \
200+
clickhouse/clickstack-all-in-one:latest
201+
```
202+
203+
**重要:** Redisが別のコンテナで実行されている場合は、Dockerネットワーキングを使用してください:
204+
205+
```bash
206+
# ネットワークを作成
207+
docker network create monitoring
208+
209+
# ネットワーク上でRedisを実行
210+
docker run -d --name redis --network monitoring redis:7-alpine
211+
212+
# 同じネットワーク上でClickStackを実行(設定ファイル内のエンドポイントを "redis:6379" に更新)
213+
docker run --name clickstack \
214+
--network monitoring \
215+
-p 8080:8080 -p 4317:4317 -p 4318:4318 \
216+
-e CUSTOM_OTELCOL_CONFIG_FILE=/etc/otelcol-contrib/custom.config.yaml \
217+
-v "$(pwd)/redis-metrics.yaml:/etc/otelcol-contrib/custom.config.yaml:ro" \
218+
clickhouse/clickstack-all-in-one:latest
219+
```
220+
221+
#### HyperDXでメトリクスを確認する
222+
223+
設定完了後、HyperDXにログインし、メトリクスが正常に送信されていることを確認します:
224+
225+
1. 「Metrics explorer」に移動します
226+
2. `redis.` で始まるメトリクス(例: `redis.commands.processed`, `redis.memory.used`)を検索します。
227+
3. 設定した収集間隔でメトリクスのデータポイントが表示されるはずです
228+
229+
{/* <Image img={metrics_view} alt="Redis メトリクスビュー"/> */ }
227230

228-
{/* <Image img={metrics_view} alt="Redis メトリクスビュー"/> */ }
229231
</VerticalStepper>
230232

231233
## デモ用データセット {#demo-dataset}

0 commit comments

Comments
 (0)