Using instrumentation libraries

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

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

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

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

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

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

• Elasticsearch Python Client

Use instrumentation libraries

If a library does not ship with native OpenTelemetry support, you can use instrumentation libraries to generate telemetry data for a library or framework.

For example, the instrumentation library for HTTPX automatically creates spans based on HTTP requests.

Setup

You can install each instrumentation library separately using pip. For example:

pip install opentelemetry-instrumentation-{instrumented-library}

In the previous example, {instrumented-library} is the name of the instrumentation.

To install a development version, clone or fork the opentelemetry-python-contrib repository and run the following command to do an editable installation:

pip install -e ./instrumentation/opentelemetry-instrumentation-{integration}

After installation, you will need to initialize the instrumentation library. Each library typically has its own way to initialize.

Example with HTTPX instrumentation

Here’s how you can instrument HTTP requests made using the httpx library.

First, install the instrumentation library using pip:

pip install opentelemetry-instrumentation-httpx

Next, use the instrumentor to automatically trace requests from all clients:

import httpx
from opentelemetry.instrumentation.httpx import HTTPXClientInstrumentor

url = "https://some.url/get"
HTTPXClientInstrumentor().instrument()

with httpx.Client() as client:
     response = client.get(url)

async with httpx.AsyncClient() as client:
     response = await client.get(url)

Turn off instrumentations

If needed, you can uninstrument specific clients or all clients using the uninstrument_client method. For example:

import httpx
from opentelemetry.instrumentation.httpx import HTTPXClientInstrumentor

HTTPXClientInstrumentor().instrument()
client = httpx.Client()

# Uninstrument a specific client
HTTPXClientInstrumentor.uninstrument_client(client)

# Uninstrument all clients
HTTPXClientInstrumentor().uninstrument()

Available instrumentation libraries

A full list of instrumentation libraries produced by OpenTelemetry is available from the opentelemetry-python-contrib repository.

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.

You can also check the Zero-code instrumentation for Python.