AWS X-Ray デバッグの設定 - AWS Elastic Beanstalk

AWS X-Ray デバッグの設定

AWS Elastic Beanstalk コンソールまたは設定ファイルを使用して、環境内のインスタンスで AWS X-Ray デーモンを実行できます。X-Ray は、アプリケーションが対応するリクエストに関するデータを収集する AWS のサービスで、このデータを使ってアプリケーションの問題や最適化の機会を識別するために使用できるサービスマップが作成されます。

注記

一部リージョンでは、X-Ray を使用できない場合があります。これらのいずれかのリージョンに環境を作成する場合は、環境内のインスタンスに対して X-Ray デーモンを実行することはできません。

各リージョンで提供されている AWS のサービスの詳細については、「リージョン表」を参照してください。


      Amazon DynamoDB を使用してデータを保存するウェブ API アプリケーション用のサービスマップ

X-Ray は、アプリケーションコードを設定するために使用できる SDK と、SDK から X-Ray API にデバッグ情報を中継するデーモンアプリケーションを提供します。

サポートされているプラットフォーム

X-Ray SDK は、次の Elastic Beanstalk プラットフォームで使用できます。

  • Go - バージョン 2.9.1 以降

  • Java 8 - バージョン 2.3.0 以降

  • Java 8 と Tomcat 8 - バージョン 2.4.0 以降

  • Node.js - バージョン 3.2.0 以降

  • Windows Server - 2016 年 12 月 18 日以降にリリースされたすべてのプラットフォームのバージョン

  • Python - バージョン 2.5.0 以降

サポートされるプラットフォームでは、設定オプションを使用して環境のインスタンスで X-Ray デーモンを実行できます。Elastic Beanstalk コンソールで、または設定ファイルを使用して、デーモンを有効にすることができます。

データを X-Ray アップロードするため、X-Ray デーモンは AWSXrayWriteOnlyAccess 管理ポリシーで IAM のアクセス許可を必要とします。これらのアクセス許可は Elastic Beanstalk インスタンスプロファイルに含まれています。デフォルトのインスタンスプロファイルを使用しない場合は、AWS X-Ray 開発者ガイドの「X-Ray にデータを送信するアクセス許可のデーモンへの付与」を参照してください。

X-Ray を使用してデバッグするには、X-Ray SDK を使用する必要があります。手順とサンプルアプリケーションについては、AWS X-Ray 開発者ガイドの「AWS X-Ray の使用開始」を参照してください。

デーモンを含まないプラットフォームのバージョンを使用している場合でも、設定ファイルでスクリプトを使ってデーモンを実行できます。詳細については、AWS X-Ray 開発者ガイドの「X-Ray デーモンを手動でダウンロードして実行する (高度)」を参照してください。

デバッグの設定

Elastic Beanstalk コンソールで実行中の環境で X-Ray デーモンを有効にできます。

Elastic Beanstalk コンソールでデバッグを有効にするには

  1. Elastic Beanstalk コンソールを開き、[リージョン] リストで AWS リージョンを選択します。

  2. ナビゲーションペインで、[環境] を選択し、リストから環境の名前を選択します。

    注記

    環境が多数ある場合は、検索バーを使用して環境リストをフィルタリングします。

  3. ナビゲーションペインで、[設定] を選択します。

  4. [ソフトウェア] 設定カテゴリで、[編集] を選択します。

  5. [AWS X-Ray] セクションで、[X-Ray デーモン] を選択します。

  6. [Apply] を選択します。

環境の作成中にこのオプションを有効にすることもできます。詳細については、「新しい環境の作成ウィザード」を参照してください。

aws:elasticbeanstalk: xray 名前空間

XRayEnabled 名前空間の aws:elasticbeanstalk:xray オプションを使用してデバッグを有効にできます。

アプリケーションをデプロイする際に自動的にデバッグを有効にするには、ソースコードで設定ファイルのオプションを次のように設定します。

例 .ebextensions/debugging.config

option_settings: aws:elasticbeanstalk:xray: XRayEnabled: true