Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

AWS X-Ray traces pour les API Amazon API Gateway

Cette section décrit les segments de AWS X-Ray trace, les sous-segments et les autres champs de trace pour les API Amazon API Gateway.

Avant de lire cette section, veuillez consulter les rubriques suivantes dans le Manuel du développeur X-Ray :

Exemples d'objets de suivi pour une API API Gateway

Cette section décrit quelques-uns des objets que vous pouvez voir dans le suivi d'une API API Gateway.

Annotations

Des annotations peuvent s'afficher dans les segments et les sous-segments. Elles sont utilisées comme expressions de filtrage dans les règles d'échantillonnage pour filtrer les suivis. Pour plus d'informations, voir Configuration des règles d'échantillonnage.

Voici un exemple d'objet annotations, dans lequel une étape d'API est identifiée par l'ID d'API et le nom de l'étape d'API :

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

Pour plus d'informations sur les annotations, consultez la section Documents du segment X-Ray, puis choisissez Documents du segment X-Ray, Annotations.

AWS données sur les ressources

L'objet aws s'affiche uniquement dans des segments. Voici un exemple d'objet qui aws correspondant à la règle d'échantillonnage par défaut. Pour une explication détaillée des règles d'échantillonnage, voir Configurer les règles d'échantillonnage.

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

Pour plus d'informations sur l'awsobjet, consultez la section Documents du segment X-Ray, puis choisissez Documents du segment X-Ray, données de AWS ressources.

Présentation des suivis

Voici un segment de suivi pour une étape d'API Gateway. Pour une explication détaillée des champs qui constituent le segment de trace, consultez les documents relatifs aux segments 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"
        }