Ajoutez des annotations et des métadonnées aux segments avec le X-Ray SDK for Go

Vous pouvez enregistrer des informations supplémentaires sur les demandes, l'environnement ou votre application à l'aide d'annotations et de métadonnées. Vous pouvez ajouter des annotations et des métadonnées aux segments SDK créés par le X-Ray ou aux sous-segments personnalisés que vous créez.

Les annotations sont des paires clé-valeur avec des chaînes, des nombres ou des valeurs booléennes. Les annotations sont indexées pour être utilisées avec les expressions de filtre. Utilisez des annotations pour enregistrer les données que vous souhaitez utiliser pour regrouper les traces dans la console ou lorsque vous appelez le GetTraceSummariesAPI.

Les métadonnées sont des paires clé-valeur qui peuvent contenir des valeurs de n'importe quel type, y compris des objets et des listes, mais qui ne sont pas indexées pour être utilisées avec des expressions de filtre. Utilisez les métadonnées pour enregistrer des données supplémentaires que vous souhaitez stocker dans le traçage, mais dont vous n'avez pas besoin pour effectuer une recherche.

En plus des annotations et des métadonnées, vous pouvez également enregistrer les chaînes d'ID utilisateur sur des segments. IDsLes utilisateurs sont enregistrés dans un champ distinct sur les segments et sont indexés pour être utilisés dans le cadre de la recherche.

Enregistrer des annotations avec le X-Ray SDK for Go

Utilisez les annotations pour enregistrer les informations sur les segments qui doivent être indexés pour la recherche.

Exigences liées aux annotations

• Clés — La clé d'une annotation X-Ray peut comporter jusqu'à 500 caractères alphanumériques. Vous ne pouvez pas utiliser d'espaces ou de symboles autres qu'un point ou un point (.)

• Valeurs — La valeur d'une annotation X-Ray peut comporter jusqu'à 1 000 caractères Unicode.

• Nombre d'annotations : vous pouvez utiliser jusqu'à 50 annotations par trace.

Pour enregistrer des annotations, appelez AddAnnotation avec une chaîne contenant les métadonnées à associer au segment.

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

SDKEnregistre les annotations sous forme de paires clé-valeur dans un annotations objet du document segmenté. Si vous appelez deux fois AddAnnotation avec la même clé, les valeurs précédemment enregistrées sur le même segment sont remplacées.

Pour rechercher les suivis ayant des annotations avec des valeurs spécifiques, utilisez le mot clé annotation[key] dans une expression de filtre.

Enregistrer des métadonnées avec le X-Ray SDK for Go

Utilisez les métadonnées pour enregistrer des informations sur les segments qui n'ont pas besoin d'être indexés pour la recherche.

Pour enregistrer des métadonnées, appelez AddMetadata avec une chaîne contenant les métadonnées à associer au segment.

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

Utilisateur enregistrant IDs avec le X-Ray SDK for Go

Enregistrez les segments utilisateur IDs sur demande pour identifier l'utilisateur qui a envoyé la demande.

Pour enregistrer un utilisateur IDs

1. Obtenez une référence au segment en cours à partir d'AWSXRay.

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

2. Appelez setUser avec l'ID de type chaîne de l'utilisateur ayant envoyé la demande.

   mySegment.User = "U12345"

Pour rechercher les suivis d'un ID utilisateur, utilisez le mot clé user dans une expression de filtre.