Uso de la API de 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.

Uso de la API de X-Ray

Si el SDK de X-Ray no es compatible con su lenguaje de programación, puede usar las API de X-Ray directamente o la AWS Command Line Interface (AWS CLI) para llamar a los comandos de la API de X-Ray. Emplee las siguientes directrices para escoger la forma de interactuar con la API:

  • Utilice la AWS CLI para simplificar la sintaxis mediante comandos preformateados o con opciones incluidas en su solicitud.

  • Utilice la API de X-Ray directamente para flexibilizar y personalizar al máximo las solicitudes que haga a X-Ray.

Si usa la API de X-Ray directamente en lugar de la AWS CLI, deberá parametrizar la solicitud en el formato de datos correcto y es posible que también tenga que configurar la autenticación y la gestión de errores.

El siguiente diagrama muestra una guía para elegir cómo interactuar con la API de X-Ray:

X-Ray muestra información detallada sobre las solicitudes de aplicaciones.

Utilice la API de X-Ray para enviar datos de rastreo directamente a X-Ray. La API de X-Ray admite todas las funciones disponibles en el SDK de X-Ray, incluidas las siguientes acciones comunes:

  • PutTraceSegments: carga documentos de segmentos a X-Ray.

  • BatchGetTraces: recupera una lista de rastros en una lista de ID de rastros. Cada rastro recuperado es una recopilación de documentos de segmentos de una única solicitud.

  • GetTraceSummaries: recupera los ID y las anotaciones de los rastros. Puede especificar un FilterExpression para recuperar un subconjunto de resúmenes de rastreo.

  • GetTraceGraph: recupera un gráfico de servicio para un ID de rastro específico.

  • GetServiceGraph: recupera un documento con formato JSON que describe los servicios que procesan las solicitudes entrantes y las solicitudes posteriores a la llamada.

También puede usar la AWS Command Line Interface (AWS CLI) dentro del código de su aplicación para interactuar mediante programación con X-Ray. La AWS CLI es compatible con todas las funciones disponibles en el SDK de X-Ray, incluidas las de otros Servicios de AWS. Las siguientes funciones son versiones de las operaciones de la API indicadas anteriormente, pero con un formato más simple:

  • put-trace-segments: carga documentos de segmentos a X-Ray.

  • batch-get-traces: recupera una lista de rastros en una lista de ID de rastros. Cada rastro recuperado es una recopilación de documentos de segmentos de una única solicitud.

  • get-trace-summaries: recupera los ID y las anotaciones de los rastros. Puede especificar un FilterExpression para recuperar un subconjunto de resúmenes de rastreo.

  • get-trace-graph: recupera un gráfico de servicio para un ID de rastro específico.

  • get-service-graph: recupera un documento con formato JSON que describe los servicios que procesan las solicitudes entrantes y las solicitudes posteriores a la llamada.

Para empezar, debe instalar la AWS CLI para su sistema operativo. AWS es compatible con sistemas operativos Linux, macOS y Windows. Para obtener más información sobre la lista de comandos de X-Ray, consulte la AWS CLI Command Reference guide for X-Ray.