AWS X-Ray segmentare i documenti

Campi del segmento obbligatori

• name— Il nome logico del servizio che ha gestito la richiesta, fino a 200 caratteri. Ad esempio, il nome dell'applicazione o il nome di dominio. I nomi possono contenere lettere in formato Unicode, numeri e spazi e i seguenti simboli: _, ., :, /, %, &, #, =, +, \, -, @

• id— Un identificatore a 64 bit per il segmento, unico tra i segmenti della stessa traccia, in 16 cifre esadecimali.

• trace_id— Un identificatore univoco che collega tutti i segmenti e i sottosegmenti provenienti da una singola richiesta del client.

  Formato ID di traccia X-Ray

  Una radiografia trace_id è composta da tre numeri separati da trattini. Ad esempio, 1-58406520-a006649127e371903a2de979. Questo include:

  • Il numero di versione, che è. 1

  • L'ora della richiesta originale in Unix epoch time utilizzando 8 cifre esadecimali.

    Ad esempio, il fuso orario PST delle 10:00 del 1° dicembre 2016 è espresso in secondi o in cifre esadecimali. 1480615200 58406520

  • Un identificatore a 96 bit univoco a livello globale per la traccia in 24 cifre esadecimali.

  Nota

  X-Ray ora supporta gli ID di traccia creati utilizzando OpenTelemetry e qualsiasi altro framework conforme alla specifica W3C Trace Context. Un ID di traccia W3C deve essere formattato nel formato X-Ray Trace ID quando viene inviato a X-Ray. Ad esempio, l'ID di traccia W3C 4efaaf4d1e8720b39541901950019ee5 deve essere formattato come 1-4efaaf4d-1e8720b39541901950019ee5 quando si invia a X-Ray. Gli ID di traccia X-Ray includono il timestamp originale della richiesta in Unix epoch time, ma questo non è necessario quando si inviano gli ID di traccia W3C in formato X-Ray.

  Sicurezza dell'ID di tracciamento

  Gli ID di tracciamento sono visibili nelle intestazioni di risposta. Genera gli ID di tracciamento con un algoritmo di generazione dei numeri casuali sicuro per assicurare che gli aggressori non siano in grado di calcolare futuri ID di tracciamento e di inviare le richieste con tali ID verso la tua applicazione.

• start_time— numero che indica l'ora in cui il segmento è stato creato, in secondi a virgola mobile nell'ora dell'epoca. Ad esempio 1480615200.010 o 1.480615200010E9. Utilizza il numero di cifre decimali di cui hai bisogno. Quando disponibile, è consigliata la risoluzione al microsecondo.

• end_time— numero che indica l'ora in cui il segmento è stato chiuso. Ad esempio 1480615200.090 o 1.480615200090E9. Specifica un end_time oppure il valore in_progress.

• in_progress— booleano, impostato su true invece di specificare an end_time per registrare che un segmento è iniziato, ma non è completo. Invia la segnalazione di un segmento in elaborazione per memorizzare la richiesta ricevuta quando l'applicazione riceve una richiesta la cui esecuzione richiede molto tempo. Quando viene inviata la risposta, invia il completamento del segmento per sovrascrivere il segmento in elaborazione. Per ogni richiesta, invia un solo segmento completo e uno o nessun segmento in esecuzione.

Campi del segmento facoltativi

• service— Un oggetto con informazioni sull'applicazione.

  • version— Una stringa che identifica la versione dell'applicazione che ha fornito la richiesta.

• user— Una stringa che identifica l'utente che ha inviato la richiesta.

• origin— Il tipo di AWS risorsa che esegue l'applicazione.

  Valori supportati

  • AWS::EC2::Instance— Un'istanza Amazon EC2.

  • AWS::ECS::Container— Un contenitore Amazon ECS.

  • AWS::ElasticBeanstalk::Environment— Un ambiente Elastic Beanstalk.

  Quando, per la tua applicazione, sono validi più valori, utilizza quello più specifico. Ad esempio, un ambiente Docker Elastic Beanstalk Multicontainer esegue l'applicazione su un contenitore Amazon ECS, che a sua volta viene eseguito su un'istanza Amazon EC2. In questo caso, è possibile impostare l'origine a AWS::ElasticBeanstalk::Environment poiché l'ambiente è il padre delle altre due risorse.

