AWS CLI を使用した X-Ray の例
次のコード例は、X-Ray で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
トピック
アクション
次のコード例は、batch-traces-get を使用する方法を示しています。
- AWS CLI
-
トレースのリストを取得するには
次の
batch-get-tracesの例では、ID で指定されたトレースのリストを取得します。トレース全体には、同一のトレース ID を使用して取得されるすべてのセグメントドキュメントからコンパイルされた、各セグメントのドキュメントが含まれます。aws xray batch-get-traces \ --trace-ids1-5d82881a-0a9126e92a73e971eed891b9出力:
{ "Traces": [ { "Id": "1-5d82881a-0a9126e92a73e971eed891b9", "Duration": 0.232, "Segments": [ { "Id": "54aff5735b12dd28", "Document": "{\"id\":\"54aff5735b12dd28\",\"name\":\"Scorekeep\",\"start_time\":1.568835610432E9,\"end_time\":1.568835610664E9,\"http\":{\"request\":{\"url\":\"http://scorekeep-env-1.m4fg2pfzpv.us-east-2.elasticbeanstalk.com/api/user\",\"method\":\"POST\",\"user_agent\":\"curl/7.59.0\",\"client_ip\":\"52.95.4.28\",\"x_forwarded_for\":true},\"response\":{\"status\":200}},\"aws\":{\"elastic_beanstalk\":{\"version_label\":\"Sample Application-1\",\"deployment_id\":3,\"environment_name\":\"Scorekeep-env-1\"},\"ec2\":{\"availability_zone\":\"us-east-2b\",\"instance_id\":\"i-0e3cf4d2de0f3f37a\"},\"xray\":{\"sdk_version\":\"1.1.0\",\"sdk\":\"X-Ray for Java\"}},\"service\":{\"runtime\":\"OpenJDK 64-Bit Server VM\",\"runtime_version\":\"1.8.0_222\"},\"trace_id\":\"1-5d82881a-0a9126e92a73e971eed891b9\",\"origin\":\"AWS::ElasticBeanstalk::Environment\",\"subsegments\":[{\"id\":\"2d6900034ccfe558\",\"name\":\"DynamoDB\",\"start_time\":1.568835610658E9,\"end_time\":1.568835610664E9,\"http\":{\"response\":{\"status\":200,\"content_length\":61}},\"aws\":{\"table_name\":\"scorekeep-user\",\"operation\":\"UpdateItem\",\"request_id\":\"TPEIDNDUROMLPOV17U4A79555NVV4KQNSO5AEMVJF66Q9ASUAAJG\",\"resource_names\":[\"scorekeep-user\"]},\"namespace\":\"aws\"}]}" }, { "Id": "0f278b6334c34e6b", "Document": "{\"id\":\"0f278b6334c34e6b\",\"name\":\"DynamoDB\",\"start_time\":1.568835610658E9,\"end_time\":1.568835610664E9,\"parent_id\":\"2d6900034ccfe558\",\"inferred\":true,\"http\":{\"response\":{\"status\":200,\"content_length\":61}},\"aws\":{\"table_name\":\"scorekeep-user\",\"operation\":\"UpdateItem\",\"request_id\":\"TPEIDNDUROMLPOV17U4A79555NVV4KQNSO5AEMVJF66Q9ASUAAJG\",\"resource_names\":[\"scorekeep-user\"]},\"trace_id\":\"1-5d82881a-0a9126e92a73e971eed891b9\",\"origin\":\"AWS::DynamoDB::Table\"}" } ] } ], "UnprocessedTraceIds": [] }詳細については、「AWS X-Ray デベロッパーガイド」の「AWS X-Ray API の AWS CLI との併用」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「BatchTracesGet
」を参照してください。
-
次の例は、create-group を使用する方法を説明しています。
- AWS CLI
-
グループを作成するには
次の
create-groupの例では、AdminGroupという名前のグループリソースが作成されます。グループは、障害またはエラーの原因となる特定のサービスに関連するセグメントとしてグループの条件を定義するフィルター式を取得します。aws xray create-group \ --group-name"AdminGroup"\ --filter-expression "service(\"mydomain.com\") {fault OR error}"出力:
{ "GroupName": "AdminGroup", "GroupARN": "arn:aws:xray:us-west-2:123456789012:group/AdminGroup/123456789", "FilterExpression": "service(\"mydomain.com\") {fault OR error}" }詳細については、「AWS X-Ray デベロッパーガイド」の「AWS X-Ray API を使用したサンプリング、グループ、暗号化設定の設定」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「CreateGroup
」を参照してください。
-
次の例は、create-sampling-rule を使用する方法を説明しています。
- AWS CLI
-
サンプリングルールを作成するには
次の
create-sampling-ruleの例は、実装されたアプリケーションのサンプリング動作を制御するルールを作成します。ルールは JSON ファイルによって提供されます。ルールを作成するには、サンプリングルールフィールドの大部分が必要です。aws xray create-sampling-rule \ --cli-input-jsonfile://9000-base-scorekeep.json9000-base-scorekeep.jsonの内容:{ "SamplingRule": { "RuleName": "base-scorekeep", "ResourceARN": "*", "Priority": 9000, "FixedRate": 0.1, "ReservoirSize": 5, "ServiceName": "Scorekeep", "ServiceType": "*", "Host": "*", "HTTPMethod": "*", "URLPath": "*", "Version": 1 } }出力:
{ "SamplingRuleRecord": { "SamplingRule": { "RuleName": "base-scorekeep", "RuleARN": "arn:aws:xray:us-west-2:123456789012:sampling-rule/base-scorekeep", "ResourceARN": "*", "Priority": 9000, "FixedRate": 0.1, "ReservoirSize": 5, "ServiceName": "Scorekeep", "ServiceType": "*", "Host": "*", "HTTPMethod": "*", "URLPath": "*", "Version": 1, "Attributes": {} }, "CreatedAt": 1530574410.0, "ModifiedAt": 1530574410.0 } }詳細については、「AWS X-Ray デベロッパーガイド」の「AWS X-Ray API を使用したサンプリング、グループ、暗号化設定の設定」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「CreateSamplingRule
」を参照してください。
-
次の例は、delete-group を使用する方法を説明しています。
- AWS CLI
-
グループを削除するには
次の
delete-groupの例では、指定されたグループリソースを削除します。aws xray delete-group \ --group-name"AdminGroup"\ --group-arn"arn:aws:xray:us-east-2:123456789012:group/AdminGroup/123456789"このコマンドでは何も出力されません。
詳細については、「AWS X-Ray デベロッパーガイド」の「AWS X-Ray API を使用したサンプリング、グループ、暗号化設定の設定」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteGroup
」を参照してください。
-
次の例は、delete-sampling-rule を使用する方法を説明しています。
- AWS CLI
-
サンプリングルールを削除するには
次の
delete-sampling-ruleの例は、指定されたサンプリングルールを削除します。グループ名またはグループ ARN を使用して、グループを指定できます。aws xray delete-sampling-rule \ --rule-namepolling-scorekeep出力:
{ "SamplingRuleRecord": { "SamplingRule": { "RuleName": "polling-scorekeep", "RuleARN": "arn:aws:xray:us-west-2:123456789012:sampling-rule/polling-scorekeep", "ResourceARN": "*", "Priority": 5000, "FixedRate": 0.003, "ReservoirSize": 0, "ServiceName": "Scorekeep", "ServiceType": "*", "Host": "*", "HTTPMethod": "GET", "URLPath": "/api/state/*", "Version": 1, "Attributes": {} }, "CreatedAt": 1530574399.0, "ModifiedAt": 1530574399.0 } }詳細については、「AWS X-Ray デベロッパーガイド」の「AWS X-Ray API を使用したサンプリング、グループ、暗号化設定の設定」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteSamplingRule
」を参照してください。
-
次の例は、get-encryption-config を使用する方法を説明しています。
- AWS CLI
-
暗号化設定を取得するには
次の
get-encryption-configの例は、AWS X-Ray データの現在の暗号化設定を取得します。aws xray get-encryption-config出力:
{ "EncryptionConfig": { "KeyId": "ae4aa6d49-a4d8-9df9-a475-4ff6d7898456", "Status": "ACTIVE", "Type": "NONE" } }詳細については、「AWS X-Ray デベロッパーガイド」の「AWS X-Ray API を使用したサンプリング、グループ、暗号化設定の設定」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetEncryptionConfig
」を参照してください。
-
次のコード例は、get-group を使用する方法を示しています。
- AWS CLI
-
グループを取得するには
次の
get-groupの例では、指定したグループリソースに関する詳細を表示します。詳細には、グループ名、グループ ARN、そのグループの条件を定義するフィルター式が含まれます。グループは ARN によって取得することもできます。aws xray get-group \ --group-name"AdminGroup"出力:
{ "Group": [ { "GroupName": "AdminGroup", "GroupARN": "arn:aws:xray:us-west-2:123456789012:group/AdminGroup/123456789", "FilterExpression": "service(\"mydomain.com\") {fault OR error}" } ] }詳細については、「AWS X-Ray デベロッパーガイド」の「AWS X-Ray API を使用したサンプリング、グループ、暗号化設定の設定」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetGroup
」を参照してください。
-
次の例は、get-groups を使用する方法を説明しています。
- AWS CLI
-
すべてのグループを取得するには
次の例では、すべてのアクティブなグループの詳細を表示します。
aws xray get-groups出力:
{ "Groups": [ { "GroupName": "AdminGroup", "GroupARN": "arn:aws:xray:us-west-2:123456789012:group/AdminGroup/123456789", "FilterExpression": "service(\"example.com\") {fault OR error}" }, { "GroupName": "SDETGroup", "GroupARN": "arn:aws:xray:us-west-2:123456789012:group/SDETGroup/987654321", "FilterExpression": "responsetime > 2" } ] }詳細については、「AWS X-Ray デベロッパーガイド」の「AWS X-Ray API を使用したサンプリング、グループ、暗号化設定の設定」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetGroups
」を参照してください。
-
次の例は、get-sampling-rules を使用する方法を説明しています。
- AWS CLI
-
すべてのサンプリングルールを取得するには
次の
get-sampling-rulesの例では、使用可能なすべてのサンプリングルールの詳細を表示します。aws xray get-sampling-rules出力:
{ "SamplingRuleRecords": [ { "SamplingRule": { "RuleName": "Default", "RuleARN": "arn:aws:xray:us-east-1::sampling-rule/Default", "ResourceARN": "*", "Priority": 10000, "FixedRate": 0.01, "ReservoirSize": 0, "ServiceName": "*", "ServiceType": "*", "Host": "*", "HTTPMethod": "*", "URLPath": "*", "Version": 1, "Attributes": {} }, "CreatedAt": 0.0, "ModifiedAt": 1530558121.0 }, { "SamplingRule": { "RuleName": "base-scorekeep", "RuleARN": "arn:aws:xray:us-east-1::sampling-rule/base-scorekeep", "ResourceARN": "*", "Priority": 9000, "FixedRate": 0.1, "ReservoirSize": 2, "ServiceName": "Scorekeep", "ServiceType": "*", "Host": "*", "HTTPMethod": "*", "URLPath": "*", "Version": 1, "Attributes": {} }, "CreatedAt": 1530573954.0, "ModifiedAt": 1530920505.0 }, { "SamplingRule": { "RuleName": "polling-scorekeep", "RuleARN": "arn:aws:xray:us-east-1::sampling-rule/polling-scorekeep", "ResourceARN": "*", "Priority": 5000, "FixedRate": 0.003, "ReservoirSize": 0, "ServiceName": "Scorekeep", "ServiceType": "*", "Host": "*", "HTTPMethod": "GET", "URLPath": "/api/state/*", "Version": 1, "Attributes": {} }, "CreatedAt": 1530918163.0, "ModifiedAt": 1530918163.0 } ] }詳細については、「AWS X-Ray デベロッパーガイド」の「X-Ray API でのサンプリングルールの使用」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetSamplingRules
」を参照してください。
-
次の例は、get-sampling-targets を使用する方法を説明しています。
- AWS CLI
-
サンプリングクォータをリクエストするには
次の
get-sampling-targetsの例は、サービスがリクエストのサンプリングに使用しているルールのサンプリングクォータをリクエストします。AWS X-Ray からのレスポンスは、リザーバから借りる代わりに使用できるクォータが含まれています。aws xray get-sampling-targets \ --sampling-statistics-documents '[ { "RuleName": "base-scorekeep", "ClientID": "ABCDEF1234567890ABCDEF10", "Timestamp": "2018-07-07T00:20:06, "RequestCount": 110, "SampledCount": 20, "BorrowCount": 10 }, { "RuleName": "polling-scorekeep", 31, "BorrowCount": 0 } ]'出力:
{ "SamplingTargetDocuments": [ { "RuleName": "base-scorekeep", "FixedRate": 0.1, "ReservoirQuota": 2, "ReservoirQuotaTTL": 1530923107.0, "Interval": 10 }, { "RuleName": "polling-scorekeep", "FixedRate": 0.003, "ReservoirQuota": 0, "ReservoirQuotaTTL": 1530923107.0, "Interval": 10 } ], "LastRuleModification": 1530920505.0, "UnprocessedStatistics": [] }詳細については、「AWS X-Ray デベロッパーガイド」の「X-Ray API でのサンプリングルールの使用」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetSamplingTargets
」を参照してください。
-
次のコード例は、get-service-graph を使用する方法を示しています。
- AWS CLI
-
サービスグラフを取得するには
次の例では、受信リクエストを処理するサービス、および結果として呼び出すダウンストリームサービスを説明する、指定された期間内にドキュメントを表示します。
aws xray get-service-graph \ --start-time1568835392.0--end-time1568835446.0出力:
{ "Services": [ { "ReferenceId": 0, "Name": "Scorekeep", "Names": [ "Scorekeep" ], "Root": true, "Type": "AWS::ElasticBeanstalk::Environment", "State": "active", "StartTime": 1568835392.0, "EndTime": 1568835446.0, "Edges": [ { "ReferenceId": 1, "StartTime": 1568835392.0, "EndTime": 1568835446.0, "SummaryStatistics": { "OkCount": 14, "ErrorStatistics": { "ThrottleCount": 0, "OtherCount": 0, "TotalCount": 0 }, "FaultStatistics": { "OtherCount": 0, "TotalCount": 0 }, "TotalCount": 14, "TotalResponseTime": 0.13 }, "ResponseTimeHistogram": [ { "Value": 0.008, "Count": 1 }, { "Value": 0.005, "Count": 7 }, { "Value": 0.009, "Count": 1 }, { "Value": 0.021, "Count": 1 }, { "Value": 0.038, "Count": 1 }, { "Value": 0.007, "Count": 1 }, { "Value": 0.006, "Count": 2 } ], "Aliases": [] }, ... TRUNCATED FOR BREVITY ... ] } ], "StartTime": 1568835392.0, "EndTime": 1568835446.0, "ContainsOldGroupVersions": false }詳細については、「AWS X-Ray デベロッパーガイド」の「AWS X-Ray API の AWS CLI との併用」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetServiceGraph
」を参照してください。
-
次の例は、get-trace-summaries を使用する方法を説明しています。
- AWS CLI
-
トレースの概要を取得するには
次の
get-trace-summariesの例では、指定された時間枠内で使用可能なトレースの ID とメタデータを取得します。aws xray get-trace-summaries \ --start-time1568835392.0\ --end-time1568835446.0出力:
[ "http://scorekeep-env-1.123456789.us-east-2.elasticbeanstalk.com/api/move/VSAE93HF/GSSD2NTB/DP0PCC09", "http://scorekeep-env-1.123456789.us-east-2.elasticbeanstalk.com/api/move/GCQ2B35P/FREELDFT/4LRE643M", "http://scorekeep-env-1.123456789.us-east-2.elasticbeanstalk.com/api/game/VSAE93HF/GSSD2NTB/starttime/1568835513", "http://scorekeep-env-1.123456789.us-east-2.elasticbeanstalk.com/api/move/4MQNA5NN/L99KK2RF/null" ]詳細については、「AWS X-Ray デベロッパーガイド」の「AWS X-Ray API の AWS CLI との併用」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「GetTraceSummaries
」を参照してください。
-
次の例は、put-encryption-config を使用する方法を説明しています。
- AWS CLI
-
暗号化設定を更新するには
次の
put-encryption-config``example updates the encryption configuration for AWS X-Ray data to use the default AWS managed KMS key ``aws/xray。aws xray put-encryption-config \ --typeKMS\ --key-idalias/aws/xray出力:
{ "EncryptionConfig": { "KeyId": "arn:aws:kms:us-west-2:123456789012:key/c234g4e8-39e9-4gb0-84e2-b0ea215cbba5", "Status": "UPDATING", "Type": "KMS" } }詳細については、「AWS X-Ray デベロッパーガイド」の「AWS X-Ray API を使用したサンプリング、グループ、暗号化設定の設定」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「PutEncryptionConfig
」を参照してください。
-
次の例は、put-trace-segments を使用する方法を説明しています。
- AWS CLI
-
セグメントをアップロードするには
次の
put-trace-segmentsの例では、セグメントドキュメントを AWS X-Ray にアップロードします。セグメントドキュメントは、JSON セグメントドキュメントのリストとして消費されます。aws xray put-trace-segments \ --trace-segment-documents "{\"id\":\"20312a0e2b8809f4\",\"name\":\"DynamoDB\",\"trace_id\":\"1-5832862d-a43aafded3334a971fe312db\",\"start_time\":1.479706157195E9,\"end_time\":1.479706157202E9,\"parent_id\":\"79736b962fe3239e\",\"http\":{\"response\":{\"content_length\":60,\"status\":200}},\"inferred\":true,\"aws\":{\"consistent_read\":false,\"table_name\":\"scorekeep-session-xray\",\"operation\":\"GetItem\",\"request_id\":\"SCAU23OM6M8FO38UASGC7785ARVV4KQNSO5AEMVJF66Q9ASUAAJG\",\"resource_names\":[\"scorekeep-session-xray\"]},\"origin\":\"AWS::DynamoDB::Table\"}"出力:
{ "UnprocessedTraceSegments": [] }詳細については、「AWS X-Ray デベロッパーガイド」の「トレースデータを AWS X-Ray に送信する」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「PutTraceSegments
」を参照してください。
-
次のコード例は、update-group を使用する方法を示しています。
- AWS CLI
-
グループを更新するには
次の
update-groupの例では、AdminGroupという名前のグループへのトレースを受け入れる基準を更新します。グループ名またはグループ ARN を使用して、目的のグループを指定できます。aws xray update-group \ --group-name"AdminGroup"\ --group-arn"arn:aws:xray:us-west-2:123456789012:group/AdminGroup/123456789"\ --filter-expression "service(\"mydomain.com\") {fault}"出力:
{ "GroupName": "AdminGroup", "GroupARN": "arn:aws:xray:us-east-2:123456789012:group/AdminGroup/123456789", "FilterExpression": "service(\"mydomain.com\") {fault}" }詳細については、「AWS X-Ray デベロッパーガイド」の「AWS X-Ray API を使用したサンプリング、グループ、暗号化設定の設定」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateGroup
」を参照してください。
-
次の例は、update-sampling-rule を使用する方法を説明しています。
- AWS CLI
-
サンプリングルールを更新するには
次の
update-sampling-ruleの例では、サンプリングルールの設定を変更します。ルールは JSON ファイルから消費されます。更新されるフィールドのみが必要です。aws xray update-sampling-rule \ --cli-input-jsonfile://1000-default.json1000-default.jsonの内容:{ "SamplingRuleUpdate": { "RuleName": "Default", "FixedRate": 0.01, "ReservoirSize": 0 } }出力:
{ "SamplingRuleRecords": [ { "SamplingRule": { "RuleName": "Default", "RuleARN": "arn:aws:xray:us-west-2:123456789012:sampling-rule/Default", "ResourceARN": "*", "Priority": 10000, "FixedRate": 0.01, "ReservoirSize": 0, "ServiceName": "*", "ServiceType": "*", "Host": "*", "HTTPMethod": "*", "URLPath": "*", "Version": 1, "Attributes": {} }, "CreatedAt": 0.0, "ModifiedAt": 1529959993.0 } ] }詳細については、「AWS X-Ray デベロッパーガイド」の「AWS X-Ray API を使用したサンプリング、グループ、暗号化設定の設定」を参照してください。
-
API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateSamplingRule
」を参照してください。
-
