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

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

AWS X-Ray デーモンを設定する

コマンドラインオプションまたは設定ファイルを使用して、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— を指定します。AWSリージョンX-Ray サービスエンドポイントの

  • 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 リソースネーム (ARN)AWSデーモンを実行しているリソース。

  • -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,warn,error,prod。 デフォルトは です。prodと同等です。info。

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

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

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

  • 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