# エクスポーター > テレメトリーデータの処理とエクスポート --- LLMS index: [llms.txt](/llms.txt) --- [OpenTelemetryコレクター](/docs/collector/)にテレメトリーを送信し、正しくエクスポートされることを確認してください。本番環境でコレクターを使用することはベストプラクティスです。テレメトリーを可視化するために、[Jaeger](https://jaegertracing.io/)、[Zipkin](https://zipkin.io/)、 [Prometheus](https://prometheus.io/)、または[ベンダー固有](/ecosystem/vendors/)のようなバックエンドにエクスポートしてください。 ## 使用可能なエクスポーター {#available-exporters} レジストリには、[Python 用のエクスポーターのリスト][reg]が含まれています。エクスポーターの中でも、[OpenTelemetry Protocol (OTLP)][OTLP]エクスポーターは、OpenTelemetryのデータモデルを考慮して設計されており、OTelデータを情報の損失なく出力します。さらに、多くのテレメトリーデータを扱うツールがOTLPに対応しており（たとえば、[Prometheus][]、[Jaeger][]やほとんどの[ベンダー][vendors]）、必要なときに高い柔軟性を提供します。 OTLPについて詳細に学習したい場合は、[OTLP仕様][OTLP]を参照してください。 [Jaeger]: /blog/2022/jaeger-native-otlp/ [OTLP]: /docs/specs/otlp/ [Prometheus]: https://prometheus.io/docs/prometheus/2.55/feature_flags/#otlp-receiver [reg]: [vendors]: /ecosystem/vendors/ このページでは、主要なOpenTelemetry Python エクスポーターとその設定方法について説明します。

Note

[ゼロコード計装]()を使用している場合は、[設定ガイド]()に従ってエクスポーターの設定方法を学ぶことができます。

## OTLP {#otlp} ### コレクターのセットアップ {#collector-setup}

Note

