本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# AWS X-Ray Amazon API Gateway APIs追蹤
<a name="apigateway-understanding-xray-traces"></a>

本節討論 Amazon API Gateway APIs 的 AWS X-Ray 追蹤區段、子區段和其他追蹤欄位。

在閱讀本節之前，請先參閱《X-Ray 開發人員指南》中的下列主題：
+  [使用 AWS 管理主控台](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-console.html)
+  [X-Ray 區段文件](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-api.html#xray-api-segmentdocuments)
+ [概念](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray.html#xray-concepts)

**Topics**
+ [為 API Gateway API 追蹤物件的範例](#apigateway-understanding-xray-traces-example-segments)
+ [了解追蹤](#apigateway-understanding-xray-traces-segments)

## 為 API Gateway API 追蹤物件的範例
<a name="apigateway-understanding-xray-traces-example-segments"></a>

本節討論您可能會在 API Gateway API 的追蹤中看到的一些物件。

**註釋**

註釋則顯示在區段和子區段中。它們在取樣規則中用做篩選追蹤的篩選運算式。如需詳細資訊，請參閱[設定取樣規則](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-console.html#xray-console-sampling)。

以下是 `annotations` 物件範例，其中 API 階段由 API ID 和 API 階段名稱識別：

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

如需註釋的詳細資訊，請參閱《[X-Ray 區段文件](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-api.html#xray-api-segmentdocuments)》，然後選擇 **X-Ray 區段文件**、**註釋**。

**AWS 資源資料**

`aws` 物件僅顯示在區段中。以下是符合預設取樣規則的 `aws` 物件範例。如需取樣規則的深入解說，請參閱[設定取樣規則](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-console.html#xray-console-sampling)。

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

如需有關 `aws` 物件的詳細資訊，請參閱《[X-Ray 區段文件](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-api.html#xray-api-segmentdocuments)》，然後選擇 **X-Ray 區段文件**、**AWS 資源資料**。

## 了解追蹤
<a name="apigateway-understanding-xray-traces-segments"></a>

以下是 API Gateway 階段的追蹤區段。如需有關組成追蹤區段之欄位的詳細解說，請參閱《[X-Ray 區段文件](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-api.html#xray-api-segmentdocuments)》。

```
        {
            "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"
        }
```