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.

For example, the instrumentation library for Ecto automatically creates spans based on queries.

Setup

Each instrumentation library is distributed as a Hex package. To install an instrumentation, add the dependency to your mix.exs file. For example:

def deps do
  [
    {:opentelemetry_{package}, "~> 1.0"}
  ]
end

Where {package} is the name of the instrumentation.

Note that some instrumentation libraries might have prerequisites. Check the documentation of each instrumentation library for further instructions.

Available instrumentation libraries

For a full list of instrumentation libraries, see the list of Hex packages.

You can also find more instrumentations available in the registry.

Next steps

After you have set up instrumentation libraries, you might want to add your own instrumentation to your code, 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.