SDK を使用する - AWS X-Ray

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

SDK を使用する

注記

End-of-support通知 – 2027 年 2 月 25 日、 AWS X-Ray は AWS X-Ray SDKs とデーモンのサポートを終了します。2027 年 2 月 25 日以降、更新やリリースは配信されなくなります。サポートタイムラインの詳細については、「」を参照してくださいX-Ray SDK とデーモンのサポート終了タイムライン。OpenTelemetry に移行することをお勧めします。OpenTelemetry への移行の詳細については、「X-Ray 計測から OpenTelemetry 計測への移行」を参照してください。

コマンドラインインターフェイスを使用する場合、または AWS Management Consoleで利用可能なものよりも多くのカスタムトレース、モニタリング、またはログ機能が必要な場合は、SDK を使用します。 AWS SDK を使用して、X-Ray APIs を使用するプログラムを開発することもできます。 AWS Distro for OpenTelemetry (ADOT) SDK または X-Ray SDK のいずれかを使用できます。

SDK を使用する場合は、アプリケーションを計測するときと、コレクターまたはエージェントを設定するときに、ワークフローにカスタマイズを追加できます。SDK を使用すると、 AWS Management Consoleでは実行できない以下のタスクを実行できます。

  • カスタムメトリクスの公開 - 1 秒までの高解像度でメトリクスをサンプリングして、複数のディメンションを使用しメトリクスに関する情報を追加し、データポイントを統計セットに集約します。

  • コレクターのカスタマイズ - レシーバー、プロセッサ、エクスポーター、コネクタなど、コレクターの設定の任意の部分をカスタマイズします。

  • 計測のカスタマイズ - セグメントとサブセグメントをカスタマイズして、カスタムキーと値のペアを属性として追加し、カスタムメトリクスを作成します。

  • プログラムでサンプリングルールを作成および更新します。

AWS セキュリティと最適化のレイヤーを追加した標準化ADOTされた SDK を柔軟に使用する場合は、 OpenTelemetry SDK を使用します。 AWS Distro for OpenTelemetry (ADOT) SDK は、ベンダーに依存しないパッケージで、コードを再計測することなく、他のベンダーや非AWS サービスのバックエンドと統合できます。

X-Ray SDK を既に使用していて、 AWS バックエンドのみと統合し、X-Ray またはアプリケーションコードの操作方法を変更しない場合は、X-Ray SDK を使用します。

各機能の詳細については、「Distro for OpenTelemetry AWS と X-Ray SDKs の選択」を参照してください。

ADOT SDK を使用する

ADOT SDK は、バックエンドサービスにデータを送信する一連のオープンソース APIs、ライブラリ、エージェントです。 ADOTは、 でサポートされ AWS、複数のバックエンドやエージェントと統合され、OpenTelemetryコミュニティによって管理される多数のオープンソースライブラリを提供します。ADOT SDK を使用してご使用のアプリケーションを計測して、ログ、メタデータ、メトリクス、トレースを収集します。ADOT を使用してサービスをモニタリングし、CloudWatch のメトリクスに基づいてアラームを設定することもできます。

ADOT SDK を使用する場合は、エージェントとの組み合わせで、次のオプションがあります。

  • CloudWatch エージェントで ADOT SDK を使用する - 推奨。

  • ADOT コレクターで ADOT SDK を使用する – セキュリティと最適化の AWS レイヤーでベンダーに依存しないソフトウェアを使用する場合は推奨されます。

ADOT SDK を使用する場合は、以下を実行します。

  • ADOT SDK を使用してご使用のアプリケーションを計測します。詳細については、「ADOT 技術ドキュメント」の、ご使用のプログラミング言語のドキュメントを参照してください。

  • ADOT Collector を設定して、収集データの送信先を指定します。

ADOT コレクターは、データを受信すると、ADOT設定で指定したバックエンドに送信します。 は AWS、次の図に示すように、外部のベンダーを含む複数のバックエンドにデータを送信ADOTできます。

ADOT Collector は、アプリケーションを計測してコレクターを設定するときにカスタマイズできます。

AWS は定期的に を更新ADOTして機能を追加し、OpenTelemetry フレームワークと連携させます。ADOT の更新および今後の開発計画は一般公開ロードマップの一部です。ADOT は以下を含むいくつかのプログラミング言語をサポートしています。

  • Go

  • Java

  • JavaScript

  • Python

  • .NET

  • Ruby

  • PHP

Python を使用する場合、ADOT はアプリケーションを自動的に計測できます。の使用を開始するにはADOT、https://aws-otel.github.io/docs/introductionAWS 「 Distro for OpenTelemetry Collector の概要と開始方法」を参照してください。

X-Ray SDK を使用する

X-Ray SDK は、バックエンドサービスに AWS データを送信する一連の AWS APIsとライブラリです。X-Ray SDK を使用してアプリケーションを計測しトレースデータを収集します。X-Ray SDK を使用したログまたはメトリクスデータの収集はできません。

X-Ray SDK を使用する場合は、エージェントとの組み合わせで、次のオプションがあります。

  • AWS X-Ray デーモン で X-Ray SDK を使用する - アプリケーションコードを更新しない場合はこれを使用します。

  • CloudWatch エージェントで X-Ray SDK を使用する - (推奨) CloudWatch エージェントは X-Ray SDK と互換性があります。

SDK を使用する場合は、以下を実行します。

  • X-Ray SDK を使用してご使用のアプリケーションを計測します。

  • コレクターを設定して、収集データの送信先を指定します。CloudWatch エージェントまたは X-Ray デーモンを使用すると、トレース情報を収集できます。

コレクターまたはエージェントがデータを受信すると、エージェント設定で指定した AWS バックエンドに送信されます。次の図に示すように、X-Ray SDK は AWS バックエンドにのみデータを送信できます。

CloudWatch エージェントまたは X-Ray デーモンのいずれかで、X-Ray SDK を使用します。

Java を使用する場合は、X-Ray SDK を使用してアプリケーションを自動的に計測できます。X-Ray SDK の使用を開始する場合は、次のプログラミング言語に関連付けられているライブラリを参照してください。