• parent_id— Un ID di sottosegmento che specifichi se la richiesta proviene da un'applicazione strumentata. L'X-Ray SDK aggiunge l'ID del sottosegmento principale all'intestazione di tracciamento per le chiamate HTTP downstream. Nel caso di sottosegmenti nidificati, un sottosegmento può avere come padre un segmento o un sottosegmento.

• http— httpoggetti con informazioni sulla richiesta HTTP originale.

• aws— awsoggetto con informazioni sulla AWS risorsa su cui l'applicazione ha fornito la richiesta.

• error, throttlefault, e cause — campi di errore che indicano che si è verificato un errore e che includono informazioni sull'eccezione che ha causato l'errore.

• annotations— annotationsoggetto con coppie chiave-valore che si desidera che X-Ray indicizzi per la ricerca.

• metadata— metadataoggetto con eventuali dati aggiuntivi che si desidera memorizzare nel segmento.

• subsegments— matrice di subsegmentoggetti.

Campi del sottosegmento obbligatori

• id— Un identificatore a 64 bit per il sottosegmento, unico tra i segmenti della stessa traccia, in 16 cifre esadecimali.

• name— Il nome logico del sottosegmento. Nel caso di chiamate a valle, denominare il sottosegmento in base alla risorsa o al servizio chiamati. Nel caso di sottosegmenti personalizzati, denominare il sottosegmento in base al codice che viene analizzato (ad esempio utilizzando un nome di funzione).

• start_time— numero che indica l'ora in cui è stato creato il sottosegmento, in secondi a virgola mobile in base all'ora dell'epoca, preciso in millisecondi. Ad esempio 1480615200.010 o 1.480615200010E9.

• end_time— numero che indica l'ora in cui il sottosegmento è stato chiuso. Ad esempio 1480615200.090 o 1.480615200090E9. Specificare un end_time o il valore in_progress.

• in_progress— valore booleano impostato su true anziché specificare an per end_time registrare che un sottosegmento è iniziato, ma non è completo. Per ogni richiesta a valle, invia un solo sottosegmento completo e uno o nessun sottosegmento in lavorazione.

• trace_id— ID di traccia del segmento principale del sottosegmento. Obbligatorio solo nel caso in cui si invii un sottosegmento in modo separato.

  Formato ID di traccia X-Ray

  Una radiografia trace_id è composta da tre numeri separati da trattini. Ad esempio, 1-58406520-a006649127e371903a2de979. Questo include:

  • Il numero di versione, che è. 1

  • L'ora della richiesta originale in Unix epoch time utilizzando 8 cifre esadecimali.

    Ad esempio, il fuso orario PST delle 10:00 del 1° dicembre 2016 è espresso in secondi o in cifre esadecimali. 1480615200 58406520

  • Un identificatore a 96 bit univoco a livello globale per la traccia in 24 cifre esadecimali.

  Nota

  X-Ray ora supporta gli ID di traccia creati utilizzando OpenTelemetry e qualsiasi altro framework conforme alla specifica W3C Trace Context. Un ID di traccia W3C deve essere formattato nel formato X-Ray Trace ID quando viene inviato a X-Ray. Ad esempio, l'ID di traccia W3C 4efaaf4d1e8720b39541901950019ee5 deve essere formattato come 1-4efaaf4d-1e8720b39541901950019ee5 quando si invia a X-Ray. Gli ID di traccia X-Ray includono il timestamp originale della richiesta in Unix epoch time, ma questo non è necessario quando si inviano gli ID di traccia W3C in formato X-Ray.

