|
| 1 | +--- |
| 2 | +slug: /use-cases/observability/clickstack/getting-started/otelgen |
| 3 | +title: 'otelgenで合成OpenTelemetryデータを生成' |
| 4 | +sidebar_label: 'otelgenで合成データを生成' |
| 5 | +sidebar_position: 5 |
| 6 | +pagination_prev: null |
| 7 | +pagination_next: null |
| 8 | +description: 'otelgenを使って、合成ログ、トレース、メトリクスをClickStack OpenTelemetry collectorへ送信する' |
| 9 | +doc_type: 'guide' |
| 10 | +toc_max_heading_level: 2 |
| 11 | +keywords: ['clickstack', 'otelgen', '合成データ', 'OpenTelemetry', 'テスト', 'ログ', 'トレース', 'メトリクス', 'オブザーバビリティ'] |
| 12 | +--- |
| 13 | + |
| 14 | +import Tabs from '@theme/Tabs'; |
| 15 | +import TabItem from '@theme/TabItem'; |
| 16 | + |
| 17 | +[`otelgen`](https://github.com/krzko/otelgen) は、合成 OTLP ログ、トレース、メトリクスを生成する小さな Go CLI です。これを使うと、既存の ClickStack OpenTelemetry collector がデータを受信しており、イベントが ClickStack UI に表示されることを確認できます。 |
| 18 | + |
| 19 | +このガイドでは、collector が `4317` (gRPC) および `4318` (HTTP) の OTLP エンドポイントですでに稼働していることを前提としています。 |
| 20 | + |
| 21 | +<Tabs groupId="sample-logs"> |
| 22 | + <TabItem value="managed-clickstack" label="Managed ClickStack" default> |
| 23 | + <VerticalStepper headerLevel="h3"> |
| 24 | + ### 前提条件 \{#prerequisites-managed\} |
| 25 | + |
| 26 | + このガイドは、[Managed ClickStack の Getting Started ガイド](/use-cases/observability/clickstack/deployment/clickstack-clickhouse-cloud) を完了しており、OTLP gRPC (`4317`) および HTTP (`4318`) の endpoint に、`otelgen` を実行するマシンから到達できる OpenTelemetry collector が稼働していることを前提としています。[collector の保護](/use-cases/observability/clickstack/ingesting-data/otel-collector#securing-the-collector) に従って `OTLP_AUTH_TOKEN` を設定している場合は、その値をすぐ使えるようにしておいてください。 |
| 27 | + |
| 28 | + ### otelgen をインストールする \{#install-otelgen-managed\} |
| 29 | + |
| 30 | + Homebrew でインストールします。 |
| 31 | + |
| 32 | + ```shell |
| 33 | + brew install krzko/tap/otelgen |
| 34 | + ``` |
| 35 | + |
| 36 | + または、Go でインストールします。 |
| 37 | + |
| 38 | + ```shell |
| 39 | + go install github.com/krzko/otelgen@latest |
| 40 | + ``` |
| 41 | + |
| 42 | + ### 環境変数を設定する \{#set-env-vars-managed\} |
| 43 | + |
| 44 | + collector の endpoint と、collector が保護されている場合は認証トークンを export します。 |
| 45 | + |
| 46 | + ```shell |
| 47 | + export OTEL_ENDPOINT=<host>:4317 |
| 48 | + export OTLP_AUTH_TOKEN=<your_otlp_auth_token> |
| 49 | + ``` |
| 50 | + |
| 51 | + collector の host と port を指定してください。同じマシン上で collector を実行している場合は、`localhost:4317` です。 |
| 52 | + |
| 53 | + :::note[保護されていない collector] |
| 54 | + ClickStack OpenTelemetry collector はデフォルトで認証なしです。[collector の保護](/use-cases/observability/clickstack/ingesting-data/otel-collector#securing-the-collector) に従って `OTLP_AUTH_TOKEN` を設定していない場合は、ここで `OTLP_AUTH_TOKEN` は省略し、以下のコマンドから `--header` フラグを削除してください。 |
| 55 | + ::: |
| 56 | + |
| 57 | + ### traces を生成する \{#generate-traces-managed\} |
| 58 | + |
| 59 | + 複数 span を含む traces を短時間バースト送信します。 |
| 60 | + |
| 61 | + ```shell |
| 62 | + otelgen --otel-exporter-otlp-endpoint ${OTEL_ENDPOINT} \ |
| 63 | + --header "authorization=${OTLP_AUTH_TOKEN}" \ |
| 64 | + --protocol grpc --insecure \ |
| 65 | + --rate 2 --duration 10 \ |
| 66 | + traces multi |
| 67 | + ``` |
| 68 | + |
| 69 | + `--rate` は 1 秒あたりの trace 数、`--duration` は実行時間 (秒) です。`--insecure` は gRPC connection の TLS を無効にします。これは、collector の平文 OTLP port を `otelgen` の接続先として使用する場合に必要です。 |
| 70 | + |
| 71 | + ### logs を生成する \{#generate-logs-managed\} |
| 72 | + |
| 73 | + ```shell |
| 74 | + otelgen --otel-exporter-otlp-endpoint ${OTEL_ENDPOINT} \ |
| 75 | + --header "authorization=${OTLP_AUTH_TOKEN}" \ |
| 76 | + --protocol grpc --insecure \ |
| 77 | + --rate 2 --duration 10 \ |
| 78 | + logs multi |
| 79 | + ``` |
| 80 | + |
| 81 | + ### メトリクスを生成する \{#generate-metrics-managed\} |
| 82 | + |
| 83 | + metrics のサブコマンドは `--duration` をサポートしていません。コマンドを実行し、数秒後に `Ctrl+C` を押して停止してください。 |
| 84 | + |
| 85 | + ```shell |
| 86 | + otelgen --otel-exporter-otlp-endpoint ${OTEL_ENDPOINT} \ |
| 87 | + --header "authorization=${OTLP_AUTH_TOKEN}" \ |
| 88 | + --protocol grpc --insecure \ |
| 89 | + --rate 2 \ |
| 90 | + metrics sum |
| 91 | + ``` |
| 92 | + |
| 93 | + `otelgen` は、`metrics` の下で `gauge`、`histogram`、`up-down-counter`、`exponential-histogram` の各サブコマンドもサポートしています。 |
| 94 | + |
| 95 | + ### ClickStack で確認する \{#verify-managed\} |
| 96 | + |
| 97 | + ClickHouse Cloud console から ClickStack UI を開きます。`Search` ビューで `Logs` と `Traces` の間でログソースを切り替え、新しいイベントが表示されることを確認してください。時間範囲は `Last 15 minutes` に設定します。`Chart Explorer` を開いて `Metrics` を選択し、`otelgen` が生成したメトリクス名の 1 つ (たとえば `otelgen.metrics.sum`) を chart して、メトリクスがインジェストされていることを確認します。 |
| 98 | + </VerticalStepper> |
| 99 | + </TabItem> |
| 100 | + |
| 101 | + <TabItem value="oss-clickstack" label="ClickStack オープンソース版"> |
| 102 | + <VerticalStepper headerLevel="h3"> |
| 103 | + ### 前提条件 \{#prerequisites-oss\} |
| 104 | + |
| 105 | + このガイドでは、[all-in-one イメージの手順](/use-cases/observability/clickstack/getting-started/oss)に従って Open Source ClickStack を起動済みであり、OTLP エンドポイント (`4317` gRPC および `4318` HTTP) にアクセスできることを前提としています。また、HyperDX UI の `Team Settings > API Keys` にあるインジェスト API key も必要です。 |
| 106 | + |
| 107 | + ### otelgen をインストールする \{#install-otelgen-oss\} |
| 108 | + |
| 109 | + Homebrew でインストールします。 |
| 110 | + |
| 111 | + ```shell |
| 112 | + brew install krzko/tap/otelgen |
| 113 | + ``` |
| 114 | + |
| 115 | + または Go でインストールします。 |
| 116 | + |
| 117 | + ```shell |
| 118 | + go install github.com/krzko/otelgen@latest |
| 119 | + ``` |
| 120 | + |
| 121 | + ### 環境変数を設定する \{#set-env-vars-oss\} |
| 122 | + |
| 123 | + collector endpoint とインジェスト API key をエクスポートします。 |
| 124 | + |
| 125 | + ```shell |
| 126 | + export OTEL_ENDPOINT=localhost:4317 |
| 127 | + export CLICKSTACK_API_KEY=<your_ingestion_api_key> |
| 128 | + ``` |
| 129 | + |
| 130 | + ### traces を生成する \{#generate-traces-oss\} |
| 131 | + |
| 132 | + 複数の span を含む traces を短時間にまとめて送信します。 |
| 133 | + |
| 134 | + ```shell |
| 135 | + otelgen --otel-exporter-otlp-endpoint ${OTEL_ENDPOINT} \ |
| 136 | + --header "authorization=${CLICKSTACK_API_KEY}" \ |
| 137 | + --protocol grpc --insecure \ |
| 138 | + --rate 2 --duration 10 \ |
| 139 | + traces multi |
| 140 | + ``` |
| 141 | + |
| 142 | + `--rate` は 1 秒あたりの traces 数、`--duration` は実行時間 (秒) です。`--insecure` はローカル collector に対する平文 gRPC を有効にします。 |
| 143 | + |
| 144 | + ### logs を生成する \{#generate-logs-oss\} |
| 145 | + |
| 146 | + ```shell |
| 147 | + otelgen --otel-exporter-otlp-endpoint ${OTEL_ENDPOINT} \ |
| 148 | + --header "authorization=${CLICKSTACK_API_KEY}" \ |
| 149 | + --protocol grpc --insecure \ |
| 150 | + --rate 2 --duration 10 \ |
| 151 | + logs multi |
| 152 | + ``` |
| 153 | + |
| 154 | + ### メトリクスを生成する \{#generate-metrics-oss\} |
| 155 | + |
| 156 | + `metrics` のサブコマンドは `--duration` をサポートしていません。コマンドを実行し、数秒後に `Ctrl+C` を押して停止してください。 |
| 157 | + |
| 158 | + ```shell |
| 159 | + otelgen --otel-exporter-otlp-endpoint ${OTEL_ENDPOINT} \ |
| 160 | + --header "authorization=${CLICKSTACK_API_KEY}" \ |
| 161 | + --protocol grpc --insecure \ |
| 162 | + --rate 2 \ |
| 163 | + metrics sum |
| 164 | + ``` |
| 165 | + |
| 166 | + `otelgen` は `metrics` 配下で `gauge`、`histogram`、`up-down-counter`、`exponential-histogram` の各サブコマンドもサポートしています。 |
| 167 | + |
| 168 | + ### ClickStack で確認する \{#verify-oss\} |
| 169 | + |
| 170 | + [http://localhost:8080](http://localhost:8080) にアクセスして ClickStack UI を開きます。`Search` ビューで、`Logs` と `Traces` を切り替えて新しいイベントを確認します。時間範囲を `Last 15 minutes` に設定します。`Chart Explorer` を開き、`Metrics` を選択して、`otelgen` が生成したメトリクス名の 1 つ (たとえば `otelgen.metrics.sum`) をチャート化し、メトリクスのインジェストを確認します。 |
| 171 | + </VerticalStepper> |
| 172 | + </TabItem> |
| 173 | +</Tabs> |
![locadex-agent[bot]](https://avatars.githubusercontent.com/in/1436158?v=4&size=40){kind=avatar}
0 commit comments