Aggiungi annotazioni e metadati ai segmenti con X-Ray SDK for Go

Puoi utilizzare annotazioni e metadati per registrare informazioni aggiuntive sulle richieste, sull'ambiente o sull'applicazione. È possibile aggiungere annotazioni e metadati ai segmenti creati da X-Ray SDK o ai sottosegmenti personalizzati creati dall'utente.

Le annotazioni sono coppie chiave-valore con stringhe, numeri o valori booleani. Le annotazioni sono indicizzate per essere utilizzate con le espressioni di filtro. Utilizzale per registrare i dati che desideri utilizzare per raggruppare le tracce nella console oppure per chiamare l'API GetTraceSummaries.

I metadati sono coppie chiave-valore che possono avere valori di qualsiasi tipo, inclusi oggetti ed elenchi, ma non sono indicizzati per essere utilizzati con le espressioni di filtro. Utilizzate i metadati per registrare dati aggiuntivi che desiderate archiviare nella traccia ma che non è necessario utilizzare con la ricerca.

Oltre ad annotazioni e metadati, sui segmenti puoi anche registrare le stringhe degli ID utente. Gli ID utente vengono memorizzati in un campo separato su segmenti e sono indicizzati per l'uso nelle ricerche.

Registrazione delle annotazioni con X-Ray SDK for Go

Utilizza le annotazioni per memorizzare le informazioni sui segmenti che desideri siano indicizzate per la ricerca.

Requisiti per le annotazioni

• Chiavi: la chiave per un'annotazione a raggi X può contenere fino a 500 caratteri alfanumerici. Non è possibile utilizzare spazi o simboli diversi dal simbolo di sottolineatura (_).

• Valori: il valore di un'annotazione X-Ray può contenere fino a 1.000 caratteri Unicode.

• Il numero di annotazioni: è possibile utilizzare fino a 50 annotazioni per traccia.

Per registrare le annotazioni, invoca AddAnnotation con una stringa che contiene i metadati che desideri associare al segmento.

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

L'SDK memorizza le annotazioni come coppie chiave-valore in un oggetto annotations all'interno del documento di segmento. Chiamando AddAnnotation due volte con la stessa chiave, il valore precedentemente memorizzato nello stesso segmento viene sovrascritto.

Per trovare tracciamenti con annotazioni contenenti valori specifici, utilizza la parola chiave annotations.key in un'espressione filtro.

Registrazione di metadati con X-Ray SDK for Go

Utilizza i metadati per memorizzare le informazioni su segmenti che non è necessario che siano indicizzate per la ricerca.

Per registrare i metadati, invoca AddMetadata con una stringa che contiene i metadati che desideri associare al segmento.

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

Registrazione degli ID utente con X-Ray SDK for Go

Memorizza gli ID utente sui segmenti di richiesta per identificare l'utente che ha inviato la richiesta.

Per registrare gli ID degli utenti

1. Ottenere un riferimento al segmento corrente da AWSXRay.

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

2. Chiamare setUser con una stringa che rappresenta l'ID dell'utente che ha inviato la richiesta.

   mySegment.User = "U12345"

Per trovare tracciamenti associati ad un ID utente, utilizza la parola chiave user in un'espressione filtro.