Informazioni sul monitoraggio delle prestazioni in Firestore

Cloud Monitoring raccoglie metriche, eventi e metadati dai prodotti Google Cloud . I dati riportati nella dashboard Utilizzo e nell'utilizzo delle regole di sicurezza sono accessibili anche tramite Cloud Monitoring per un'analisi più dettagliata. Con Cloud Monitoring puoi anche configurare dashboard personalizzate e avvisi di utilizzo.

Questo documento ti guida nell'utilizzo delle metriche, nell'apprendimento della dashboard delle metriche personalizzate e nell'impostazione degli avvisi.

Risorse monitorate

Una risorsa monitorata in Cloud Monitoring rappresenta un'entità logica o fisica, come una macchina virtuale, un database o un'applicazione. Le risorse monitorate contengono un insieme unico di metriche che possono essere esplorate, riportate tramite una dashboard o utilizzate per creare avvisi. Ogni risorsa ha anche un insieme di etichette delle risorse, ovvero coppie chiave-valore che contengono informazioni aggiuntive sulla risorsa. Le etichette delle risorse sono disponibili per tutte le metriche associate alla risorsa.

Utilizzando l'API Cloud Monitoring, le prestazioni di Firestore vengono monitorate con le seguenti risorse:

Risorse Descrizione Modalità di database supportata
firestore.googleapis.com/Database (consigliata) Tipo di risorsa monitorata che fornisce suddivisioni per project, location* e database_id . L'etichetta database_id sarà (default) per i database creati senza un nome specifico. Si applica a entrambe le modalità.
firestore_instance Tipo di risorsa monitorata per i progetti Firestore e non fornisce la suddivisione per database. Si applica a Firestore Native
datastore_request Tipo di risorsa monitorata per progetti Datastore e non fornisce la suddivisione per database. Si applica a entrambe le modalità.

Metriche

Firestore è disponibile in due modalità diverse: Firestore Native e Firestore in modalità Datastore. Per un confronto delle funzionalità tra queste due modalità, vedi Scegliere tra le modalità del database.

Per un elenco completo delle metriche per entrambe le modalità, consulta i seguenti link:

Metriche di runtime del servizio

Le metriche serviceruntime forniscono una panoramica generale del traffico di un progetto. Queste metriche sono disponibili per la maggior parte delle API Google Cloud . Il tipo di risorsa monitorata consumed_api contiene queste metriche comuni. Queste metriche vengono campionate ogni 30 minuti, il che comporta un livellamento dei dati.

Un'etichetta risorsa importante per le metriche serviceruntime è method. Questa etichetta rappresenta il metodo RPC sottostante chiamato. Il metodo SDK che chiami potrebbe non avere necessariamente lo stesso nome del metodo RPC sottostante. Il motivo è che l'SDK fornisce un'astrazione dell'API di alto livello. Tuttavia, quando cerchi di capire come interagisce la tua applicazione con Firestore, è importante comprendere le metriche in base al nome del metodo RPC.

Se hai bisogno di sapere qual è il metodo RPC sottostante per un determinato metodo SDK, consulta la documentazione dell'API.

Utilizza le seguenti metriche di runtime del servizio per monitorare il database.

api/request_count

Questa metrica fornisce il conteggio delle richieste completate, in base al protocollo(protocollo di richiesta, ad esempio HTTP, gRPC e così via), al codice di risposta (codice di risposta HTTP), a response_code_class (classe del codice di risposta, ad esempio 2xx, 4xx e così via) e a grpc_status_code (codice di risposta gRPC numerico). Utilizza questa metrica per osservare la richiesta API complessiva e calcolare il tasso di errore.

api/request_count che restituisce un codice 2xx.
Figura 1. Metrica api/request_count (fai clic per ingrandire).

Nella figura 1 sono visibili le richieste che restituiscono un codice 2xx raggruppate per servizio e metodo. I codici 2xx sono codici di stato HTTP che indicano che la richiesta è andata a buon fine.

api/request_count che restituisce un codice 2xx.
Figura 2.Metrica api/request_count che restituisce un codice 2xx (fai clic per ingrandire).

Nella figura 2, sono visibili i commit raggruppati per response_code. In questo esempio, vediamo solo risposte HTTP 200, il che implica che il database è integro.

api/request_latencies

La metrica api/request_latencies fornisce le distribuzioni della latenza per tutte le richieste completate.

Firestore registra le metriche del componente Firestore Service. Le metriche di latenza includono il tempo che intercorre tra il momento in cui Firestore riceve la richiesta e il momento in cui termina l'invio della risposta, incluse le interazioni con il livello di archiviazione. Per questo motivo, la latenza di andata e ritorno (rtt) tra il client e il servizio Firestore non è inclusa in queste metriche.

api/request_latencies per calcolare la distribuzione della latenza
Figura 4. api/request_latencies per calcolare la distribuzione della latenza.
api/request_sizes e api/response_sizes

Le metriche api/request_sizes e api/response_sizes forniscono rispettivamente informazioni sulle dimensioni del payload (in byte). Questi possono essere utili per comprendere i carichi di lavoro di scrittura che inviano grandi quantità di dati o le query troppo ampie e restituiscono payload di grandi dimensioni.

Metriche api/request_sizes e api/response_sizes
Figura 5. Metriche api/request_sizes e api/response_sizes (fai clic per ingrandire).

