Configuración de reglas de muestreo de

Puede usar la AWS X-Ray consola para configurar las reglas de muestreo para sus servicios. El SDK de X-Ray y los Servicios de AWS que admiten el rastreo activo con configuración de muestreo utilizan reglas de muestreo para determinar qué solicitudes registrar.

Configuración de reglas de muestreo de

Puede configurar el muestreo para los siguientes casos de uso:

• Punto de entrada de API Gateway: API Gateway admite el muestreo y el rastreo activo. Para habilitar el rastreo activo en una etapa de la API, consulte Soporte de rastreo activo de Amazon API Gateway para AWS X-Ray.

• AWS AppSync— AWS AppSync admite el muestreo y el rastreo activo. Para habilitar el rastreo activo en las AWS AppSync solicitudes, consulte Rastreo con X-Ray AWS.

• SDK de X-Ray para instrumentos en plataformas informáticas: cuando se utilizan plataformas informáticas como Amazon EC2, Amazon ECS o AWS Elastic Beanstalk, se admite el muestreo cuando la aplicación se ha equipado con el último SDK de X-Ray.

Personalización de reglas de muestreo

Al personalizar las reglas de muestreo, puede controlar la cantidad de datos que va a registrar. También puede modificar el comportamiento del muestreo sin modificar ni volver a implementar el código. Las reglas de muestreo indican al SDK de X-Ray cuántas solicitudes se van a registrar para un conjunto de criterios. De forma predeterminada, el SDK de X-Ray registra la primera solicitud cada segundo y el 5 % de las solicitudes adicionales. Una petición por segundo es el depósito. Esto garantiza que se registre al menos un registro de seguimiento cada segundo mientras el servicio atienda solicitudes. El cinco por ciento es el porcentaje al que se muestrean las solicitudes adicionales más allá del tamaño del depósito.

Puede configurar el SDK de X-Ray para leer reglas de muestreo desde un documento JSON que incluya con su código. Sin embargo, cuando ejecute varias instancias de su servicio, cada instancia realiza el muestreo de manera independiente. Esto hace que el porcentaje total de solicitudes muestreadas aumente, ya que los depósitos de todas las instancias se suman de forma efectiva. Además, para actualizar las reglas de muestreo locales, tiene que volver a implementar su código.

Al definir las reglas de muestreo en la consola de X-Ray y configurar el SDK para leer reglas desde el servicio de X-Ray, puede evitar ambos problemas. El servicio administra el depósito de cada regla y asigna cuotas a cada instancia de su servicio para distribuir el depósito de manera uniforme, en función del número de instancias que se ejecuten. El límite del depósito se calcula de acuerdo con las reglas que haya establecido. Dado que las reglas están configuradas en el servicio, puede administrar las reglas sin realizar implementaciones adicionales.

nota

X-Ray aplica las reglas de muestreo en la medida de lo posible y, en algunos casos, el porcentaje de muestreo efectivo puede no coincidir exactamente con las reglas de muestreo configuradas. Sin embargo, con el tiempo, el número de solicitudes muestreadas debería estar cerca del porcentaje configurado.

Ahora puede configurar las reglas de muestreo de X-Ray desde la CloudWatch consola de Amazon. También puede seguir utilizando la consola de X-Ray.

CloudWatch console

Para configurar las reglas de muestreo en la CloudWatch consola

1. Inicie sesión en la CloudWatch consola AWS Management Console y ábrala en https://console.aws.amazon.com/cloudwatch/.

2. Elija Configuración en el panel de navegación izquierdo.

3. Seleccione Ver configuración en Reglas de muestreo en la sección de Rastros de X-Ray.

4. Para crear una regla, elija Crear regla de muestreo.

   Para editar una regla, elija la regla y, a continuación, elija Editar.

   Para eliminar una regla, elija la regla y, a continuación, elija la opción Eliminar.

X-Ray console

Configuración de las reglas de muestreo en la consola de X-Ray

