Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

AWS X-Ray jejak untuk API Amazon API Gateway

Bagian ini membahas segmen AWS X-Ray penelusuran, subsegmen, dan bidang penelusuran lainnya untuk API Amazon API Gateway.

Sebelum Anda membaca bagian ini, tinjau topik-topik berikut di Panduan Pengembang X-Ray:

Contoh objek pelacakan untuk API Gateway API

Bagian ini membahas beberapa objek yang mungkin Anda lihat dalam jejak untuk API Gateway API.

Anotasi

Anotasi dapat muncul di segmen dan subsegmen. Mereka digunakan sebagai ekspresi penyaringan dalam aturan pengambilan sampel untuk memfilter jejak. Untuk informasi selengkapnya, lihat Mengonfigurasi aturan pengambilan sampel.

Berikut ini adalah contoh annotations objek, di mana tahap API diidentifikasi oleh ID API dan nama tahap API:

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

Untuk informasi selengkapnya tentang anotasi, lihat dokumen segmen X-Ray, lalu pilih dokumen segmen X-Ray, Anotasi.

AWS data sumber daya

awsObjek hanya muncul di segmen. Berikut ini adalah contoh dari sebuah aws objek yang cocok dengan aturan Default sampling. Untuk penjelasan mendalam tentang aturan pengambilan sampel, lihat Mengonfigurasi aturan pengambilan sampel.

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

Untuk informasi selengkapnya tentang aws objek, lihat dokumen segmen X-Ray, lalu pilih dokumen segmen X-Ray, data AWS sumber daya.

Memahami jejak

Berikut ini adalah segmen jejak untuk tahap API Gateway. Untuk penjelasan rinci tentang bidang yang membentuk segmen jejak, lihat dokumen segmen 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"
        }