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

È possibile registrare informazioni aggiuntive sulle richieste, sull'ambiente o sull'applicazione con annotazioni e metadati. È possibile aggiungere annotazioni e metadati ai segmenti creati da X-Ray o ai sottosegmenti personalizzati SDK 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. Utilizza le annotazioni per registrare i dati che desideri utilizzare per raggruppare le tracce nella console o quando chiami il. GetTraceSummariesAPI

I metadati sono coppie chiave-valore che possono avere valori di qualsiasi tipo, inclusi oggetti ed elenchi, ma non sono indicizzati per l'uso 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. IDsGli utenti vengono registrati in un campo separato sui segmenti e indicizzati per essere utilizzati nella ricerca.

Registrazione di annotazioni con SDK X-Ray for Ruby

Utilizza le annotazioni per memorizzare le informazioni su segmenti o sottosegmenti 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 da un punto o un punto (.)

• 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

1. Ottenere un riferimento al segmento o sottosegmento corrente da xray_recorder.

   require 'aws-xray-sdk'
   ...
   document = XRay.recorder.current_segment

   oppure

   require 'aws-xray-sdk'
   ...
   document = XRay.recorder.current_subsegment

2. Chiama update con un valore hash.

   my_annotations = { id: 12345 }
   document.annotations.update my_annotations

   Di seguito è riportato un esempio che mostra come effettuare una chiamata update con una chiave di annotazione che contiene un punto.

   my_annotations = { testkey.test: 12345 }
   document.annotations.update my_annotations

SDKRegistra le annotazioni come coppie chiave-valore in un annotations oggetto nel documento del segmento. Se chiami add_annotations due volte con la stessa chiave, il valore precedentemente memorizzato nello stesso segmento o sottosegmento viene sovrascritto.

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

Registrazione di metadati con SDK X-Ray for Ruby

Utilizza i metadati per memorizzare le informazioni su segmenti o sottosegmenti che non è necessario che siano indicizzate per la ricerca. I valori dei metadati possono essere stringhe, numeri, valori booleani o qualsiasi oggetto che può essere serializzato in un oggetto o in un array. JSON

Per registrare i metadati

1. Ottenere un riferimento al segmento o sottosegmento corrente da xray_recorder.

   require 'aws-xray-sdk'
   ...
   document = XRay.recorder.current_segment

   oppure

   require 'aws-xray-sdk'
   ...
   document = XRay.recorder.current_subsegment

2. Chiama metadata con una chiave di tipo Stringa, un valore booleano, numerico, di tipo Stringa o di tipo oggetto e un namespace di tipo stringa.

   my_metadata = {
     my_namespace: {
       key: 'value'
     }
   }
   subsegment.metadata my_metadata

Se chiami metadata due volte con la stessa chiave, il valore precedentemente memorizzato nello stesso segmento o sottosegmento viene sovrascritto.

Utente che sta registrando IDs con X-Ray for Ruby SDK

Registra i segmenti dell'utente IDs su richiesta per identificare l'utente che ha inviato la richiesta.

Per registrare l'utente IDs

1. Ottenere un riferimento al segmento corrente da xray_recorder.

   require 'aws-xray-sdk'
   ...
   document = XRay.recorder.current_segment

2. Imposta il campo utente sul segmento a un ID di tipo stringa dell'utente che ha inviato la richiesta.

   segment.user = 'U12345'

Puoi impostare l'utente nei tuoi controller per registrare l'ID utente non appena l'applicazione inizia ad elaborare una richiesta.

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