Soporte de rastreo activo de Amazon API Gateway para AWS X-Ray - AWS X-Ray

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Soporte de rastreo activo de Amazon API Gateway para AWS X-Ray

Puede utilizar X-Ray para rastrear y analizar las solicitudes de los usuarios a medida que viajan a través de las API de Amazon API Gateway a los servicios subyacentes. API Gateway admite el rastreo de X-Ray para todos los tipos de punto de conexión de API Gateway: regional, optimizado para bordes y privado. Puede utilizar X-Ray con Amazon API Gateway en todos los Regiones de AWS lugares donde X-Ray esté disponible. Para obtener más información, consulte Rastreo de la ejecución de API de API Gateway con AWS X-Ray en la Guía para desarrolladores de Amazon API Gateway.

nota

X-Ray solo admite el rastreo de las API de REST a través de API Gateway.

Amazon API Gateway proporciona soporte de rastreo activo para AWS X-Ray. Habilite el rastreo activo en sus etapas de la API para realizar el muestreo de solicitudes entrantes y enviar rastros a X-Ray.

Para habilitar el rastreo activo en una etapa de la API

  1. Abra la consola de API Gateway en https://console.aws.amazon.com/apigateway/.

  2. Elegir una API.

  3. Elegir una etapa.

  4. En la pestaña Registros/Rastreo, elija Habilitar el rastreo de X-Ray y, a continuación, seleccione Guardar cambios.

  5. Seleccione Resources (Recursos) en el panel de navegación del lado izquierdo.

  6. Para volver a implementar la API con la nueva configuración, abra el menú desplegable Acciones y, a continuación, elija Implementar API.

API Gateway utiliza reglas de muestreo que define en la consola de X-Ray para determinar qué solicitudes registrar. Puede crear reglas que solo se apliquen a las API o que solo se apliquen a las solicitudes que contengan determinados encabezados. API Gateway registra los encabezados en atributos del segmento, junto con detalles sobre la etapa y la solicitud. Para obtener más información, consulte Configuración de reglas de muestreo de .

nota

Al rastrear las API REST con la integración HTTP de API Gateway, el nombre de servicio de cada segmento se establece en la ruta URL de solicitud desde API Gateway hasta el punto final de integración HTTP, lo que da como resultado un nodo de servicio en el mapa de rastreo de X-Ray para cada ruta URL única. Un gran número de rutas URL puede provocar que el mapa de rastreo supere el límite de 10 000 nodos y provocar un error.

Para minimizar la cantidad de nodos de servicio creados por API Gateway, considere la posibilidad de pasar los parámetros dentro de la cadena de consulta de URL o en el cuerpo de la solicitud mediante POST. Cualquiera de los dos enfoques garantizará que los parámetros no formen parte de la ruta URL, lo que puede dar lugar a un menor número de rutas URL y nodos de servicio distintos.

Para todas las solicitudes entrantes, API Gateway añade un encabezado de rastreo a las solicitudes HTTP entrantes que no tengan ya uno.

X-Amzn-Trace-Id: Root=1-5759e988-bd862e3fe1be46a994272793
Formato de identificación de trazas de rayos X

Un trace_id de X-Ray consta de tres números separados por guiones. Por ejemplo, 1-58406520-a006649127e371903a2de979. Esto incluye:

  • El número de versión, que es1.

  • La hora de la solicitud original en Unix (época) con 8 dígitos hexadecimales.

    Por ejemplo, a las 10:00 a.m. del 1 de diciembre de 2016 (hora peninsular española), la hora de la época se expresa en 1480615200 segundos o 58406520 en dígitos hexadecimales.

  • Un identificador de 96 bits único a nivel mundial para el rastreo en 24 dígitos hexadecimales.

Si el rastreo activo está deshabilitado, la fase sigue registrando un segmento si la solicitud procede de un servicio que ha muestreado la solicitud e iniciado un rastreo. Por ejemplo, una aplicación web instrumentada puede llamar a una API de API Gateway con un cliente HTTP. Cuando instrumente un cliente HTTP con el SDK de X-Ray, este agrega un encabezado de rastreo a la solicitud saliente que contiene la decisión de muestreo. API Gateway lee el encabezado de rastreo y crea un segmento para las solicitudes muestreadas.

Si utilizas API Gateway para generar un SDK de Java para tu API, puedes instrumentar el cliente del SDK añadiendo un controlador de solicitudes con el generador de clientes, del mismo modo que instrumentarías manualmente un cliente de AWS SDK. Para obtener instrucciones, consulte Rastreo de llamadas al AWS SDK con el X-Ray SDK for Java.