Grundlegendes zu AWS X-Ray-Ablaufverfolgungen für Amazon-API-Gateway-APIs

In diesem Abschnitt werden AWS X-Ray-Ablaufverfolgungssegmente, Untersegmente und andere Nachverfolgungsfelder für Amazon-API-Gateway-APIs erläutert.

Bevor Sie diesen Abschnitt lesen, lesen Sie sich die folgenden Themen im X-Ray-Entwicklerhandbuch durch:

• AWS X-Ray Konsole

• AWS X-Ray Segmentdokumente

• X-Ray-Konzepte

Beispiele für Ablaufverfolgungsobjekte für eine API Gateway-API

In diesem Abschnitt werden einige der Objekte erläutert, die in einer Ablaufverfolgung für eine API Gateway-API angezeigt werden.

Annotationen

Anmerkungen können in Segmenten und Untersegmenten vorkommen. Sie werden als Filterausdrücke in Stichprobenregeln zum Filtern von Nachverfolgungs verwendet. Weitere Informationen finden Sie unter Konfigurieren von Samplingregeln in der AWS X-Ray-Konsole.

Im Folgenden sehen Sie ein Beispiel für ein annotations-Objekt, in dem eine API-Stufe durch die API-ID und den API-Stufennamen identifiziert wird:

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

AWS Ressourcendaten

Das aws-Objekt wird nur in Segmenten angezeigt. Im Folgenden finden Sie ein Beispiel für ein aws Objekt, das der Standard-Sampling-Regel entspricht. Eine ausführliche Erläuterung der Samplingregeln finden Sie unter Konfigurieren von Samplingregeln in der AWS X-Ray-Konsole.

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

Verstehen der Ablaufverfolgung

Im Folgenden finden Sie ein Ablaufverfolgungssegment für eine API Gateway-Stufe. Eine detaillierte Beschreibung der Felder, aus denen das Nachverfolgungssegment besteht, finden Sie unter AWS X-Ray-Segmentdokumente im AWS X-Ray-Entwicklerhandbuch.

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