計装ライブラリの使用

アプリを開発する際、作業を加速するためにサードパーティのライブラリやフレームワークを使用することがあるでしょう。 OpenTelemetryを使用してアプリを計装する場合、使用するサードパーティのライブラリやフレームワークにトレース、ログ、メトリクスを手動で追加するために時間を費やすことを避けたいことがあります。

多くのライブラリやフレームワークはすでにOpenTelemetryをサポートしているか、OpenTelemetryの計装を介してサポートされているため、テレメトリーを生成してオブザーバビリティバックエンドにエクスポートできます。

サードパーティのライブラリやフレームワークを使用しているアプリやサービスを計装する場合は、このページの手順に従って、ネイティブに計装されたライブラリと依存関係の計装ライブラリの使用方法を学んでください。

ネイティブに計装されたライブラリを使用する

デフォルトでOpenTelemetryサポートが付属しているライブラリの場合、アプリにOpenTelemetry SDKを追加して設定することで、そのライブラリから発行されるトレース、メトリクス、ログを取得できます。

ライブラリによっては、計装のために追加の構成が必要な場合があります。 詳細はライブラリごとのドキュメントをご覧ください。

計装ライブラリの使用

ライブラリにOpenTelemetryが最初から付属していない場合は、計装ライブラリを使用して、ライブラリまたはフレームワークのテレメトリーデータを生成できます。

たとえば、net/httpの計装ライブラリは、HTTPリクエストに基づいてスパンとメトリクスを自動的に作成します。

セットアップ

各計装ライブラリはパッケージです。一般的に、これは適切なパッケージをgo getする必要があることを意味します。 たとえば、Contribリポジトリで維持されている計装ライブラリを取得するには、以下を実行します。

go get go.opentelemetry.io/contrib/instrumentation/{import-path}/otel{package-name}

次に、ライブラリが有効化するために必要なものに基づいて、コード内で設定します。

はじめにでは、net/httpサーバーの計装を設定する方法を示す例を提供しています。

利用可能なパッケージ

利用可能な計装ライブラリの完全なリストは、OpenTelemetryレジストリで見つけることができます。

次のステップ

計装ライブラリは、インバウンドおよびアウトバウンドHTTPリクエストのテレメトリーデータを生成するなどのことができますが、実際のアプリケーションを計装化することはありません。

カスタムインストルメンテーションをコードに統合して、テレメトリーデータを充実させてください。 これは標準ライブラリのテレメトリーを補完し、実行中のアプリケーションへのより深い洞察を提供できます。