Dashboard di monitoraggio e registrazione dei log di GraphQL (anteprima)

Ottenere visibilità completa sulle API GraphQL di produzione con le funzionalità di monitoraggio e registrazione integrate di Microsoft Fabric. Tenere traccia delle metriche delle prestazioni in tempo reale, analizzare i modelli di query, risolvere gli errori e comprendere il modo in cui i client interagiscono con le API, tutti dall'interno dell'area di lavoro Infrastruttura.

Principali funzionalità di monitoraggio:

• Dashboard in tempo reale: visualizzare le prestazioni dell'API, i tempi di risposta e le percentuali di errore con grafici interattivi
• Registrazione dettagliata delle richieste: acquisire i dati di richiesta/risposta completi, la complessità delle query e i dettagli di esecuzione
• Analisi delle prestazioni: identificare le query lente, ottimizzare i colli di bottiglia e tenere traccia delle tendenze di utilizzo nel tempo
• Rilevamento degli errori: monitorare gli errori, analizzare le cause radice e migliorare l'affidabilità dell'API

Questo dashboard di monitoraggio facile da comprendere consente di prendere decisioni basate sui dati sulle prestazioni e sui modelli di utilizzo dell'API. Sia che si verifichino problemi, ottimizzando le prestazioni dell'applicazione o garantendo un'esperienza utente uniforme, gli strumenti di monitoraggio forniscono informazioni preziose. È possibile identificare e risolvere rapidamente i problemi ottenendo una comprensione più approfondita del modo in cui vengono usate le API.

Utenti che usano il monitoraggio e la registrazione

Il monitoraggio e la registrazione di GraphQL sono essenziali per:

• Amministratori dell'area di lavoro Fabric che monitorano l'integrità dell'API, le prestazioni e il consumo di capacità in tempo reale
• Gli amministratori della capacità del tessuto monitorano i modelli di utilizzo e ottimizzano l'allocazione della capacità per i carichi di lavoro GraphQL
• I team di governance dei dati controllano l'accesso ai dati, rilevano anomalie e garantiscono la conformità ai criteri dei dati
• Ingegneri dei dati che analizzano i modelli di query e ottimizzano l'accesso al lakehouse e al warehouse di Fabric
• Team della piattaforma comprendendo l'adozione del Fabric API e prendendo decisioni basate sui dati nell'investimento nelle API.

Usare il monitoraggio e la registrazione quando è necessaria visibilità sul comportamento dell'API GraphQL di produzione, sulle metriche delle prestazioni e sull'analisi dell'utilizzo.

Prerequisiti

• È necessario abilitare il monitoraggio dell'area di lavoro e aggiungere una eventhouse per il monitoraggio. Per altre informazioni su come abilitarlo, vedere Panoramica sul monitoraggio dell'area di lavoro. Il monitoraggio dell'area di lavoro è disabilitato per impostazione predefinita.

  Nota

  Se è stato appena abilitato il monitoraggio dell'area di lavoro, potrebbe essere necessario aggiornare la pagina prima di procedere con la configurazione del monitoraggio graphQL.

• È necessario avere un'API distribuita per GraphQL in Fabric. Per altre informazioni su come distribuire, vedere Creare un'API per GraphQL in Fabric e aggiungere dati.

Abilitazione del monitoraggio dell'API GraphQL

Dopo aver abilitato il monitoraggio dell'area di lavoro in base ai prerequisiti, è necessario abilitare separatamente il monitoraggio per l'API GraphQL specifica. Il monitoraggio graphQL è disattivato per impostazione predefinita e deve essere abilitato per ogni API singolarmente. Ecco come abilitarlo:

1. Per abilitare le metriche e/o l'esperienza di registrazione per ogni API per GraphQL nel tenant, aprire l'API GraphQL e quindi selezionare l'icona Impostazioni :

   

2. Nella finestra Impostazioni API selezionare la pagina Monitoraggio (anteprima) dal menu a sinistra. Se il monitoraggio dell'area di lavoro non è già abilitato, viene visualizzata una nota che guida per passare alle impostazioni dell'area di lavoro per abilitarla.

3. Dopo aver abilitato il monitoraggio per l'area di lavoro, vengono visualizzate le opzioni per abilitare le metriche (visualizzare l'attività dell'API aggregata in un dashboard), la registrazione (visualizzare i log con informazioni dettagliate per ogni richiesta API) o entrambi.

   

   Nota

   Le metriche e i log vengono salvati in tabelle separate nello stesso database Kusto ed è possibile abilitare ogni funzionalità separatamente a seconda delle esigenze.

4. Abilitare le opzioni desiderate attivando o disattivando i commutatori uno alla volta alla posizione On .

Attività della richiesta API

Dopo aver abilitato il monitoraggio, selezionare il pulsante Api request activity (Attività richiesta API ) nella barra multifunzione superiore per accedere ai dettagli di monitoraggio.

Nella pagina Attività richiesta API è possibile selezionare una delle schede seguenti per visualizzare dati di monitoraggio specifici:

1. Dashboard API (per Metriche): questa pagina visualizza tutti i contatori e i grafici per l'intervallo di tempo specificato.
2. richieste API (per la registrazione): questa pagina elenca le richieste API entro l'intervallo di tempo specificato.

