計装ライブラリの使用

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

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

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

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

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

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

計装ライブラリを使用する

ライブラリにネイティブの OpenTelemetry サポートが含まれていない場合は、計装ライブラリを使用して、ライブラリまたはフレームワークのテレメトリーデータを生成できます。

OpenTelemetry PHP エクステンションには、多くの一般的な PHP フレームワーク用の計装ライブラリが含まれています。 たとえば、Laravel 計装は、アプリケーションのアクティビティに基づいてスパンを自動的に作成します。

セットアップ

各計装ライブラリは Composer パッケージです。 インストールするには、次のコマンドを実行します。

php composer.phar install {name-of-instrumentation}:{version-number}

ここで {name-of-instrumentation} は、使用したい特定の計装の Packagist 参照名です。

計装の識別子を OTEL_PHP_DISABLED_INSTRUMENTATIONS 環境変数に追加することで、任意の計装を無効にできます。

利用可能な計装ライブラリ

利用可能な計装の一覧は、Packagist の OpenTelemetry 計装ライブラリを参照してください。

次のステップ

計装ライブラリをセットアップした後は、カスタムのテレメトリーデータを収集するために追加の計装を追加したいと思うかもしれません。

また、適切なエクスポーターを設定して、1つ以上のテレメトリーバックエンドにテレメトリーデータをエクスポートすることもできます。