I due principali strumenti a tua disposizione in Experience per lo stato e il monitoraggio del sistema sono registri API e avvisi di sistema.
Log delle API in Experience
Questi log offrono una panoramica approfondita delle chiamate API lato server, tra cui eventi, visualizzazioni di pagina, clic e chiamate con varianti a scelta. Ti consentono di verificare che le chiamate API siano corrette e riescano a identificare i problemi di implementazione. Puoi anche usare i log per risolvere i problemi relativi a comportamenti imprevisti e trovarne la causa principale.
Per accedere ai registri API, vai alla sezione Impostazioni › Registri API.
Dettagli dei registri API
La cronologia aggrega le chiamate API in riuscite, con errori e con avvisi. Passa il mouse su una delle barre per avere maggiori dettagli.
Sotto la timeline una tabella elenca le chiamate API recenti che si sono verificate nell'intervallo di tempo selezionato. Premi Carica di più per vedere altre chiamate API.
Sono disponibili i seguenti campi. Per visualizzare altri campi, clicca sulle Colonne nella parte superiore della pagina dei registri API.
|
Colonna |
Dettagli |
|---|---|
|
Endpoint |
Il tipo di chiamate API, ad esempio "choose" o "pageview" |
|
Dettagli |
Dettagli sul tipo di richiesta, come il tipo di evento della richiesta |
|
ID richiesta |
Un identificatore univoco per ogni chiamata API |
|
Stato |
Visualizza il codice di stato. 200 o 204 significa che tutto era ok. Gli altri codici sono descritti accanto al numero indicato. |
|
ID utente |
L'ID utente fornito nella richiesta API |
|
ID sessione |
L'ID sessione fornito nella richiesta API |
|
Timestamp |
Granularità visualizzata in secondi |
|
Durata della richiesta |
Il tempo impiegato dalla richiesta sui server di Dynamic Yield (escluso il tempo trascorso in transito) |
Puoi approfondire qualsiasi chiamata API per visualizzare maggiori dettagli cliccando in un punto qualsiasi della riga. Questa risposta è disponibile solo per i log inferiori a 32 KB. Se la risposta dovesse superare questo limite, non verrà visualizzata nel log (non significa che ci sia stato un errore nella risposta o che non sia stata consegnata correttamente).
Selezionare un intervallo di tempo
Puoi specificare l'intervallo di tempo utilizzando il selettore di data:
Puoi anche ampliare un intervallo di tempo specifico cliccando e trascinando la casella oltre la data desiderata.
Apparirà un banner che indica l'intervallo di tempo impostato. Puoi annullare lo zoom cliccando su X.
Filtrare il registro
Clicca sui filtri a destra per filtrare le chiamate API per data, durata, tipo, stato o errori. Visualizzerai il numero di chiamate per filtro accanto a ciascuna opzione.
Selezioni multiple con lo stesso tipo di filtro (ad esempio "Chooose" e "Pageview" per "Type") sono considerate come «OR»; mentre le selezioni multiple con filtri di diverso tipo (ad esempio, "Pageview" in "Type" e "Error" in "Status") sono considerati «AND».
Puoi anche applicare filtri attraverso lo strumento di ricerca per specificare un userID o un requestID.
Casi d'uso
|
Casi d'uso |
Risoluzione |
|---|---|
|
Durante l'implementazione iniziale sto effettuando chiamate API per controllare che tutti gli attributi siano stati ricevuti con i valori previsti (tipo di contesto, ecc.) e non ci sia nessun avviso. |
Apri il registro API e monitora le chiamate in arrivo, usando il tasto "Aggiorna" per visualizzare le ultime chiamate. |
|
Durante l'implementazione, ho notato che ci sono stati alcuni avvisi sulle chiamate API. |
Seleziona la riga nel registro API per visualizzare maggiori dettagli. Puoi vedere gli avvisi completi, tra cui, ad esempio, eventuali specifiche SKU mancanti. |
|
In produzione (o in qualsiasi altro ambiente ad alto volume), sospetto che ci siano alcune chiamate API problematiche, ma non ho la certezza di quando stia accadendo. |
Puoi aumentare un intervallo di tempo specifico con un volume elevato di errori o avvisi. Puoi anche utilizzare i filtri per visualizzare solo chiamate API che contengano gli errori o gli avvisi che stai cercando. |
|
In una piattaforma ad alto volume, voglio vedere cosa sta facendo un utente. |
Inserisci il suo ID utente nella barra di ricerca per filtrare il registro. |
|
Qualcuno vuole segnalarmi un problema condividendo un segnalibro o un riferimento al problema. |
Si può ottenere inserendo l'ID utente nella barra di ricerca. Se non disponi dell'ID utente, inserisci l'ID della richiesta e usalo per cercare l'ID utente nei risultati filtrati. |
|
So che al momento ci sono errori/avvisi e voglio sapere "quando si è interrotto", così posso (a) capire la portata del problema, (b) correlarlo a tutte le modifiche che ho apportato. |
Puoi ampliare un intervallo di tempo sospetto, quindi, usare i filtri per restringere i risultati a un tipo di errore o avviso specifico. |
|
Ho applicato una correzione ad alcuni errori/avvisi e voglio vedere se ci sono altre richieste con questo tipo di problema. |
Usa il controllo dell'intervallo di tempo e/o i filtri per vedere se/quando un problema si è risolto e se è stato eliminato completamente o parzialmente. |
Avvisi
Gli avvisi forniscono un'idea sullo stato dell'implementazione dell'API, permettendoti di comunicare facilmente i problemi di implementazione in corso con i tuoi reparti IT/R&D e accelerare la risoluzione dei problemi connessi.
Come funziona
- Gli errori e gli avvisi API che si verificano frequentemente vengono mostrati come avviso sulla dashboard amministratore.
- Clicca su Visualizza il riepilogo del problema per aprire un popup che fornisce informazioni sul problema, inclusi tipo, causa e frequenza. Oppure, clicca su Visualizza i log per andare direttamente alla schermata dei registri API.
- Da qui, potrai visualizzare i log degli errori o copiarli negli appunti per condividerli con i reparti IT/R&D.
- È probabile che il numero di avvisi API sia significativamente superiore ai conteggi nel log. Questo perché un singolo registro degli errori API può presentare più problemi, attivando così più avvisi.
- Affinché un avviso venga visualizzato nella dashboard amministratore, si dovrà verificare almeno 50 volte. Questo per garantire che solo errori davvero significativi siano rappresentati in un avviso.
- I log degli errori vengono salvati per 7 giorni. Se dovessi tentare di visualizzare log degli errori più vecchi di 7 giorni, la schermata dei registri API non mostrerà alcun risultato.