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 にデバッグ情報を中継するデーモンアプリケーションを提供します。

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

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

  • 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 月 9 日以降のすべての設定

  • Python - バージョン 2.5.0 以降

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

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

注記

サポートされているプラットフォームには、X-Ray デーモンのバージョン 2 が含まれます。このバージョンでは、サンプリングルールは完全にはサポートされません。デーモンの任意のバージョンを使用して、サンプリングルールをローカルで定義することができます。SDK を使用して X-Ray サービスを呼び出し、一元的に定義されたサンプリングルールとレポートサンプリング統計を取得するには、バージョン 3.0.0 以降が必要です。詳細については、AWS X-Ray 開発者ガイドの「AWS 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 コンソール を開きます。

  2. お客様の環境の管理ページに移動します。

  3. [Configuration] を選択します。

  4. [ソフトウェア] 設定カードで、[変更] を選択します。

  5. [X-Ray Daemon] で、[Enabled] を選択します。

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

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

aws: elasticbeanstalk: xray 名前空間

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

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

例 .ebextensions/debugging.config

option_settings: aws:elasticbeanstalk:xray: XRayEnabled: true