• parent_id— ID del segmento principale del sottosegmento. Obbligatorio solo nel caso in cui si invii un sottosegmento in modo separato. Nel caso di sottosegmenti nidificati, un sottosegmento può avere come padre un segmento o un sottosegmento.

• type—subsegment. Richiesto solo se si invia un sottosegmento separatamente.

Campi del sottosegmento facoltativi

• namespace— aws per le chiamate SDK AWS; remote per altre chiamate downstream.

• http— httpoggetto con informazioni su una chiamata HTTP in uscita.

• aws— awsoggetto con informazioni sulla AWS risorsa downstream chiamata dall'applicazione.

• error, throttlefault, e cause — campi di errore che indicano che si è verificato un errore e che includono informazioni sull'eccezione che ha causato l'errore.

• annotations— annotationsoggetto con coppie chiave-valore che si desidera che X-Ray indicizzi per la ricerca.

• metadata— metadataoggetto con eventuali dati aggiuntivi che si desidera memorizzare nel segmento.

• subsegments— matrice di subsegmentoggetti.

• precursor_ids— matrice di ID di sottosegmento che identifica i sottosegmenti con lo stesso elemento principale completati prima di questo sottosegmento.

http

Tutti i campi sono facoltativi.

• request— Informazioni su una richiesta.

  • method— Il metodo di richiesta. Ad esempio, GET.

  • url— L'URL completo della richiesta, compilato a partire dal protocollo, dal nome host e dal percorso della richiesta.

  • user_agent— La stringa dell'agente utente proveniente dal client del richiedente.

  • client_ip— L'indirizzo IP del richiedente. Può essere recuperato dal campo Source Address del pacchetto IP o, in caso di richieste inoltrate, da un'intestazione X-Forwarded-For.

  • x_forwarded_for— (solo segmenti) booleano che indica che client_ip è stato letto da un'X-Forwarded-Forintestazione e non è affidabile in quanto avrebbe potuto essere falsificato.

  • traced— (solo sottosegmenti) booleano che indica che la chiamata a valle è verso un altro servizio tracciato. Se questo campo è impostato sutrue, X-Ray considera la traccia interrotta fino a quando il servizio downstream non carica un segmento con a parent_id che corrisponde al sottosegmento che id contiene questo blocco.

• response— Informazioni su una risposta.

  • status— numero intero che indica lo stato HTTP della risposta.

  • content_length— numero intero che indica la lunghezza del corpo della risposta in byte.

aws (Segmenti)

Tutti i campi sono facoltativi.

• account_id— Se l'applicazione invia segmenti a un altro, registra l'ID dell'account su cui è in esecuzione l'applicazione. Account AWS

• cloudwatch_logs— Matrice di oggetti che descrivono un singolo gruppo di CloudWatch log.

  • log_group— Il nome del gruppo di CloudWatch log.

  • arn— L' CloudWatch ARN del gruppo Log.

• ec2— Informazioni su un'istanza Amazon EC2.

  • instance_id— L'ID dell'istanza EC2.

  • instance_size— Il tipo di istanza EC2.

  • ami_id— L'Amazon Machine Image ID.

  • availability_zone— La zona di disponibilità in cui è in esecuzione l'istanza.

• ecs— Informazioni su un container Amazon ECS.

  • container— Il nome host del contenitore.

  • container_id— L'ID completo del contenitore.

  • container_arn— L'ARN dell'istanza del contenitore.

• eks— Informazioni su un cluster Amazon EKS.

  • pod— Il nome host del tuo pod EKS.

  • cluster_name— Il nome del cluster EKS.

  • container_id— L'ID completo del contenitore.

• elastic_beanstalk— Informazioni su un ambiente Elastic Beanstalk. Puoi trovare queste informazioni in un file denominato /var/elasticbeanstalk/xray/environment.conf sulle più recenti piattaforme Elastic Beanstalk.

  • environment_name: il nome dell'ambiente.

  • version_label— Il nome della versione dell'applicazione attualmente distribuita sull'istanza che ha fornito la richiesta.

  • deployment_id— numero che indica l'ID dell'ultima distribuzione riuscita nell'istanza che ha fornito la richiesta.