1. Abra la consola de X-Ray.

2. En el panel de navegación izquierdo, elija Muestreo.

3. Para crear una regla, elija Crear regla de muestreo.

   Para editar una regla, elija el nombre de una regla.

   Para eliminar una regla, elija una regla y utilice el menú Acciones para eliminarla.

Opciones de reglas de muestreo

Las siguientes opciones están disponibles para cada regla. En los valores de cadena se pueden usar caracteres comodín para buscar coincidencias de un solo carácter (?) o cero o más caracteres (*).

Opciones de reglas de muestreo

• Nombre de la regla (cadena): un nombre único para la regla.

• Prioridad (entero comprendido entre el 1 y 9999): prioridad de la regla de muestreo. Los servicios evalúan las reglas en orden ascendente de prioridad y toman una decisión de muestreo con la primera regla coincidente.

• Depósito (entero no negativo): número fijo de solicitudes coincidentes que se van a instrumentar por segundo, antes de aplicar el porcentaje fijo. Los servicios no utilizan directamente el depósito, sino que se aplica a todos los servicios que usan la regla en su conjunto.

• Porcentaje (entero comprendido entre el 0 y el 100): porcentaje de solicitudes coincidentes que se van instrumentar, una vez que se ha agotado el depósito. Al configurar una regla de muestreo en la consola, elija un porcentaje entre 0 y 100. Al configurar una regla de muestreo en un SDK de cliente mediante un documento JSON, proporcione un valor porcentual entre 0 y 1.

• Nombre del servicio (cadena): el nombre del servicio instrumentado, tal como aparece en el mapa de rastreo.

  • SDK de X-Ray: el nombre del servicio que se configura en la grabadora.

  • Amazon API Gateway: api-name/stage.

• Tipo de servicio (cadena): el tipo de servicio, tal como aparece en el mapa de rastreo. Para el SDK de X-Ray, defina el tipo de servicio aplicando el complemento adecuado:

  • AWS::ElasticBeanstalk::Environment— Un AWS Elastic Beanstalk entorno (complemento).

  • AWS::EC2::Instance: una instancia de Amazon EC2 (complemento).

  • AWS::ECS::Container: un contenedor de Amazon ECS (complemento).

  • AWS::APIGateway::Stage: una etapa de Amazon API Gateway.

  • AWS::AppSync::GraphQLAPI — Una solicitud AWS AppSync de API.

• Host (cadena): nombre de host del encabezado de host HTTP.

• Método HTTP (cadena): el método de la solicitud HTTP.

• Ruta URL (cadena): la ruta URL de la solicitud.

  • SDK de X-Ray: la parte de la ruta de la URL de la solicitud HTTP.

• ARN del recurso (cadena): el ARN del AWS recurso que ejecuta el servicio.

  • SDK de X-Ray: no compatible. El SDK solo puede utilizar reglas con Resource ARN (ARN de recurso) configurado en *.

  • Amazon API Gateway: el ARN de etapa.

• (Opcional) Atributos (clave y valor): atributos de segmento que se conocen cuando se toma la decisión de muestreo.

  • SDK de X-Ray: no compatible. El SDK omite las reglas que especifican atributos.

  • Amazon API Gateway: encabezados de la solicitud HTTP original.

Ejemplos de reglas de muestreo

ejemplo – Regla predeterminada sin depósito y con un porcentaje bajo

Puede modificar el depósito predeterminado de la regla y el porcentaje. La regla predeterminada se aplica a las solicitudes que no coinciden con cualquier otra regla.

• Depósito: 0

• Porcentaje: 5 (0.05 si se configura mediante un documento JSON)

ejemplo – Regla de depuración para rastrear todas las solicitudes para una ruta problemática

Una regla de alta prioridad aplicada temporalmente para depuración.

• Nombre de la regla: DEBUG – history updates

• Prioridad: 1

• Depósito: 1

