このドキュメントでは、OpenTelemetry OTLP プロトコルを実装する Telemetry（OTLP）API について説明します。この API は、OpenTelemetry SDK のいずれかを使用して計測されたアプリケーションで使用するように設計されています。
Telemetry API を使用すべき理由
OpenTelemetry は、トレースデータの取り込みと可視化をサポートする Google Cloudエンジニアが常駐する、 Google Cloudがサポートするオープンソース プロジェクトです。
Telemetry API を使用すると、データは OpenTelemetry OTLP Protocol で定義された proto ファイルとほぼ同じ形式で保存されます。ただし、フィールドは保存前に OpenTelemetry 固有のデータ型から JSON データ型に変換されることがあります。また、Telemetry API の上限も適用されます。多くの場合、これらの上限は Cloud Trace API の上限よりも緩和されています。最後に、計測は Google Cloud固有のエクスポータに依存しません。
ストレージ形式の詳細については、トレースデータのスキーマをご覧ください。
Telemetry API を使用する場合
アプリケーションを計測してトレースデータをGoogle Cloud プロジェクトに送信する場合は、次のいずれかを行うことをおすすめします。
- OTLP をコレクタに書き込むエクスポータを使用して、コレクタからトレースデータを Telemetry API に送信します。
- テレメトリーを Telemetry API に送信する OpenTelemetry ライブラリでサポートされているプロセス内 OTLP エクスポータを使用します。この構成のコレクタはありません。
Telemetry API の使用方法については、Cloud Trace エクスポータから OTLP エンドポイントに移行するをご覧ください。
取り込まれたデータを表示する場所
Telemetry API を介して取り込まれたトレースデータは、[Trace エクスプローラ] ページを使用して表示できます。トレースデータを表示する方法については、トレースを検索して調査するをご覧ください。
認証
エクスポータは、 Google Cloud プロジェクトにデータを送信する権限を持っている必要があります。たとえば、言語固有の Google Auth ライブラリをアプリケーションに追加することで、 Google Cloudアプリケーションのデフォルト認証情報（ADC）を使用してエクスポータを構成できます。詳細とサンプルコードについては、認証を構成するをご覧ください。
VPC Service Controls のサポート
サービス名が telemetry.googleapis.com の Telemetry API サービスは、VPC Service Controls でサポートされているサービスです。Telemetry API サービスに作成した VPC Service Controls の制限は、そのサービスにのみ適用されます。これらの制限は、トレースデータの取り込みが可能な cloudtrace.googleapis.com サービスなどの他のサービスには適用されません。
詳しくは以下をご覧ください。