AWS X-Ray
開発者ガイド

AWS Elastic Beanstalk で X-Ray デーモンを実行する

アプリケーションからのトレースデータを AWS X-Ray に中継するには、Elastic Beanstalk 環境の Amazon EC2 インスタンスで X-Ray デーモンを実行します。サポートされているプラットフォームについては、『AWS Elastic Beanstalk 開発者ガイド』の「AWS X-Ray のデバッグ設定」を参照してください。

注記

デーモンは、環境のインスタンスプロファイルのアクセス権限を使用します。Elastic Beanstalk インスタンスプロファイルにアクセス権限を追加する方法については、「X-Ray にデータを送信するアクセス権限をデーモンに付与する」を参照してください。

Elastic Beanstalk プラットフォームには、デーモンを自動的に実行する設定オプションがあります。ソースコードの設定ファイル内で、または Elastic Beanstalk コンソールでオプションを選択して、デーモンを有効にできます。設定オプションを有効にすると、デーモンはインスタンスにインストールされ、サービスとして実行されます。

Elastic Beanstalk プラットフォームに含まれているバージョンは最新バージョンではない場合があります。サポートされているプラットフォームのトピックを参照して、プラットフォーム設定で利用できるデーモンのバージョンを確認してください。

Elastic Beanstalk は、複数コンテナの Docker (Amazon ECS) プラットフォームに X-Ray デーモンを提供しません。Scorekeep サンプルアプリケーションでは、Amazon ECS で Elastic Beanstalk を使用して X-Ray デーモンを使用する方法を示しています。詳細については、「Amazon ECS アプリケーションの作成」を参照してください。

Elastic Beanstalk の X-Ray 統合を使用して X-Ray デーモンを実行する

コンソールを使用して X-Ray 統合をオンにするか、設定ファイルを使用してアプリケーションソースコードで設定します。

Elastic Beanstalk コンソールで X-Ray デーモンを有効にするには

  1. Open the Elastic Beanstalk console.

  2. Navigate to the management console for your environment.

  3. Choose Configuration.

  4. [Software Settings] を選択します。

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

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

ソースコードに設定ファイルを含めて、設定を環境間で移植可能にできます。

例 .ebextensions/xray-daemon.config

option_settings: aws:elasticbeanstalk:xray: XRayEnabled: true

Elastic Beanstalk は設定ファイルをデーモンに渡し、標準の場所にログを出力します。

Windows Server プラットフォーム

  • 設定ファイルC:\Progam Files\Amazon\XRay\cfg.yaml

  • ログc:\Program Files\Amazon\XRay\logs\xray-service.log

Linux プラットフォーム

  • 設定ファイル/etc/amazon/xray/cfg.yaml

  • ログ/var/log/xray/xray.log

Elastic Beanstalk には、AWS マネジメントコンソール またはコマンドラインからインスタンスログをプルするためのツールが用意されています。設定ファイルでタスクを追加して、X-Ray デーモンログを含めるように Elastic Beanstalk に伝えることができます。

例 .ebextensions/xray-logs.config - Linux

files: "/opt/elasticbeanstalk/tasks/taillogs.d/xray-daemon.conf" : mode: "000644" owner: root group: root content: | /var/log/xray/xray.log

例 .ebextensions/xray-logs.config - Windows Server

files: "c:/Program Files/Amazon/ElasticBeanstalk/config/taillogs.d/xray-daemon.conf" : mode: "000644" owner: root group: root content: | c:\Progam Files\Amazon\XRay\logs\xray-service.log

詳細については、『AWS Elastic Beanstalk 開発者ガイド』の「Elastic Beanstalk 環境の Amazon EC2 インスタンスからのログの表示」を参照してください。

X-Ray デーモンを手動でダウンロードして実行する (高度)

X-Ray デーモンをプラットフォーム設定で使用できない場合は、Amazon S3 からダウンロードして、設定ファイルを使用して実行できます。

Elastic Beanstalk 設定ファイルを使用して、デーモンをダウンロードして実行します。

例 .ebextensions/xray.config - Linux

commands: 01-stop-tracing: command: yum remove -y xray ignoreErrors: true 02-copy-tracing: command: curl https://s3.dualstack.us-east-2.amazonaws.com/aws-xray-assets.us-east-2/xray-daemon/aws-xray-daemon-3.x.rpm -o /home/ec2-user/xray.rpm 03-start-tracing: command: yum install -y /home/ec2-user/xray.rpm files: "/opt/elasticbeanstalk/tasks/taillogs.d/xray-daemon.conf" : mode: "000644" owner: root group: root content: | /var/log/xray/xray.log "/etc/amazon/xray/cfg.yaml" : mode: "000644" owner: root group: root content: | Logging: LogLevel: "debug"

例 .ebextensions/xray.config - Windows Server

container_commands: 01-execute-config-script: command: Powershell.exe -ExecutionPolicy Bypass -File c:\\temp\\installDaemon.ps1 waitAfterCompletion: 0 files: "c:/temp/installDaemon.ps1": content: | if ( Get-Service "AWSXRayDaemon" -ErrorAction SilentlyContinue ) { sc.exe stop AWSXRayDaemon sc.exe delete AWSXRayDaemon } $targetLocation = "C:\Program Files\Amazon\XRay" if ((Test-Path $targetLocation) -eq 0) { mkdir $targetLocation } $zipFileName = "aws-xray-daemon-windows-service-3.x.zip" $zipPath = "$targetLocation\$zipFileName" $destPath = "$targetLocation\aws-xray-daemon" if ((Test-Path $destPath) -eq 1) { Remove-Item -Recurse -Force $destPath } $daemonPath = "$destPath\xray.exe" $daemonLogPath = "$targetLocation\xray-daemon.log" $url = "https://s3.dualstack.us-west-2.amazonaws.com/aws-xray-assets.us-west-2/xray-daemon/aws-xray-daemon-windows-service-3.x.zip" Invoke-WebRequest -Uri $url -OutFile $zipPath Add-Type -Assembly "System.IO.Compression.Filesystem" [io.compression.zipfile]::ExtractToDirectory($zipPath, $destPath) New-Service -Name "AWSXRayDaemon" -StartupType Automatic -BinaryPathName "`"$daemonPath`" -f `"$daemonLogPath`"" sc.exe start AWSXRayDaemon encoding: plain "c:/Program Files/Amazon/ElasticBeanstalk/config/taillogs.d/xray-daemon.conf" : mode: "000644" owner: root group: root content: | C:\Program Files\Amazon\XRay\xray-daemon.log

これらの例ではまた、デーモンのログファイルを Elastic Beanstalk のログ末尾タスクに追加し、コンソールまたは Elastic Beanstalk コマンドラインインターフェイス (EB CLI) を使用したログのリクエスト時にその内容を含めるようにしています。