Adicionar anotações e metadados aos segmentos com o X-Ray SDK para Go

Você pode usar anotações e metadados para registrar informações adicionais sobre solicitações, o ambiente ou seu aplicativo. Também é possível adicionar anotações e metadados aos segmentos que o X-Ray SDK cria ou aos subsegmentos personalizados que você cria.

Anotações são pares de chave-valor com valores boolianos, de string ou número. As anotações são indexadas para serem usadas com expressões de filtro. Use anotações para registrar dados que você deseja usar para agrupar rastreamentos no console ou ao chamar a API GetTraceSummaries.

Metadados são pares chave-valor que podem ter valores de qualquer tipo, incluindo objetos e listas, mas não são indexados para uso com expressões de filtro. Use metadados para registrar dados adicionais que você deseja armazenar no rastreamento e não precisa usar com a pesquisa.

Além de anotações e metadados, você também pode registrar strings de ID de usuário em segmentos. Os IDs de usuário são registrados em um campo separado nos segmentos e são indexados para serem usados com pesquisa.

Registrar anotações com o X-Ray SDK para Go

Use anotações para gravar informações sobre segmentos que você deseja indexados para pesquisa.

Requisitos de anotação

• Teclas — A chave para uma anotação de X-Ray pode ter até 500 caracteres alfanuméricos. Você não pode usar espaços ou símbolos além do símbolo de sublinhado (_).

• Valores — O valor de uma anotação X-Ray pode ter até 1.000 caracteres Unicode.

• O número de anotações — Você pode usar até 50 anotações por rastreamento.

Para gravar anotações, chame AddAnnotation com uma string que contém os metadados que você deseja associar ao segmento.

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

O SDK registra anotações como pares de chave-valor em um objeto annotations no documento de segmentos. Chamar AddAnnotation duas vezes com a mesma chave substitui os valores gravados anteriormente no mesmo segmento.

Para encontrar rastreamentos que têm anotações com valores específicos, use a palavra-chave annotations.key em uma expressão de filtro.

Registrar metadados com o X-Ray SDK para Go

Use metadados para gravar informações em segmentos dos quais você não precisa indexados para pesquisa.

Para gravar metadados, chame AddMetadata com uma string que contém os metadados que você deseja associar ao segmento.

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

Registrar IDs de usuário com o X-Ray SDK para Go

Registre IDs de usuário em segmentos de solicitação para identificar o usuário que enviou a solicitação.

Para registrar IDs de usuário

1. Obtenha uma referência para o segmento atual em AWSXRay.

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

2. Chame setUser com um ID de string do usuário que enviou a solicitação.

   mySegment.User = "U12345"

Para encontrar rastreamentos para um ID de usuário, use a user palavra-chave em uma expressão de filtragem.