Rastreo de las solicitudes entrantes con el SDK de X-Ray para middleware de Ruby

Puede utilizar el SDK de X-Ray para rastrear las solicitudes HTTP entrantes que su aplicación atiende en una instancia de EC2 en Amazon EC2, AWS Elastic Beanstalk o Amazon ECS.

Si utiliza Rails, use el middleware de Rails para instrumentar las solicitudes HTTP entrantes. Cuando añade el middleware a su aplicación y configura un nombre de segmento, el SDK de X-Ray para Ruby crea un segmento para cada solicitud muestreada. Cualquier segmento que se haya creado con instrumentación adicional se convierte en subsegmentos del segmento en nivel de la solicitud, el cual provee información sobre la solicitud HTTP y la respuesta. Esta información incluye el momento, el método y la disposición de la solicitud.

Cada segmento tiene un nombre que identifica la aplicación en el mapa de servicio. El nombre del segmento se puede asignar de forma estática o se puede configurar el SDK para que le asigne un nombre dinámico en función del encabezado del host de la solicitud entrante. La nomenclatura dinámica permite agrupar los rastros en función del nombre de dominio de la solicitud y aplicar un nombre predeterminado si el nombre no coincide con el patrón esperado (por ejemplo, si el encabezado del host está falsificado).

Cuando se reenvía una solicitud, el SDK crea un campo adicional en el segmento para indicar que se realizó esta acción. Si el segmento contiene el campo x_forwarded_for configurado en true, el IP del cliente se obtiene a partir del encabezado X-Forwarded-For en la solicitud HTTP.

El middleware crea un segmento para cada solicitud entrante con un bloque http que contiene la siguiente información:

Uso del middleware de Rails

Para utilizar el middleware, actualice el archivo Gemfile para que incluya el railtie necesario.

gem 'aws-xray-sdk', require: ['aws-xray-sdk/facets/rails/railtie']

Para utilizar el middleware, también debe configurar la grabadora con un nombre que represente a la aplicación en el mapa de rastro.

Rails.application.config.xray = {
  name: 'my app'
}

Instrumentación manual del código

Si no utiliza Rails, cree los segmentos manualmente. Puede crear un segmento para cada solicitud entrante o crear segmentos en torno a los clientes HTTP o del SDK de AWS para proporcionar contexto para que la grabadora añada subsegmentos.

# Start a segment
segment = XRay.recorder.begin_segment 'my_service'
# Start a subsegment
subsegment = XRay.recorder.begin_subsegment 'outbound_call', namespace: 'remote'

# Add metadata or annotation here if necessary
my_annotations = {
  k1: 'v1',
  k2: 1024
}
segment.annotations.update my_annotations

# Add metadata to default namespace
subsegment.metadata[:k1] = 'v1'

# Set user for the segment (subsegment is not supported)
segment.user = 'my_name'

# End segment/subsegment
XRay.recorder.end_subsegment
XRay.recorder.end_segment

Configuración de una estrategia de nomenclatura de segmentos

AWS X-Ray utiliza un nombre de servicio para identificar la aplicación y distinguirla del resto de aplicaciones, bases de datos, API externas y recursos de AWS utilizados por la aplicación. Cuando el SDK de X-Ray genera segmentos para las solicitudes entrantes, registra el nombre del servicio de la aplicación en el campo de nombre del segmento.

El SDK de X-Ray puede nombrar los segmentos utilizando el nombre de host en el encabezado de la solicitud HTTP. Sin embargo, este encabezado se puede falsificar, lo que podría provocar nodos inesperados en el mapa de servicio. Para evitar que el SDK nombre los segmentos de forma incorrecta debido a que las solicitudes tienen encabezados de host falsificados, debe especificar un nombre predeterminado para las solicitudes entrantes.

Si la aplicación atiende solicitudes de varios dominios, puede configurar el SDK para que utilice una estrategia de nomenclatura dinámica que refleje esto en los nombres de los segmentos. Una estrategia de nomenclatura dinámica permite al SDK usar el nombre de host para las solicitudes que coinciden con un patrón esperado y aplicar el nombre predeterminado a las solicitudes que no coincidan.

Por ejemplo, es posible que tenga una sola aplicación que atienda solicitudes a tres subdominios: www.example.com, api.example.com y static.example.com. Puede usar una estrategia de nomenclatura dinámica con el patrón *.example.com para identificar los segmentos de cada subdominio con un nombre diferente, lo que da como resultado tres nodos de servicio en el mapa de servicio. Si su aplicación recibe solicitudes con un nombre de host que no coincide con el patrón, verá un cuarto nodo en el mapa de servicio con el nombre alternativo que especifique.

Si desea utilizar el mismo nombre para todos los segmentos de solicitud, especifique el nombre de la aplicación cuando configure la grabadora, como se muestra en las secciones anteriores.

Una estrategia de nomenclatura dinámica define un patrón con el que deben coincidir los nombres de host y un nombre predeterminado que se utiliza si el nombre de host de la solicitud HTTP no coincide con el patrón. Para asignar nombre a los segmentos de forma dinámica, especifique un patrón de nomenclatura en el hash config.

config = {
  naming_pattern: '*mydomain*',
  name: 'my app',
}

XRay.recorder.configure(config)

Puede utilizar "*" en el patrón para buscar coincidencia con cualquier cadena o "?" para buscar coincidencias con cualquier carácter único.