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.
AWS X-Ray SDK for Ruby
El SDK de X-Ray es una biblioteca para las aplicaciones web de Ruby que proporciona clases y métodos para generar y enviar datos de rastreo al daemon de X-Ray. Los datos de rastreo incluyen información sobre las solicitudes HTTP entrantes atendidas por la aplicación y las llamadas que la aplicación realiza a los servicios descendentes mediante el AWS SDK, los clientes HTTP o un cliente de registro activo. También puede crear segmentos de forma manual y agregar información de depuración en anotaciones y metadatos.
Puede descargar el SDK añadiéndolo a su archivo Gemfile y ejecutando bundle
install.
ejemplo Archivo Gemfile
gem 'aws-sdk'
Si utiliza Rails, en primer lugar añada el middleware del SDK de X-Ray para rastrear las solicitudes entrantes. Un filtro de solicitudes crea un segmento. Mientras el segmento está abierto, puede utilizar los métodos del cliente del SDK para añadir información al segmento y crear subsegmentos para rastrear llamadas posteriores. El SDK también registra automáticamente las excepciones que produce su aplicación mientras el segmento está abierto. Para las aplicaciones que no son de Rails, puede crear segmentos manualmente.
A continuación, utilice el SDK de X-Ray para AWS SDK for Ruby instrumentar sus clientes HTTP y SQL configurando la grabadora para que aplique parches a las bibliotecas asociadas. Cada vez que realizas una llamada a un recurso Servicio de AWS o a un flujo con un cliente instrumentado, el SDK registra la información sobre la llamada en un subsegmento. Servicios de AWS y los recursos a los que accedes desde los servicios aparecen como nodos descendentes en el mapa de rastreo para ayudarte a identificar los errores y los problemas de limitación en las conexiones individuales.
En cuanto empiece a utilizar el SDK, personalice su comportamiento configurando la grabadora. Puede añadir complementos para registrar datos sobre los recursos informáticos que ejecutan la aplicación, personalizar el comportamiento de muestreo mediante la definición de reglas de muestreo y proporcionar un registrador para ver más o menos información del SDK en los logs de la aplicación.
Registre información adicional acerca de las solicitudes y el trabajo que la aplicación realiza en anotaciones y metadatos. Las anotaciones son pares sencillos de clave-valor que se indexan para su uso con expresiones de filtro para poder buscar rastros que contengan datos específicos. Las entradas de metadatos son menos restrictivas y pueden registrar objetos y matrices completos, es decir, todo lo que se pueda serializar en JSON.
Anotaciones y metadatos
Las anotaciones y los metadatos son texto arbitrario que se agrega a los segmentos con el SDK de X-Ray. Las anotaciones se indexan para su uso con expresiones de filtro. Los metadatos no se indexan pero se pueden ver en el segmento sin procesar con la consola o la API de X-Ray. Cualquier persona a la que conceda acceso de lectura a X-Ray puede ver estos datos.
Cuando tenga muchos clientes instrumentados en su código, un único segmento de solicitud puede contener un gran número de subsegmentos, uno para cada llamada realizada con un cliente instrumentado. Puede organizar y agrupar los subsegmentos incluyendo las llamadas del cliente en subsegmentos personalizados. Puede crear un subsegmento personalizado para una función completa o para cualquier sección de código, y registrar los metadatos y las anotaciones en el subsegmento en lugar de escribirlo todo en el segmento principal.
Para acceder a la documentación de referencia de las clases y los métodos del SDK, consulte la Referencia de la API del SDK de AWS X-Ray para Ruby.
Requisitos
El SDK de X-Ray requiere Ruby 2.3 o posterior y es compatible con las siguientes bibliotecas:
-
AWS SDK for Ruby versión 3.0 o posterior
-
Rails versión 5.1 o posterior
