Adicione anotações e metadados aos segmentos com o X-Ray for Python SDK

Você pode registrar informações adicionais sobre solicitações, o ambiente ou a aplicação com anotações e metadados. Você pode 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 o. GetTraceSummariesAPI

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. IDsOs usuários são registrados em um campo separado nos segmentos e são indexados para uso com a pesquisa.

Gravando anotações com o SDK X-Ray for Python

Use anotações para registrar informações em segmentos ou subsegmentos que você deseja indexar 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 que não sejam um ponto ou ponto (.)

• 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.

Como registrar anotações

1. Obtenha uma referência para o segmento ou subsegmento atual no xray_recorder.

   from aws_xray_sdk.core import xray_recorder
   ...
   document = xray_recorder.current_segment()

   ou

   from aws_xray_sdk.core import xray_recorder
   ...
   document = xray_recorder.current_subsegment()

2. Chame put_annotation com uma chave de string e um valor de número, string ou booleano.

   document.put_annotation("mykey", "my value");

   O exemplo a seguir mostra como chamar putAnnotation com uma chave String que inclui um ponto e um valor booleano, numérico ou string.

   document.putAnnotation("testkey.test", "my value");

Também é possível usar o método put_annotation em xray_recorder. Esse método registra anotações no subsegmento atual ou, se nenhum subsegmento estiver aberto, no segmento.

xray_recorder.put_annotation("mykey", "my value");

As anotações SDK registram como pares de valores-chave em um annotations objeto no documento do segmento. Chamar put_annotation duas vezes com a mesma chave substitui os valores registrados anteriormente no mesmo segmento ou subsegmento.

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

Gravando metadados com o X-Ray SDK for Python

Use metadados para registrar informações em segmentos ou subsegmentos dos quais você não precisa indexados para pesquisa. Os valores de metadados podem ser cadeias de caracteres, números, booleanos ou qualquer objeto que possa ser serializado em um JSON objeto ou matriz.

Como registrar metadados

1. Obtenha uma referência para o segmento ou subsegmento atual no xray_recorder.

   from aws_xray_sdk.core import xray_recorder
   ...
   document = xray_recorder.current_segment()

   ou

   from aws_xray_sdk.core import xray_recorder
   ...
   document = xray_recorder.current_subsegment()

2. Chame put_metadata com uma chave de string, um booliano, um número, uma string ou valor de objeto e um namespace de string.

   document.put_metadata("my key", "my value", "my namespace");

   ou

   Chame put_metadata com apenas uma chave e valor.

   document.put_metadata("my key", "my value");

Também é possível usar o método put_metadata em xray_recorder. Esse método registra metadados no subsegmento atual ou, se nenhum subsegmento estiver aberto, no segmento.

xray_recorder.put_metadata("my key", "my value");

Se você não especificar um namespace, os SDK usos. default Chamar put_metadata duas vezes com a mesma chave substitui os valores registrados anteriormente no mesmo segmento ou subsegmento.

Gravando usuário IDs com o X-Ray SDK for Python

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

Para gravar usuário IDs

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

   from aws_xray_sdk.core import xray_recorder
   ...
   document = xray_recorder.current_segment()

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

   document.set_user("U12345");

Você pode acionar set_user em seus controladores para registrar o ID de usuário assim que a aplicação começar a processar uma solicitação.

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