Amazon API Gateway API に対する AWS X-Ray トレースを理解する

このセクションでは、Amazon API Gateway API に対する AWS X-Ray トレースのセグメント、サブセグメント、およびその他のトレースフィールドについて説明します。

このセクションを読む前に、AWS X-Ray デベロッパーガイドの以下のトピックを参照してください。

• AWS X-Ray コンソール

• AWS X-Ray セグメントドキュメント

• AWS X-Ray の概念

API Gateway の API のトレースに関連するオブジェクトの例

このセクションでは、API Gateway の API のトレースに関連するいくつかのオブジェクトについて説明します。

注釈

注釈は、セグメントとサブセグメントに表示されます。これらは、トレースをフィルタリングするために、サンプリングルールでフィルタ式として使用されます。詳細については、「AWS X-Ray コンソールでのサンプリングルールの設定」を参照してください。

annotations オブジェクトの例を以下に示します。この例では、API のステージは、API の ID と API のステージ名によって識別されます。

"annotations": {
    "aws:api_id": "a1b2c3d4e5",
    "aws:api_stage": "dev"
}

AWS リソースデータ

aws オブジェクトは、セグメントでのみ使用されます。次に示す例は、デフォルトのサンプリングルールに一致する aws オブジェクトです。サンプリングルールの詳細な説明については、「AWS X-Ray コンソールのサンプリングルールの設定」を参照してください。

"aws": {
    "xray": {
        "sampling_rule_name": "Default"
    },
    "api_gateway": {
        "account_id": "123412341234",
        "rest_api_id": "a1b2c3d4e5",
        "stage": "dev",
        "request_id": "a1b2c3d4-a1b2-a1b2-a1b2-a1b2c3d4e5f6"
    }
}

トレースについて

次の例は、API Gateway のステージのトレースのセグメントを示しています。トレースセグメントを構成するフィールドの詳細な説明については、AWS X-Ray デベロッパーガイドの「AWS X-Ray セグメントドキュメント」を参照してください。

        {
            "Document": {
                "id": "a1b2c3d4a1b2c3d4",
                "name": "testxray/dev",
                "start_time": 1533928226.229,
                "end_time": 1533928226.614,
                "metadata": {
                    "default": {
                        "extended_request_id": "abcde12345abcde=",
                        "request_id": "a1b2c3d4-a1b2-a1b2-a1b2-a1b2c3d4e5f6"
                    }
                },
                "http": {
                    "request": {
                        "url": "https://example.com/dev?username=demo&message=hellofromdemo/",
                        "method": "GET",
                        "client_ip": "192.0.2.0",
                        "x_forwarded_for": true
                    },
                    "response": {
                        "status": 200,
                        "content_length": 0
                    }
                },
                "aws": {
                    "xray": {
                        "sampling_rule_name": "Default"
                    },
                    "api_gateway": {
                        "account_id": "123412341234",
                        "rest_api_id": "a1b2c3d4e5",
                        "stage": "dev",
                        "request_id": "a1b2c3d4-a1b2-a1b2-a1b2-a1b2c3d4e5f6"
                    }
                },
                "annotations": {
                    "aws:api_id": "a1b2c3d4e5",
                    "aws:api_stage": "dev"
                },
                "trace_id": "1-a1b2c3d4-a1b2c3d4a1b2c3d4a1b2c3d4",
                "origin": "AWS::ApiGateway::Stage",
                "resource_arn": "arn:aws:apigateway:us-east-1::/restapis/a1b2c3d4e5/stages/dev",
                "subsegments": [
                    {
                        "id": "abcdefgh12345678",
                        "name": "Lambda",
                        "start_time": 1533928226.233,
                        "end_time": 1533928226.6130002,
                        "http": {
                            "request": {
                                "url": "https://example.com/2015-03-31/functions/arn:aws:lambda:us-east-1:123412341234:function:xray123/invocations",
                                "method": "GET"
                            },
                            "response": {
                                "status": 200,
                                "content_length": 62
                            }
                        },
                        "aws": {
                            "function_name": "xray123",
                            "region": "us-east-1",
                            "operation": "Invoke",
                            "resource_names": [
                                "xray123"
                            ]
                        },
                        "namespace": "aws"
                    }
                ]
            },
            "Id": "a1b2c3d4a1b2c3d4"
        }