OTLPコレクターまたはバックエンドがすでにセットアップされている場合は、このセクションをスキップして、アプリケーション用の[OTLPエクスポーター依存関係のセットアップ](#otlp-dependencies)に進むことができます。

OTLPエクスポーターを試し、検証するために、テレメトリーを直接コンソールに書き込むDockerコンテナでコレクターを実行できます。空のディレクトリで、以下の内容で`collector-config.yaml`というファイルを作成します。 ```yaml receivers: otlp: protocols: grpc: endpoint: 0.0.0.0:4317 http: endpoint: 0.0.0.0:4318 exporters: debug: verbosity: detailed service: pipelines: traces: receivers: [otlp] exporters: [debug] metrics: receivers: [otlp] exporters: [debug] logs: receivers: [otlp] exporters: [debug] ``` 次に、Docker コンテナでコレクターを実行します。 ```shell docker run -p 4317:4317 -p 4318:4318 --rm -v $(pwd)/collector-config.yaml:/etc/otelcol/config.yaml otel/opentelemetry-collector ``` このコレクターは、OTLPを介してテレメトリーを受け取ることができるようになりました。後で、テレメトリーを監視バックエンドに送信するために[コレクターを設定](/docs/collector/configuration)することもできます。 ## 依存関係 {#otlp-dependencies} テレメトリーデータをOTLPエンドポイント（[OpenTelemetryコレクター](#collector-setup)、[Jaeger](#jaeger)、[Prometheus](#prometheus)など）に送信したい場合、データを転送するために2つの異なるプロトコルから選択できます。 - [HTTP/protobuf](https://pypi.org/project/opentelemetry-exporter-otlp-proto-http/) - [gRPC](https://pypi.org/project/opentelemetry-exporter-otlp-proto-grpc/) まず、プロジェクトの依存関係として対応するエクスポーターパッケージをインストールします。

pip install opentelemetry-exporter-otlp-proto-http

pip install opentelemetry-exporter-otlp-proto-grpc

## 使用法 {#usage} 次に、コード内でOTLPエンドポイントを指すようにエクスポーターを設定します。

from opentelemetry.sdk.resources import SERVICE_NAME, Resource

from opentelemetry import trace
from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor

from opentelemetry import metrics
from opentelemetry.exporter.otlp.proto.http.metric_exporter import OTLPMetricExporter
from opentelemetry.sdk.metrics import MeterProvider
from opentelemetry.sdk.metrics.export import PeriodicExportingMetricReader

# ほとんどのバックエンドではサービス名が必要です
resource = Resource.create(attributes={
    SERVICE_NAME: "your-service-name"
})

tracerProvider = TracerProvider(resource=resource)
processor = BatchSpanProcessor(OTLPSpanExporter(endpoint="<traces-endpoint>/v1/traces"))
tracerProvider.add_span_processor(processor)
trace.set_tracer_provider(tracerProvider)

reader = PeriodicExportingMetricReader(
    OTLPMetricExporter(endpoint="<traces-endpoint>/v1/metrics")
)
meterProvider = MeterProvider(resource=resource, metric_readers=[reader])
metrics.set_meter_provider(meterProvider)

from opentelemetry.sdk.resources import SERVICE_NAME, Resource

from opentelemetry import trace
from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor

from opentelemetry import metrics
from opentelemetry.exporter.otlp.proto.grpc.metric_exporter import OTLPMetricExporter
from opentelemetry.sdk.metrics import MeterProvider
from opentelemetry.sdk.metrics.export import PeriodicExportingMetricReader

# ほとんどのバックエンドではサービス名が必要です
resource = Resource.create(attributes={
    SERVICE_NAME: "your-service-name"
})

tracerProvider = TracerProvider(resource=resource)
processor = BatchSpanProcessor(OTLPSpanExporter(endpoint="your-endpoint-here"))
tracerProvider.add_span_processor(processor)
trace.set_tracer_provider(tracerProvider)

reader = PeriodicExportingMetricReader(
    OTLPMetricExporter(endpoint="localhost:5555")
)
meterProvider = MeterProvider(resource=resource, metric_readers=[reader])
metrics.set_meter_provider(meterProvider)

## コンソール {#console} 計装をデバッグしたり、開発環境でローカルに値を確認したりするために、テレメトリーデータをコンソール（標準出力）に書き込むエクスポーターを使用できます。 `ConsoleSpanExporter`と`ConsoleMetricExporter`は`opentelemetry-sdk`パッケージに含まれています。 ```python from opentelemetry.sdk.resources import SERVICE_NAME, Resource from opentelemetry import trace from opentelemetry.sdk.trace import TracerProvider from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter from opentelemetry import metrics from opentelemetry.sdk.metrics import MeterProvider from opentelemetry.sdk.metrics.export import PeriodicExportingMetricReader, ConsoleMetricExporter # ほとんどのバックエンドではサービス名が必要です。 # コンソールエクスポートには必須ではありませんが、 # いずれにしてもサービス名を設定しておくとよいでしょう。 resource = Resource.create(attributes={ SERVICE_NAME: "your-service-name" }) tracerProvider = TracerProvider(resource=resource) processor = BatchSpanProcessor(ConsoleSpanExporter()) tracerProvider.add_span_processor(processor) trace.set_tracer_provider(tracerProvider) reader = PeriodicExportingMetricReader(ConsoleMetricExporter()) meterProvider = MeterProvider(resource=resource, metric_readers=[reader]) metrics.set_meter_provider(meterProvider) ``` > [!NOTE] > > 各計装種別には集約時間性のプリセットがあります。 > これらのプリセットは、たとえば次のように環境変数`OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE`で設定できます。 > > ```sh > export OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE="DELTA" > ``` > > `OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE`のデフォルト値は`"CUMULATIVE"`です。 > > この環境変数で使用可能な値と対応する設定は次のとおりです。 > > - `CUMULATIVE` > - `Counter`: `CUMULATIVE` > - `UpDownCounter`: `CUMULATIVE` > - `Histogram`: `CUMULATIVE` > - `ObservableCounter`: `CUMULATIVE` > - `ObservableUpDownCounter`: `CUMULATIVE` > - `ObservableGauge`: `CUMULATIVE` > - `DELTA` > - `Counter`: `DELTA` > - `UpDownCounter`: `CUMULATIVE` > - `Histogram`: `DELTA` > - `ObservableCounter`: `DELTA` > - `ObservableUpDownCounter`: `CUMULATIVE` > - `ObservableGauge`: `CUMULATIVE` > - `LOWMEMORY` > - `Counter`: `DELTA` > - `UpDownCounter`: `CUMULATIVE` > - `Histogram`: `DELTA` > - `ObservableCounter`: `CUMULATIVE` > - `ObservableUpDownCounter`: `CUMULATIVE` > - `ObservableGauge`: `CUMULATIVE` > > `OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE`を`CUMULATIVE`、`DELTA`、`LOWMEMORY`以外の値に設定すると、警告がログに記録され、この環境変数は`CUMULATIVE`に設定されます。 ## Jaeger {#jaeger} ### バックエンドのセットアップ {#jaeger-backend-setup} [Jaeger](https://www.jaegertracing.io/)は、トレースデータを受信するためにOTLPをネイティブでサポートしています。UIがポート16686でアクセス可能で、OTLPがポート4317と4318で有効になったDockerコンテナでJaegerを実行できます。 ```shell docker run --rm \ -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \ -p 16686:16686 \ -p 4317:4317 \ -p 4318:4318 \ -p 9411:9411 \ jaegertracing/all-in-one:latest ``` ### 使用方法 {#jaeger-usage} [OTLPエクスポーター](#otlp-dependencies)をセットアップするための手順に従ってください。 ## Prometheus {#prometheus} メトリクスデータを[Prometheus](https://prometheus.io/)に送信するには、[PrometheusのOTLPレシーバーを有効にして](https://prometheus.io/docs/guides/opentelemetry/#enable-the-otlp-receiver)[OTLPエクスポーター](#otlp)を使用するか、Prometheusエクスポーターを使用できます。 Prometheusエクスポーターは、メトリクスを収集しリクエストに応じてPrometheusテキスト形式にシリアライズするHTTPサーバーを起動する`MetricReader`です。 ### バックエンドのセットアップ {#prometheus-setup}

注意

すでにPrometheusまたはPrometheus互換のバックエンドをセットアップしている場合は、このセクションをスキップして、アプリケーション用の[Prometheus](#prometheus-dependencies)または[OTLP](#otlp-dependencies)エクスポーターの依存関係をセットアップしてください。

[Prometheus](https://prometheus.io)をDockerコンテナで実行し、ポート`9090`でアクセスできるようにするには、以下の手順に従ってください。以下の内容で`prometheus.yml`というファイルを作成します。 ```yaml scrape_configs: - job_name: dice-service scrape_interval: 5s static_configs: - targets: [host.docker.internal:9464] ``` UIがポート`9090`でアクセス可能なDockerコンテナでPrometheusを実行します。 ```shell docker run --rm -v ${PWD}/prometheus.yml:/prometheus/prometheus.yml -p 9090:9090 prom/prometheus --web.enable-otlp-receiver ```

注意

PrometheusのOTLPレシーバーを使用する場合は、アプリケーションでメトリクス用のOTLPエンドポイントを`http://localhost:9090/api/v1/otlp`に設定してください。すべてのDocker環境が`host.docker.internal`をサポートしているわけではありません。場合によっては、`host.docker.internal`を`localhost`またはマシンのIPアドレスに置き換える必要があるかもしれません。

## 依存関係 {#prometheus-dependencies} アプリケーションの依存関係として[エクスポーターパッケージ](https://pypi.org/project/opentelemetry-exporter-prometheus/)をインストールします。 ```sh pip install opentelemetry-exporter-prometheus ``` エクスポーターを使用し、Prometheusバックエンドにデータを送信するようにOpenTelemetry設定を更新します。 ```python from prometheus_client import start_http_server from opentelemetry import metrics from opentelemetry.exporter.prometheus import PrometheusMetricReader from opentelemetry.sdk.metrics import MeterProvider from opentelemetry.sdk.resources import SERVICE_NAME, Resource # ほとんどのバックエンドではサービス名が必要です resource = Resource.create(attributes={ SERVICE_NAME: "your-service-name" }) # Prometheusクライアントを起動します start_http_server(port=9464, addr="localhost") # スクレイプリクエストに応答するために、SDKからメトリクスを # オンデマンドで取得するPrometheusMetricReaderを初期化します reader = PrometheusMetricReader() provider = MeterProvider(resource=resource, metric_readers=[reader]) metrics.set_meter_provider(provider) ``` 上記の設定により、でメトリクスにアクセスできます。 PrometheusまたはPrometheusレシーバーを持つOpenTelemetryコレクターが、このエンドポイントからメトリクスをスクレイプできます。 ## Zipkin {#zipkin} ### バックエンドのセットアップ {#zipkin-setup}

注意

すでにZipkinまたはZipkin互換のバックエンドをセットアップしている場合は、このセクションをスキップして、アプリケーション用の[Zipkinエクスポーターの依存関係](#zipkin-dependencies)をセットアップしてください。

以下のコマンドを実行して、[Zipkin](https://zipkin.io/)をDockerコンテナで実行できます。 ```shell docker run --rm -d -p 9411:9411 --name zipkin openzipkin/zipkin ``` ## 依存関係 {#zipkin-dependencies} トレースデータを[Zipkin](https://zipkin.io/)に送信したい場合、データを転送するために2つの異なるプロトコルから選択できます。 - [HTTP/protobuf](https://pypi.org/project/opentelemetry-exporter-zipkin-proto-http/) - [Thrift](https://pypi.org/project/opentelemetry-exporter-zipkin-json/) アプリケーションの依存関係としてエクスポーターパッケージをインストールします。

pip install opentelemetry-exporter-zipkin-proto-http

pip install opentelemetry-exporter-zipkin-json

エクスポーターを使用し、Zipkinバックエンドにデータを送信するようにOpenTelemetry設定を更新します。

from opentelemetry import trace
from opentelemetry.exporter.zipkin.proto.http import ZipkinExporter
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor
from opentelemetry.sdk.resources import SERVICE_NAME, Resource

resource = Resource.create(attributes={
    SERVICE_NAME: "your-service-name"
})

zipkin_exporter = ZipkinExporter(endpoint="http://localhost:9411/api/v2/spans")

provider = TracerProvider(resource=resource)
processor = BatchSpanProcessor(zipkin_exporter)
provider.add_span_processor(processor)
trace.set_tracer_provider(provider)

from opentelemetry import trace
from opentelemetry.exporter.zipkin.json import ZipkinExporter
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor
from opentelemetry.sdk.resources import SERVICE_NAME, Resource

resource = Resource.create(attributes={
    SERVICE_NAME: "your-service-name"
})

zipkin_exporter = ZipkinExporter(endpoint="http://localhost:9411/api/v2/spans")

provider = TracerProvider(resource=resource)
processor = BatchSpanProcessor(zipkin_exporter)
provider.add_span_processor(processor)
trace.set_tracer_provider(provider)

## カスタムエクスポーター {#custom-exporters} 最後に、独自のエクスポーターを作成することもできます。詳細については、[APIドキュメントのSpanExporterインターフェイス](https://opentelemetry-python.readthedocs.io/en/latest/sdk/trace.export.html#opentelemetry.sdk.trace.export.SpanExporter)を参照してください。 ## スパンとログレコードのバッチ処理 {#batching-span-and-log-records} OpenTelemetry SDKは、スパンを1つずつ発行する（「シンプル」）か、バッチで発行するかを選択できるデフォルトのスパンプロセッサーとログレコードプロセッサーのセットを提供しています。バッチ処理の使用が推奨されますが、スパンやログレコードをバッチ処理したくない場合は、かわりに以下のようにシンプルプロセッサーを使用できます。 ```python from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter from opentelemetry.sdk.trace.export import SimpleSpanProcessor processor = SimpleSpanProcessor(OTLPSpanExporter(endpoint="your-endpoint-here")) ```