Nelle sezioni seguenti vengono descritte le funzionalità di ogni opzione.

Metriche API (dashboard)

Il dashboard dell'API offre una panoramica completa delle prestazioni dell'API GraphQL tramite grafici interattivi e metriche. Per accedere al dashboard, selezionare la scheda Dashboard API nella pagina dell'attività della richiesta API .

Il dashboard visualizza gli indicatori di prestazioni principali in intervalli di tempo personalizzabili, con tutti i dati conservati per 30 giorni. Passare il puntatore del mouse su qualsiasi grafico per visualizzare informazioni dettagliate per punti dati specifici.

Indicatori di salute

• Stato integrità API: indicatore visivo che mostra l'integrità complessiva dell'API in base alla frequenza di riuscita

  • Verde: 75-100% richieste riuscite (Normale)

  • Giallo: 50-74% richieste riuscite (richiede attenzione)

  • Rosso: sotto il 50% di richieste riuscite (non salutare)

    

• Percentuale di operazioni riuscite: percentuale di richieste riuscite rispetto alle richieste totali nell'intervallo di tempo selezionato

  

Metriche del volume di dati

• Richieste API al secondo: visualizzazione in tempo reale del volume delle richieste nel tempo

  

• Totale richieste API: conteggio aggregato di tutte le richieste nell'intervallo di tempo selezionato

  

• Grafico a barre di stato della richiesta: suddivisione visiva che mostra le richieste riuscite rispetto agli errori nel tempo

  

Metriche delle prestazioni

• Grafico a linee di latenza: tendenze del tempo di risposta che mostrano le prestazioni nel tempo

  

Opzioni di personalizzazione

• Selezione intervallo di tempo: scegliere tra diverse finestre temporali (ora, giorno, settimana, mese) per analizzare i dati. La conservazione dei dati è limitata a 30 giorni.

  

Dalla panoramica ai dettagli

La pagina dashboard API offre un'eccellente visualizzazione generale delle tendenze di integrità e prestazioni dell'API. Quando si individuano problemi come la riduzione delle percentuali di esito positivo, l'aumento della latenza o i modelli di richiesta insoliti, la pagina richieste APInella sezione successiva fornisce i log dettagliati necessari per l'analisi.

Mentre il dashboard mostra cosa accade con l'API, la pagina di registrazione mostra esattamente quali richieste causano problemi, completa di messaggi di errore, dettagli della risposta e tempi di esecuzione per singole query.

Registrazione (richieste API)

La pagina Richieste API acquisisce dettagli completi su ogni operazione GraphQL, consentendo analisi approfondite e risoluzione dei problemi. Accedere a questa visualizzazione dettagliata selezionando la scheda Richieste API dalla pagina dell'attività della richiesta API .

Questa registrazione a livello di richiesta integra le metriche di panoramica del dashboard fornendo i dati granulari necessari per diagnosticare problemi specifici, ottimizzare le query lente e comprendere i modelli di comportamento del client.

Informazioni sulla richiesta

Ogni richiesta registrata include:

• ID richiesta: identificatore univoco per il rilevamento di operazioni specifiche
• Tipo di operazione: classificazione tra query o mutation
• Protocollo di trasporto: metodo HTTP usato per la richiesta
• Timestamp: ora esatta della ricezione della richiesta
• Durata: tempo di esecuzione completo dalla richiesta alla risposta
• Dimensioni risposta: dimensioni del payload dei dati restituite al client
• Stato: indicatore di esito positivo o negativo con informazioni dettagliate sull'errore

Strumenti di esplorazione dei dati

• Filtro intervallo di tempo: selezionare da visualizzazioni ora, giorno, settimana o mese (limite di conservazione di 30 giorni)

  

• Ordinamento avanzato: ordinare in base al timestamp o alla durata in ordine crescente/decrescente

• Ricerca e filtro: trovare richieste specifiche usando la ricerca di testo in tutti i dettagli della richiesta

• Gestione colonne: ridimensionare e riordinare le colonne per personalizzare la vista tabella

• Ispezione dettagliata: fare clic su qualsiasi richiesta per visualizzare i dati di richiesta/risposta completi, inclusi i messaggi di errore e gli avvisi

Risoluzione dei problemi relativi ai flussi di lavoro

Usare la pagina di registrazione per:

• Identificare le query con errori: filtrare in base allo stato per trovare gli errori e analizzare le cause radice
• Analizzare i colli di bottiglia delle prestazioni: ordina per durata per individuare le operazioni che vengono eseguite più lentamente
• Tenere traccia dei modelli di utilizzo: esaminare i tipi di operazione e la tempistica per comprendere il comportamento del client
• Eseguire il debug di problemi specifici: cercare determinati messaggi di errore o ID richiesta segnalati dagli utenti

Contenuto correlato

• API di Microsoft Fabric per GraphQL
• Panoramica del monitoraggio dell'area di lavoro
• API per GraphQL in Fabric
• API fabric per l'editor GraphQL
• Fabric API per la visualizzazione dello schema GraphQL e l'Esploratore