Nella figura 5 è visibile una mappa termica delle dimensioni delle risposte per il metodo RunQuery. Possiamo vedere che le dimensioni sono stabili, con una mediana di 50 byte e un intervallo complessivo compreso tra 10 byte e 100 byte. Tieni presente che le dimensioni del payload sono sempre misurate in byte non compressi, esclusi gli overhead di controllo della trasmissione.

Metriche delle operazioni sui documenti

Firestore fornisce i conteggi di lettura, scrittura ed eliminazione. La metrica di scrittura fornisce una suddivisione tra le operazioni "CREATE" e "UPDATE". Queste metriche sono allineate alle operazioni CRUD.

Le seguenti metriche possono essere utilizzate per capire se il tuo database è orientato alla lettura o alla scrittura e il tasso di nuovi documenti rispetto a quelli eliminati.

  • document/delete_ops_count: Il numero di eliminazioni di documenti riuscite.
  • document/read_ops_count: Il numero di letture di documenti riuscite da query o ricerche.
  • document/write_ops_count: Il numero di scritture di documenti riuscite.
Creare un rapporto tra documenti letti e documenti scritti
Figura 6. Crea un rapporto tra documenti letti e documenti scritti (fai clic per ingrandire).

Nella figura 6 puoi vedere come creare un rapporto che mostri il rapporto tra i documenti letti e quelli scritti. In questo esempio, il numero di documenti letti è circa il 6% in più rispetto al numero di documenti scritti.

Metriche delle operazioni sui documenti

Queste metriche forniscono distribuzioni in byte delle dimensioni del payload per le letture (ricerche e query) e le scritture in un database Firestore. I valori rappresentano la dimensione totale del payload. Ad esempio, tutti i risultati restituiti da una query. Queste metriche sono simili a quelle api/request_sizes e api/response_sizes, ma la differenza principale è che le metriche delle operazioni sui documenti forniscono un campionamento più granulare, ma suddivisioni meno granulari.

Ad esempio, le metriche delle operazioni sui documenti utilizzano la risorsa monitorata datastore_request, quindi non è presente una suddivisione per servizio o metodo.

  • entity/read_sizes: Distribuzione delle dimensioni dei documenti letti.
  • entity/write_sizes: Distribuzione delle dimensioni dei documenti scritti.

Metriche dell'indice

I tassi di scrittura dell'indice possono essere confrontati con la metrica document/write_ops_count per comprendere il rapporto di fanout dell'indice.

  • index/write_count: Conteggio delle scritture dell'indice.
frequenza di scrittura dell'indice a confronto con la frequenza di scrittura dei documenti
Figura 7. Frequenza di scrittura dell'indice a confronto con la frequenza di scrittura del documento (fai clic per ingrandire).

Nella figura 7 puoi vedere come il tasso di scrittura dell'indice può essere confrontato con il tasso di scrittura dei documenti. In questo esempio, per ogni scrittura di documenti, ci sono circa 6 scritture di indice, che è un tasso di fanout dell'indice relativamente basso.

Client connessi direttamente al database utilizzando gli SDK Firebase

Sono disponibili due metriche di tipo indicatore per monitorare l'attività dei client connessi direttamente ai database Firestore tramite SDK per dispositivi mobili, SDK web o entrambi. Queste metriche includono una funzionalità relativa ai listener snapshot in tempo reale, in cui le modifiche pertinenti al database vengono immediatamente trasmesse in streaming ai client.

  • network/active_connections: il numero di connessioni attive in un determinato momento. Ogni client web o mobile ha una connessione.
  • network/snapshot_listeners: il numero di listener snapshot attualmente registrati in tutti i client connessi. Potrebbero esserci più connessioni per client.

Puoi visualizzare queste metriche nella scheda Usage all'interno del database Firestore nella console Firebase.

Metriche per monitorare l'attività dei client connessi a Firestore
Figura 8. Metriche per monitorare l'attività dei client connessi a Firestore.

Metriche TTL

Le metriche TTL sono disponibili sia per Firestore Native che per i database Firestore in modalità Datastore. Utilizza queste metriche per monitorare l'effetto del criterio TTL applicato.

  • document/ttl_deletion_count: Numero totale di documenti eliminati dai servizi TTL.
Conteggio totale dei documenti eliminati dai servizi TTL
Figura 9. Conteggio totale dei documenti eliminati dai servizi TTL (fai clic per ingrandire).

Nella figura 9 puoi vedere la velocità di eliminazione dei documenti ogni minuto in un periodo di giorni.

  • document/ttl_expiration_to_deletion_delays: tempo trascorso tra la scadenza di un documento con un TTL e il momento in cui è stato effettivamente eliminato.
Tempo impiegato in secondi da Firestore per eliminare i documenti con criteri TTL
Figura 10. Tempo impiegato in secondi da Firestore per eliminare i documenti con criteri TTL (fai clic per ingrandire).

Nella figura 10, puoi vedere che questa metrica fornisce una distribuzione del tempo in secondi impiegato da Firestore per eliminare i documenti con criteri TTL. L'eliminazione dei documenti con TTL scaduto richiede meno di 0,5 secondi al 99° percentile. Ciò implica che il sistema funziona normalmente. Firestore in genere elimina i documenti scaduti entro 24 ore, ma non è garantito. Se noti che l'operazione richiede più di 24 ore, contatta l'assistenza.

Passaggi successivi