• xray— Metadati relativi al tipo e alla versione della strumentazione utilizzata.

  • auto_instrumentation— Booleano che indica se è stata utilizzata la strumentazione automatica (ad esempio, l'agente Java).

  • sdk_version— La versione dell'SDK o dell'agente in uso.

  • sdk— Il tipo di SDK.

aws (Sottosegmenti)

Tutti i campi sono facoltativi.

• operation— Il nome dell'azione API richiamata contro una risorsa or. Servizio AWS

• account_id— Se l'applicazione accede alle risorse di un account diverso o invia segmenti a un account diverso, registra l'ID dell'account proprietario della AWS risorsa a cui l'applicazione ha avuto accesso.

• region— Se la risorsa si trova in una regione diversa dall'applicazione, registra la regione. Ad esempio, us-west-2.

• request_id— Identificatore univoco per la richiesta.

• queue_url— Per le operazioni su una coda Amazon SQS, l'URL della coda.

• table_name— Per le operazioni su una tabella DynamoDB, il nome della tabella.

tipi di errore

Imposta uno o più dei seguenti campi a true per indicare che si è verificato un errore. In caso di errori composti è possibile associare molteplici tipi. Ad esempio, un errore 429 Too Many Requests da una chiamata a valle può far sì che la tua applicazione ritorni un errore 500 Internal Server Error, nel qual caso possono essere associati tutti e tre i tipi di errore.

• error— booleano che indica che si è verificato un errore del client (il codice di stato della risposta era 4XX Client Error).

• throttle— booleano che indica che una richiesta è stata limitata (il codice di stato della risposta era 429 Too Many Requests).

• fault— booleano che indica che si è verificato un errore del server (il codice di stato della risposta era 5XX Server Error).

cause

A causa può essere un ID di eccezione lungo 16 caratteri o un oggetto con i campi riportati qui di seguito:

• working_directory— Il percorso completo della directory di lavoro quando si è verificata l'eccezione.

• paths— L'array di percorsi alle librerie o ai moduli in uso quando si è verificata l'eccezione.

• exceptions— La matrice di oggetti di eccezione.

exception

Tutti i campi sono facoltativi.

• id— Un identificatore a 64 bit per l'eccezione, unico tra i segmenti della stessa traccia, in 16 cifre esadecimali.

• message— Il messaggio di eccezione.

• type— Il tipo di eccezione.

• remote— booleano che indica che l'eccezione è stata causata da un errore restituito da un servizio a valle.

• truncated— numero intero che indica il numero di stack frame omessi da. stack

• skipped— numero intero che indica il numero di eccezioni che sono state saltate tra questa eccezione e la relativa eccezione figlia, ovvero l'eccezione che ha causato.

• cause— ID dell'eccezione principale dell'eccezione, ovvero l'eccezione che ha causato l'eccezione.

• stack— matrice di oggetti StackFrame.

stackFrame

Tutti i campi sono facoltativi.

• path— Il percorso relativo al file.

• line— La riga del file.

• label— Il nome della funzione o del metodo.

sql

Tutti i campi sono facoltativi.

• connection_string— Per SQL Server o altre connessioni al database che non utilizzano stringhe di connessione URL, registrare la stringa di connessione, escluse le password.

• url— Per una connessione al database che utilizza una stringa di connessione URL, registrare l'URL, escluse le password.

• sanitized_query— L'interrogazione del database, con tutti i valori forniti dall'utente rimossi o sostituiti da un segnaposto.

• database_type— Il nome del motore del database.

• database_version— Il numero di versione del motore di database.

• driver_version— Il nome e il numero di versione del driver del motore di database utilizzato dall'applicazione.

• user— Il nome utente del database.

• preparation— call se la query utilizzava unPreparedCall; statement se l'interrogazione utilizzava unPreparedStatement.