• Porcentaje: 100 (1 si se configura mediante un documento JSON)

• Nombre del servicio: Scorekeep

• Tipo de servicio: *

• Host: *

• Método HTTP: PUT

• Ruta URL: /history/*

• ARN de recurso: *

ejemplo – Porcentaje mínimo superior para POST

• Nombre de la regla: POST minimum

• Prioridad: 100

• Depósito: 10

• Porcentaje: 10 (.1 si se configura mediante un documento JSON)

• Nombre del servicio: *

• Tipo de servicio: *

• Host: *

• Método HTTP: POST

• Ruta URL: *

• ARN de recurso: *

Configuración del servicio para utilizar reglas de muestreo

El SDK de X-Ray requiere configuración adicional para utilizar reglas de muestreo que configura en la consola. Consulte el tema de configuración para su lenguaje para obtener más información sobre cómo configurar una estrategia de muestreo.

• Java: Reglas de muestreo

• Go: Reglas de muestreo

• Node.js: Reglas de muestreo

• Python: Reglas de muestreo

• Ruby: Reglas de muestreo

• .NET: Reglas de muestreo

Para API Gateway, consulte: Soporte de rastreo activo de Amazon API Gateway para AWS X-Ray.

Visualización de resultados de muestreo

La página de Muestreo de la consola de X-Ray muestra información detallada sobre cómo los servicios del usuario utilizan cada regla de muestreo.

La columna Trend (Tendencia) muestra cómo se ha utilizado la regla en los últimos minutos. Cada columna muestra las estadísticas para una ventana de 10 segundos.

Estadísticas de muestreo

• Regla coincidente total: el número de solicitudes que coincidieron con esta regla. Este número no incluye solicitudes que podrían haber coincidido con esta regla, pero coincidieron primero con una regla de prioridad más alta.

• Total muestreado: el número de solicitudes registradas.

• Muestreadas con porcentaje fijo: número de solicitudes muestreadas aplicando el porcentaje fijo de la regla.

• Muestreado con límite de depósito: el número de solicitudes muestreadas utilizando una cuota asignada por X-Ray.

• Préstamos del depósito: número de solicitudes muestreadas tomando prestado del depósito. La primera vez que un servicio hace coincidir una solicitud con una regla, X-Ray aún no le ha asignado una cuota. Sin embargo, si el depósito es al menos 1, el servicio toma prestado un rastro por segundo hasta que X-Ray asigna una cuota.

Para obtener más información acerca de cómo utilizar las estadísticas de muestreo y cómo utilizan las reglas de muestreo los servicios, consulte Using sampling rules with the X-Ray API (Uso de reglas de muestreo con la API de X-Ray).

Siguientes pasos

Puede usar la API de X-Ray para administrar reglas de muestreo. Con la API, puede crear y actualizar las reglas mediante programación de forma programada o en respuesta a alarmas o notificaciones. Consulte Configuración de las opciones de muestreo, grupos y cifrado con la API de AWS X-Ray para obtener instrucciones y ejemplos de reglas adicionales.

El SDK de X-Ray y Servicios de AWS también utilizan la API de X-Ray para leer las reglas de muestreo, informar los resultados del muestreo y obtener los objetivos de muestreo. Los servicios deben realizar un seguimiento de la frecuencia con la que se aplica cada regla, evaluar las reglas en función de la prioridad y tomar prestado del depósito cuando una solicitud coincide con una regla para la que X-Ray no ha asignado aún una cuota al servicio. Para obtener más información acerca de cómo utiliza un servicio la API para muestreo, consulte Using sampling rules with the X-Ray API (Uso de reglas de muestreo con la API de X-Ray).

Cuando el SDK de X-Ray llama a las API de muestreo, utiliza el daemon de X-Ray como proxy. Si ya utiliza el puerto de TCP 2000, puede configurar el demonio para ejecutar el proxy en un puerto diferente. Para obtener más información, consulte Configuración del AWS X-Ray daemon.