|
| 1 | +--- |
| 2 | +title: クイックスタート |
| 3 | +description: コレクターをセットアップとテレメトリーの収集をすぐに始めてみましょう! |
| 4 | +default_lang_commit: 78f1d31 |
| 5 | +--- |
| 6 | + |
| 7 | +<!-- markdownlint-disable ol-prefix blanks-around-fences --> |
| 8 | + |
| 9 | +OpenTelemetryコレクターは、[トレース](/docs/concepts/signals/traces/)、[メトリクス](/docs/concepts/signals/metrics/)、[ログ](/docs/concepts/signals/logs/)を受け取り、テレメトリーを処理し、そのコンポーネントを使用してさまざまなオブザーバビリティバックエンドにエクスポートします。 |
| 10 | +コレクターの概念的な概要については、[コレクター](/docs/collector)のページを参照してください。 |
| 11 | + |
| 12 | +本記事でたった5分で次の内容を学習できます。 |
| 13 | + |
| 14 | +- OpenTelemetryコレクターをセットアップして実行する |
| 15 | +- テレメトリーを送信し、コレクターによって処理されるのを確認する |
| 16 | + |
| 17 | +## 事前要件 |
| 18 | + |
| 19 | +開発環境が以下の要件を満たしていることを確認してください。 |
| 20 | +このページでは `bash` を使っていると仮定しています。 |
| 21 | +お好みのシェルに合わせて、設定やコマンドを変更してください。 |
| 22 | + |
| 23 | +- [Docker](https://www.docker.com/)、あるいは他の互換コンテナランタイム |
| 24 | +- [Go](https://go.dev/) 1.20以上 |
| 25 | +- [`GOBIN` 環境変数][gobin]が設定されていること。もし設定されていなければ、適切に設定してください。次は一例です[^1]。 |
| 26 | + ```sh |
| 27 | + export GOBIN=${GOBIN:-$(go env GOPATH)/bin} |
| 28 | + ``` |
| 29 | + |
| 30 | +[^1]: 詳細については、Goの公式サイトにある[Your first program](https://go.dev/doc/code#Command)のドキュメントを参照してください。 |
| 31 | + |
| 32 | +## 環境の設定 |
| 33 | + |
| 34 | +1. OpenTelemetryコレクターのDockerイメージをプルします。 |
| 35 | + |
| 36 | + ```sh |
| 37 | + docker pull otel/opentelemetry-collector:{{% param vers %}} |
| 38 | + ``` |
| 39 | + |
| 40 | +2. [telemetrygen]ユーティリティをインストールします。 |
| 41 | + |
| 42 | + ```sh |
| 43 | + go install github.com/open-telemetry/opentelemetry-collector-contrib/cmd/telemetrygen@latest |
| 44 | + ``` |
| 45 | + |
| 46 | + このユーティリティは[トレース][traces]、[メトリクス][metrics]、[ログ][logs]を生成するクライアントをシミュレートできます。 |
| 47 | + |
| 48 | +## テレメトリーの生成と収集 |
| 49 | + |
| 50 | +3. コレクターを起動します。 |
| 51 | + |
| 52 | + ```sh |
| 53 | + docker run \ |
| 54 | + -p 127.0.0.1:4317:4317 \ |
| 55 | + -p 127.0.0.1:55679:55679 \ |
| 56 | + otel/opentelemetry-collector:{{% param vers %}} \ |
| 57 | + 2>&1 | tee collector-output.txt # 補足的に出力をteeして後で検索しやすくする |
| 58 | + ``` |
| 59 | + |
| 60 | +4. 別のターミナル窓でサンプルのトレースを生成します。 |
| 61 | + |
| 62 | + ```sh |
| 63 | + $GOBIN/telemetrygen traces --otlp-insecure --traces 3 |
| 64 | + ``` |
| 65 | + |
| 66 | + ユーティリティによって生成された出力の中に、トレースが生成されたことのログが表示されるはずです。 |
| 67 | + |
| 68 | + ```text |
| 69 | + 2024-01-16T14:33:15.692-0500 INFO traces/worker.go:99 traces generated {"worker": 0, "traces": 3} |
| 70 | + 2024-01-16T14:33:15.692-0500 INFO traces/traces.go:58 stop the batch span processor |
| 71 | + ``` |
| 72 | + |
| 73 | + 関連する出力を簡単に見るには、フィルタリングすると良いでしょう。 |
| 74 | + |
| 75 | + ```sh |
| 76 | + $GOBIN/telemetrygen traces --otlp-insecure \ |
| 77 | + --traces 3 2>&1 | grep -E 'start|traces|stop' |
| 78 | + ``` |
| 79 | + |
| 80 | +5. コレクターコンテナを実行しているターミナル窓に、以下の例に示すようなトレースを取り込んだ様子が表示されるはずです。 |
| 81 | + |
| 82 | + ```console |
| 83 | + $ grep -E '^Span|(ID|Name|Kind|time|Status \w+)\s+:' ./collector-output.txt |
| 84 | + Span #0 |
| 85 | + Trace ID : f30faffbde5fcf71432f89da1bf7bc14 |
| 86 | + Parent ID : 6f1ff7f9cf4ec1c7 |
| 87 | + ID : 8d1e820c1ac57337 |
| 88 | + Name : okey-dokey |
| 89 | + Kind : Server |
| 90 | + Start time : 2024-01-16 14:13:54.585877 +0000 UTC |
| 91 | + End time : 2024-01-16 14:13:54.586 +0000 UTC |
| 92 | + Status code : Unset |
| 93 | + Status message : |
| 94 | + Span #1 |
| 95 | + Trace ID : f30faffbde5fcf71432f89da1bf7bc14 |
| 96 | + Parent ID : |
| 97 | + ID : 6f1ff7f9cf4ec1c7 |
| 98 | + Name : lets-go |
| 99 | + Kind : Client |
| 100 | + Start time : 2024-01-16 14:13:54.585877 +0000 UTC |
| 101 | + End time : 2024-01-16 14:13:54.586 +0000 UTC |
| 102 | + Status code : Unset |
| 103 | + Status message : |
| 104 | + ... |
| 105 | + ``` |
| 106 | + |
| 107 | +6. <http://localhost:55679/debug/tracez> を開いて、表中のサンプルの1つを選択すると、先ほど生成したトレースが表示されます。 |
| 108 | + |
| 109 | +7. 完了したら、たとえば<kbd>Control-C</kbd>を使用してコレクターコンテナをシャットダウンします。 |
| 110 | + |
| 111 | +## この次のステップ |
| 112 | + |
| 113 | +このチュートリアルでは、OpenTelemetryコレクターを起動し、そこにテレメトリーを送信しました。 |
| 114 | +次のステップとして、以下のことを検討してください。 |
| 115 | + |
| 116 | +- [コレクターのインストール](../installation/)について別の方法を試す |
| 117 | +- コレクターの[デプロイ方法](../deployment/)についてさまざまな方法を学ぶ |
| 118 | +- コレクターの[設定](/docs/collector/configuration)ファイルとその構造を理解する |
| 119 | +- [レジストリ](/ecosystem/registry/?language=collector)で取得できるコンポーネントを探る |
| 120 | +- [OpenTelemetry Collector Builder (OCB)を使ってカスタムコレクターをビルド](/docs/collector/custom-collector/)する方法を学ぶ |
| 121 | + |
| 122 | +[gobin]: https://pkg.go.dev/cmd/go#hdr-Environment_variables |
| 123 | +[logs]: /docs/concepts/signals/logs/ |
| 124 | +[metrics]: /docs/concepts/signals/metrics/ |
| 125 | +[telemetrygen]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/cmd/telemetrygen |
| 126 | +[traces]: /docs/concepts/signals/traces/ |
0 commit comments