Présentation des suivis AWS X-Ray pour les API d'Amazon API Gateway

Cette section traite des segments et sous-segments de suivi AWS X-Ray, ainsi que d'autres champs de suivi pour les API d'Amazon API Gateway.

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

• AWS X-Ray Console

• AWS X-Ray Documents de segment

• Concepts 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, consultez la section Configuration des règles d'échantillonnage dans la console AWS X-Ray.

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

AWS Données de 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 approfondie des règles d'échantillonnage, consultez la section Configuration de règles d'échantillonnage dans la console 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"
    }
}

Présentation des suivis

Voici un segment de suivi pour une étape d'API Gateway. Pour obtenir une explication détaillée des champs qui composent le segment de suivi, veuillez consulter Documents de segment AWS X-Ray dans le Guide du développeur 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"
        }