AWS X-Ray デーモンの設定 - AWS X-Ray
サポートされている環境変数コマンドラインオプションを使用する設定ファイルを使用する

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

AWS X-Ray デーモンの設定

注記

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

コマンドラインオプションまたは設定ファイルを使用して、X-Ray デーモンの動作をカスタマイズできます。ほとんどのオプションは両方の方法を使用して利用できますが、一部は設定ファイルのみを使用でき、一部はコマンドラインのみを使用できます。

開始するには、-n または--regionのみが必要です。デーモンがトレースデータをX-Ray に送信するために使用するリージョンを設定するために使用します。

~/xray-daemon$ ./xray -n us-east-2

デーモンを、Amazon EC2 ではなく、ローカルで実行している場合、-o オプションを追加すると、デーモンをより迅速に開始できるように、インスタンスプロファイルの認証情報のチェックをスキップできます。

~/xray-daemon$ ./xray -o -n us-east-2

残りのコマンドラインオプションを使用して、ロギングの設定、別のポートでのリッスン、デーモンが使用できるメモリ量の制限、別のアカウントにトレースデータを送信するロールの割り当てができます。

設定ファイルをデーモンに渡して、詳細な設定オプションにアクセスしたり、X-Ray への同時呼び出し数を制限したり、ログローテーションを無効にしたり、プロキシにトラフィックを送信したりすることができます。

サポートされている環境変数

X-Ray デーモンは次の環境変数をサポートしています。

  • AWS_REGION – X-Ray サービスエンドポイントの AWS リージョン を指定します。

  • HTTPS_PROXY セグメントをアップロードするデーモンのプロキシアドレスを指定します。これは、DNS ドメイン名または IP アドレス、あるいはプロキシサーバーで使用されているポート番号のいずれかです。

コマンドラインオプションを使用する

ローカルで実行するか、またはユーザーデータスクリプトを使用して、これらのオプションをデーモンに渡します。

コマンドラインオプション

  • -b、--bind 別の UDP ポートでセグメントドキュメントをリッスンします。

    --bind "127.0.0.1:3000"

    デフォルト – 2000

  • -t、 --bind-tcp 別の TCP ポートで X-Ray サービスへの呼び出しをリッスンします。

    -bind-tcp "127.0.0.1:3000"

    デフォルト – 2000

  • -c、 --config 指定されたパスから設定ファイルをロードします。

    --config "/home/ec2-user/xray-daemon.yaml"

  • -f、 --log-file 指定されたファイルパスにログを出力します。

    --log-file "/var/log/xray-daemon.log"

  • -l、 --log-levelログレベルを dev、debug、info、warn、error、prod (詳細な順) から指定します。

    --log-level warn

    デフォルト – prod

  • -m、 --buffer-memoryバッファが使用できるメモリの量をメガバイト単位で変更します (最小値 3)。

    --buffer-memory 50

    デフォルト – 使用可能なメモリ総量の 1%

  • -o、 --local-mode– EC2 インスタンスのメタデータをチェックしません。

  • -r、 --role-arn– 指定した IAM ロールで、別のアカウントにセグメントをアップロードできるようにします。

    --role-arn "arn:aws:iam::123456789012:role/xray-cross-account"

  • -a、 --resource-arn – デーモンを実行しているリソースの Amazon AWS リソースネーム (ARN)。

  • -p、 --proxy-address — プロキシ AWS X-Ray を介してセグメントを にアップロードします。プロキシサーバーのプロトコルを指定する必要があります。

    --proxy-address "http://192.0.2.0:3000"

  • -n、--region 特定のリージョンの X-Ray サービスにセグメントを送信します。

  • -v、 --version – AWS X-Ray デーモンバージョンを表示します。

  • -h、--help – ヘルプ画面を表示します。

設定ファイルを使用する

YAML 形式のファイルを使用して、デーモンを設定することもできます。-c オプションを使用して、設定ファイルをデーモンに渡します。

~$ ./xray -c ~/xray-daemon.yaml
設定ファイルのオプション

  • TotalBufferSizeMB – 最大バッファサイズ (MB) (最小値 3)。ホストメモリの 1% を使用するには、0 を選択します。

  • Concurrency – セグメントドキュメントをアップロード AWS X-Ray するための への同時呼び出しの最大数。

  • Region – 特定のリージョン AWS X-Ray のサービスにセグメントを送信します。

  • Socket – デーモンのバインディングを設定します。

  • Logging – ログ記録の動作を設定します。

    • LogRotation – falseに設定してログローテーションを無効にします。

    • LogLevel - ログレベルを変更します。詳細なものから順に、dev、debug、info、または prod、warn、error、prod です。デフォルトは です。prodと等価である。info。

    • LogPath – 指定されたファイルパスにログを出力します。

  • LocalMode–EC2 インスタンスのメタデータのチェックをスキップするには true に設定します。

  • ResourceARN – デーモンを実行しているリソースの Amazon AWS リソースネーム (ARN)。

  • RoleARN – 指定した IAM ロールで、別のアカウントにセグメントをアップロードできるようにします。

  • ProxyAddress – プロキシ AWS X-Ray を介してセグメントを にアップロードします。

  • Endpoint – デーモンがセグメントドキュメントを送信する X-Ray サービスエンドポイントを変更します。

  • NoVerifySSL – TLS 証明書認証を無効にします。

  • Version – デーモンの設定ファイル形式のバージョン。ファイル形式のバージョンは必須フィールド。

例 xray-daemon.yaml

この設定ファイルでは、デーモンのリスニングポートを 3000 に変更し、インスタンスメタデータの確認をオフにして、セグメントをアップロードするために使用するロールを設定し、リージョンおよびログ作成オプションを変更します。

Socket:
  UDPAddress: "127.0.0.1:3000"
  TCPAddress: "127.0.0.1:3000"
Region: "us-west-2"
Logging:
  LogLevel: "warn"
  LogPath: "/var/log/xray-daemon.log"
LocalMode: true
RoleARN: "arn:aws:iam::123456789012:role/xray-cross-account"
Version: 2