Adición de anotaciones y metadatos a los segmentos con el SDK de X-Ray para Go

Puede usar anotaciones y metadatos para registrar información adicional sobre las solicitudes, el entorno o la aplicación. Puede añadir anotaciones y metadatos a los segmentos que crea el SDK de X-Ray o a los subsegmentos personalizados que cree usted mismo.

Las anotaciones son pares de clave-valor con valores de cadena, numéricos o booleanos. Las anotaciones se indexan para su uso con expresiones de filtro. Utilice anotaciones para registrar los datos que desee utilizar para agrupar rastros en la consola o cuando llame a la API de GetTraceSummaries.

Los metadatos son pares de clave-valor con valores de cualquier tipo, por ejemplo objetos y listas, pero que no se indexan para utilizarlos con expresiones de filtro. Utilice los metadatos para registrar datos adicionales que desee almacenar en el rastro, pero que no necesite usar para hacer búsquedas.

Además de anotaciones y metadatos, también puede registrar cadenas de ID de usuario en los segmentos. Los identificadores de usuario se registran en un campo aparte en segmentos y se indexan para su uso con la búsqueda.

Registro de anotaciones con el SDK de X-Ray para Go

Utilice anotaciones para registrar información sobre segmentos que desee indexar para las búsquedas.

Requisitos de anotación

• Teclas: la clave de una anotación de X-Ray puede tener hasta 500 caracteres alfanuméricos. No puede utilizar espacios ni símbolos distintos del símbolo de subrayado (_).

• Valores: el valor de una anotación de X-Ray puede tener hasta 1000 caracteres Unicode.

• Número de anotaciones: puede utilizar hasta 50 anotaciones por traza.

Para grabar anotaciones, llame a AddAnnotation con una cadena que contenga los metadatos que desea asociar con el segmento.

xray.AddAnnotation(key string, value interface{})

El SDK registra las anotaciones como pares de clave-valor en un objeto annotations del documento de segmento. Si llama dos veces a AddAnnotation con la misma clave, se sobrescriben los valores previamente registrados en el mismo segmento.

Para encontrar rastros que tengan anotaciones con valores específicos, utilice la palabra clave annotations.key en una expresión de filtro.

Registro de metadatos con el SDK de X-Ray para Go

Utilice los metadatos para registrar información sobre segmentos que no necesite indexar para las búsquedas.

Para registrar metadatos, llame a AddMetadata con una cadena que contenga los metadatos que desea asociar con el segmento.

xray.AddMetadata(key string, value interface{})

Registro de ID de usuario con el SDK de X-Ray para Go

Registre identificadores de usuario en segmentos de solicitud para identificar al usuario que envió la solicitud.

Para registrar identificadores de usuario

1. Obtenga una referencia al segmento actual desde AWSXRay.

   import (
     "context"
     "github.com/aws/aws-xray-sdk-go/xray"
   )
   
   mySegment := xray.GetSegment(context)

2. Llame a setUser con un ID de cadena del usuario que envió la solicitud.

   mySegment.User = "U12345"

Para buscar rastros de un ID de usuario, utilice la palabra clave user en una expresión de filtro.