From 26c52db9336ade4927b7653293cf74447d20d487 Mon Sep 17 00:00:00 2001 From: Yoshi Yamaguchi Date: Thu, 25 Jul 2024 13:06:11 +0900 Subject: [PATCH 1/4] feat: add Japanese translation of quick start of collector --- content/ja/docs/collector/quick-start.md | 132 +++++++++++++++++++++++ 1 file changed, 132 insertions(+) create mode 100644 content/ja/docs/collector/quick-start.md diff --git a/content/ja/docs/collector/quick-start.md b/content/ja/docs/collector/quick-start.md new file mode 100644 index 000000000000..594934ab851f --- /dev/null +++ b/content/ja/docs/collector/quick-start.md @@ -0,0 +1,132 @@ +--- +title: クイックスタート +cSpell:ignore: docker dokey dpkg okey telemetrygen +description: コレクターをセットアップとテレメトリーの収集をすぐに始めてみましょう！ +aliases: [getting-started] +weight: 1 +cSpell:ignore: gobin +default_lang_commit: 78f1d31 +--- + + + +OpenTelemetryコレクターは、[トレース](/docs/concepts/signals/traces/)、[メトリクス](/docs/concepts/signals/metrics/)、[ログ](/docs/concepts/signals/logs/)を受け取り、テレメトリーを処理し、そのコンポーネントを使用してさまざまなオブザーバビリティバックエンドにエクスポートします。 +コレクターの概念的な概要については、[コレクター](/docs/collector)のページを参照してください。 + +本記事でたった5分で次の内容を学習できます。 + +- OpenTelemetryコレクターをセットアップして実行する +- テレメトリーを送信し、コレクターによって処理されるのを確認する + +## 事前要件 + +開発環境が以下の要件を満たしていることを確認してください。 +このページでは `bash` を使っていると仮定しています。 +お好みのシェルに合わせて、設定やコマンドを変更してください。 + +- [Docker](https://www.docker.com/)、あるいは他の互換コンテナランタイム +- [Go](https://go.dev/) 1.20以上 +- [`GOBIN` 環境変数][gobin]が設定されていること。もし設定されていなければ、適切に設定してください。次は一例です[^1]。 + ```sh + export GOBIN=${GOBIN:-$(go env GOPATH)/bin} + ``` + +[^1]: + 詳細については、Goの公式サイトにある[Your first program](https://go.dev/doc/code#Command)のドキュメントを参照してください。 + +## 環境の設定 + +1. OpenTelemetryコレクターのDockerイメージをプルします。 + + ```sh + docker pull otel/opentelemetry-collector:{{% param vers %}} + ``` + +2. [telemetrygen]ユーティリティをインストールします。 + + ```sh + go install github.com/open-telemetry/opentelemetry-collector-contrib/cmd/telemetrygen@latest + ``` + + このユーティリティは[トレース][traces]、[メトリクス][metrics]、[ログ][logs]を生成するクライアントをシミュレートできます。 + +## テレメトリーの生成と収集 + +3. コレクターを起動します。 + + ```sh + docker run \ + -p 127.0.0.1:4317:4317 \ + -p 127.0.0.1:55679:55679 \ + otel/opentelemetry-collector:{{% param vers %}} \ + 2>&1 | tee collector-output.txt # 補足的に出力をteeして後で検索しやすくする + ``` + +4. 別のターミナル窓でサンプルのトレースを生成します。 + + ```sh + $GOBIN/telemetrygen traces --otlp-insecure --traces 3 + ``` + + ユーティリティによって生成された出力の中に、トレースが生成されたことのログが表示されるはずです。 + + ```text + 2024-01-16T14:33:15.692-0500 INFO traces/worker.go:99 traces generated {"worker": 0, "traces": 3} + 2024-01-16T14:33:15.692-0500 INFO traces/traces.go:58 stop the batch span processor + ``` + + 関連する出力を簡単に見るには、フィルタリングすると良いでしょう。 + + ```sh + $GOBIN/telemetrygen traces --otlp-insecure \ + --traces 3 2>&1 | grep -E 'start|traces|stop' + ``` + +5. コレクターコンテナを実行しているターミナル窓に、以下の例に示すようなトレースを取り込んだ様子が表示されるはずです。 + + ```console + $ grep -E '^Span|(ID|Name|Kind|time|Status \w+)\s+:' ./collector-output.txt + Span #0 + Trace ID : f30faffbde5fcf71432f89da1bf7bc14 + Parent ID : 6f1ff7f9cf4ec1c7 + ID : 8d1e820c1ac57337 + Name : okey-dokey + Kind : Server + Start time : 2024-01-16 14:13:54.585877 +0000 UTC + End time : 2024-01-16 14:13:54.586 +0000 UTC + Status code : Unset + Status message : + Span #1 + Trace ID : f30faffbde5fcf71432f89da1bf7bc14 + Parent ID : + ID : 6f1ff7f9cf4ec1c7 + Name : lets-go + Kind : Client + Start time : 2024-01-16 14:13:54.585877 +0000 UTC + End time : 2024-01-16 14:13:54.586 +0000 UTC + Status code : Unset + Status message : + ... + ``` + +6. を開いて、表中のサンプルの1つを選択すると、先ほど生成したトレースが表示されます。 + +7. 完了したら、たとえばControl-Cを使用してコレクターコンテナをシャットダウンします。 + +## この次のステップ + +このチュートリアルでは、OpenTelemetryコレクターを起動し、そこにテレメトリーを送信しました。 +次のステップとして、以下のことを検討してください。 + +- [コレクターのインストール](../installation/)について別の方法を試す +- コレクターの[デプロイ方法](../deployment/)についてさまざまな方法を学ぶ +- コレクターの[設定](/docs/collector/configuration)ファイルとその構造を理解する +- [レジストリ](/ecosystem/registry/?language=collector)で取得できるコンポーネントを探る +- [OpenTelemetry Collector Builder (OCB)を使ってカスタムコレクターをビルド](/docs/collector/custom-collector/)する方法を学ぶ + +[gobin]: https://pkg.go.dev/cmd/go#hdr-Environment_variables +[logs]: /docs/concepts/signals/logs/ +[metrics]: /docs/concepts/signals/metrics/ +[telemetrygen]: + https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/cmd/telemetrygen +[traces]: /docs/concepts/signals/traces/ From f384647676db183e6a0f58771510de4d035da8a2 Mon Sep 17 00:00:00 2001 From: Yoshi Yamaguchi Date: Thu, 25 Jul 2024 13:09:37 +0900 Subject: [PATCH 2/4] nit: prettier --- content/ja/docs/collector/quick-start.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/content/ja/docs/collector/quick-start.md b/content/ja/docs/collector/quick-start.md index 594934ab851f..95304bb2c396 100644 --- a/content/ja/docs/collector/quick-start.md +++ b/content/ja/docs/collector/quick-start.md @@ -31,8 +31,7 @@ OpenTelemetryコレクターは、[トレース](/docs/concepts/signals/traces/) export GOBIN=${GOBIN:-$(go env GOPATH)/bin} ``` -[^1]: - 詳細については、Goの公式サイトにある[Your first program](https://go.dev/doc/code#Command)のドキュメントを参照してください。 +[^1]: 詳細については、Goの公式サイトにある[Your first program](https://go.dev/doc/code#Command)のドキュメントを参照してください。 ## 環境の設定 @@ -127,6 +126,5 @@ OpenTelemetryコレクターは、[トレース](/docs/concepts/signals/traces/) [gobin]: https://pkg.go.dev/cmd/go#hdr-Environment_variables [logs]: /docs/concepts/signals/logs/ [metrics]: /docs/concepts/signals/metrics/ -[telemetrygen]: - https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/cmd/telemetrygen +[telemetrygen]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/cmd/telemetrygen [traces]: /docs/concepts/signals/traces/ From 6966eabb2669abfa7acc2735b1d29ef456d1b53a Mon Sep 17 00:00:00 2001 From: Yoshi Yamaguchi Date: Thu, 25 Jul 2024 13:10:53 +0900 Subject: [PATCH 3/4] nit: deleted alias tag --- content/ja/docs/collector/quick-start.md | 1 - 1 file changed, 1 deletion(-) diff --git a/content/ja/docs/collector/quick-start.md b/content/ja/docs/collector/quick-start.md index 95304bb2c396..811a9d339026 100644 --- a/content/ja/docs/collector/quick-start.md +++ b/content/ja/docs/collector/quick-start.md @@ -2,7 +2,6 @@ title: クイックスタート cSpell:ignore: docker dokey dpkg okey telemetrygen description: コレクターをセットアップとテレメトリーの収集をすぐに始めてみましょう！ -aliases: [getting-started] weight: 1 cSpell:ignore: gobin default_lang_commit: 78f1d31 From 4fd5996578b2690e304a31d6699fbda79c3cc982 Mon Sep 17 00:00:00 2001 From: Yoshi Yamaguchi Date: Sat, 27 Jul 2024 13:38:37 +0900 Subject: [PATCH 4/4] nit: remove unrelevant tags --- content/ja/docs/collector/quick-start.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/content/ja/docs/collector/quick-start.md b/content/ja/docs/collector/quick-start.md index 811a9d339026..f6328c9fb7ac 100644 --- a/content/ja/docs/collector/quick-start.md +++ b/content/ja/docs/collector/quick-start.md @@ -1,9 +1,6 @@ --- title: クイックスタート -cSpell:ignore: docker dokey dpkg okey telemetrygen description: コレクターをセットアップとテレメトリーの収集をすぐに始めてみましょう！ -weight: 1 -cSpell:ignore: gobin default_lang_commit: 78f1d31 ---