Using instrumentation libraries

You are viewing the English version of this page because it has not yet been fully translated. Interested in helping out? See Contributing.

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

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

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

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

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

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

Use instrumentation libraries

If a library doesn’t include OpenTelemetry support, you can use instrumentation libraries to generate telemetry data for a library or framework.

The OpenTelemetry PHP extension includes instrumentation libraries for many common PHP frameworks. For example, the Laravel instrumentation automatically creates spans based on the application activity.

Setup

Each instrumentation library is a Composer package. To install it, run the following command:

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

Where {name-of-instrumentation} is the Packagist reference for the specific instrumentation you want to use.

You can turn off any instrumentation by adding its identifier to the OTEL_PHP_DISABLED_INSTRUMENTATIONS environment variable.

Available instrumentation libraries

For a list of available instrumentations, see OpenTelemetry instrumentation libraries on Packagist.

Next steps

After you’ve set up instrumentation libraries, you might want to add additional instrumentation to collect custom telemetry data.

You might also want to configure an appropriate exporter to export your telemetry data to one or more telemetry backends.