Best practice per Cloud Firestore

Utilizza le best practice elencate qui come riferimento rapido quando crei un'applicazione che utilizza Cloud Firestore.

Località del database

Quando crei l'istanza del database, seleziona la località del database più vicina ai tuoi utenti e alle tue risorse di computing. Gli hop di rete di ampia portata sono più soggetti a errori e aumentano la latenza delle query.

Per massimizzare la disponibilità e la durabilità della tua applicazione, seleziona una località multiregionale e posiziona le risorse di computing critiche in almeno due regioni.

Seleziona una località a livello di regione per ridurre i costi, per una minore latenza di scrittura se la tua applicazione è sensibile alla latenza o per la colocazione con altre risorse GCP.

ID dei documenti

• Evita gli ID documento . e ...
• Evita di utilizzare barre (/) negli ID documento.

• Non utilizzare ID documento che aumentano in modo monotono, ad esempio:

  • Customer1, Customer2, Customer3…
  • Product 1, Product 2, Product 3…

  Questi ID sequenziali possono generare hotspot che influiscono sulla latenza.

Nomi campi

• Evita i seguenti caratteri nei nomi dei campi perché richiedono un escaping aggiuntivo:

  • . punto
  • [ parentesi quadra aperta
  • ] parentesi quadra destra
  • * asterisco
  • ` accento grave

Indici

Riduci la latenza di scrittura

Il fattore principale che contribuisce alla latenza di scrittura è il fanout dell'indice. Le best practice per ridurre il fanout dell'indice sono:

• Imposta le esenzioni dell'indice a livello di raccolta. Un'impostazione predefinita semplice è disattivare l'indicizzazione decrescente e degli array. La rimozione dei valori indicizzati non utilizzati ridurrà anche i costi di archiviazione.

• Riduci il numero di documenti in una transazione. Per scrivere un numero elevato di documenti, valuta la possibilità di utilizzare un writer collettivo anziché il writer di batch atomico.

Esenzioni degli indici

Per la maggior parte delle app, puoi fare affidamento sull'indicizzazione automatica e sui link dei messaggi di errore per gestire gli indici. Tuttavia, potresti voler aggiungere esenzioni per singoli campi nei seguenti casi:

Operazioni di lettura e scrittura

• La frequenza massima esatta con cui un'app può aggiornare un singolo documento dipende in larga misura dal workload. Per saperne di più, consulta Aggiornamenti di un singolo documento.

• Utilizza chiamate asincrone, se disponibili, anziché chiamate sincrone. Le chiamate asincrone riducono al minimo l'impatto sulla latenza. Ad esempio, considera un'applicazione che richiede il risultato di una ricerca di documenti e i risultati di una query prima di eseguire il rendering di una risposta. Se la ricerca e la query non hanno una dipendenza dai dati, non è necessario attendere in modo sincrono il completamento della ricerca prima di avviare la query.

• Non utilizzare gli offset. Utilizza invece i cursori. L'utilizzo di un offset evita solo di restituire i documenti saltati alla tua applicazione, ma questi documenti vengono comunque recuperati internamente. I documenti ignorati influiscono sulla latenza della query e alla tua applicazione vengono addebitate le operazioni di lettura necessarie per recuperarli.

Nuovi tentativi di transazione

Gli SDK e le librerie client di Cloud Firestore riprovano automaticamente le transazioni non riuscite per gestire gli errori temporanei. Se la tua applicazione accede a Cloud Firestore direttamente tramite le API REST o RPC anziché tramite un SDK, l'applicazione deve implementare i nuovi tentativi di transazione per aumentare l'affidabilità.

Aggiornamenti in tempo reale

Per le best practice relative agli aggiornamenti in tempo reale, consulta Informazioni sulle query in tempo reale su larga scala.

Progettazione per la scalabilità

Le seguenti best practice descrivono come evitare situazioni che creano problemi di conflitto.

Aggiornamenti a un singolo documento

Quando progetti la tua app, considera la velocità con cui aggiorna i singoli documenti. Il modo migliore per caratterizzare le prestazioni del tuo workload è eseguire test di carico. La frequenza massima esatta con cui un'app può aggiornare un singolo documento dipende in larga misura dal workload. I fattori includono la frequenza di scrittura, la contesa tra le richieste e il numero di indici interessati.

Un'operazione di scrittura di un documento aggiorna il documento e gli eventuali indici associati e Cloud Firestore applica in modo sincrono l'operazione di scrittura a un quorum di repliche. Con frequenze di scrittura sufficientemente elevate, il database inizierà a riscontrare conflitti, latenza più elevata o altri errori.

Frequenze elevate di lettura, scrittura ed eliminazione per un intervallo di documenti limitato

Evita frequenze di lettura o scrittura elevate per documenti lessicograficamente vicini, altrimenti la tua applicazione riscontrerà errori di conflitto. Questo problema è noto come hotspotting e l'applicazione può riscontrarlo se esegue una delle seguenti operazioni:

• Crea nuovi documenti a una frequenza molto elevata e assegna i propri ID che aumentano in modo monotonico.

  Cloud Firestore assegna gli ID documento utilizzando un algoritmo di dispersione. Non dovresti riscontrare hotspotting sulle scritture se crei nuovi documenti utilizzando ID documento automatici.

• Crea nuovi documenti a una frequenza elevata in una raccolta con pochi documenti.

• Crea nuovi documenti con un campo che aumenta in modo monotonico, ad esempio un timestamp, a una frequenza molto elevata.

• Elimina i documenti di una raccolta a una frequenza elevata.

• Scrive nel database a una frequenza molto elevata senza aumentare gradualmente il traffico.

Evita di saltare i dati eliminati

Evita le query che ignorano i dati eliminati di recente. Una query potrebbe dover saltare un numero elevato di voci dell'indice se i risultati iniziali della query sono stati eliminati di recente.

Un esempio di workload che potrebbe dover saltare molti dati eliminati è quello che tenta di trovare gli elementi di lavoro in coda più vecchi. La query potrebbe essere simile alla seguente:

docs = db.collection('WorkItems').order_by('created').limit(100)
delete_batch = db.batch()
for doc in docs.stream():
  finish_work(doc)
  delete_batch.delete(doc.reference)
delete_batch.commit()

Ogni volta che viene eseguita, questa query analizza le voci dell'indice per il campo created in tutti i documenti eliminati di recente. Questo rallenta le query.

Per migliorare le prestazioni, utilizza il metodo start_at per trovare il punto di partenza migliore. Ad esempio:

completed_items = db.collection('CompletionStats').document('all stats').get()
docs = db.collection('WorkItems').start_at(
    {'created': completed_items.get('last_completed')}).order_by(
        'created').limit(100)
delete_batch = db.batch()
last_completed = None
for doc in docs.stream():
  finish_work(doc)
  delete_batch.delete(doc.reference)
  last_completed = doc.get('created')

if last_completed:
  delete_batch.update(completed_items.reference,
                      {'last_completed': last_completed})
  delete_batch.commit()

NOTA: l'esempio precedente utilizza un campo che aumenta in modo monotonico, che è un anti-pattern per frequenze di scrittura elevate.

Aumento del traffico

Devi aumentare gradualmente il traffico verso nuove raccolte o documenti lessicograficamente vicini per dare a Cloud Firestore il tempo sufficiente per preparare i documenti per l'aumento del traffico. Ti consigliamo di iniziare con un massimo di 500 operazioni al secondo per una nuova raccolta e poi di aumentare il traffico del 50% ogni 5 minuti. Puoi aumentare il traffico di scrittura in modo simile, ma tieni presente i limiti standard di Cloud Firestore. Assicurati che le operazioni siano distribuite in modo relativamente uniforme nell'intervallo di chiavi. Questa è la regola "500/50/5".

Migrazione del traffico a una nuova raccolta

L'aumento graduale è particolarmente importante se esegui la migrazione del traffico dell'app da una raccolta a un'altra. Un modo semplice per gestire questa migrazione è leggere dalla raccolta precedente e, se il documento non esiste, leggere dalla nuova raccolta. Tuttavia, ciò potrebbe causare un improvviso aumento del traffico verso i documenti lessicograficamente vicini nella nuova raccolta. Cloud Firestore potrebbe non essere in grado di preparare in modo efficiente la nuova raccolta per l'aumento del traffico, soprattutto se contiene pochi documenti.

Un problema simile può verificarsi se modifichi gli ID di molti documenti all'interno della stessa raccolta.

La strategia migliore per la migrazione del traffico a una nuova raccolta dipende dal modello di dati. Di seguito è riportato un esempio di strategia nota come letture parallele. Dovrai determinare se questa strategia è efficace per i tuoi dati e una considerazione importante sarà l'impatto sui costi delle operazioni parallele durante la migrazione.

Letture in parallelo

Per implementare le letture parallele durante la migrazione del traffico a una nuova raccolta, leggi prima dalla raccolta precedente. Se il documento non è presente, leggi dalla nuova raccolta. Un tasso elevato di letture di documenti inesistenti può causare hotspotting, quindi assicurati di aumentare gradualmente il carico sulla nuova raccolta. Una strategia migliore consiste nel copiare il documento precedente nella nuova raccolta, quindi eliminarlo. Aumenta gradualmente le letture parallele per assicurarti che Cloud Firestore possa gestire il traffico verso la nuova raccolta.

Una possibile strategia per aumentare gradualmente le letture o le scritture in una nuova raccolta consiste nell'utilizzare un hash deterministico dell'ID utente per selezionare una percentuale casuale di utenti che tentano di scrivere nuovi documenti. Assicurati che il risultato dell'hash dell'ID utente non sia distorto dalla funzione o dal comportamento dell'utente.

Nel frattempo, esegui un job batch che copia tutti i dati dai vecchi documenti alla nuova raccolta. Il job batch deve evitare scritture su ID documento sequenziali per evitare hotspot. Al termine del job batch, puoi leggere solo dalla nuova raccolta.

Un perfezionamento di questa strategia consiste nel migrare piccoli gruppi di utenti alla volta. Aggiungi un campo al documento utente che monitora lo stato della migrazione dell'utente. Seleziona un gruppo di utenti di cui eseguire la migrazione in base a un hash dell'ID utente. Utilizza un job batch per eseguire la migrazione dei documenti per quel gruppo di utenti e utilizza le letture parallele per gli utenti nel mezzo della migrazione.

Tieni presente che non puoi eseguire facilmente il rollback, a meno che non esegui scritture doppie delle entità precedenti e nuove durante la fase di migrazione. Ciò aumenterebbe i costi sostenuti per Cloud Firestore.

Privacy

• Evita di archiviare informazioni sensibili in un ID progetto cloud. Un ID progetto cloud potrebbe essere conservato oltre la durata del progetto.
• Come best practice per la conformità dei dati, ti consigliamo di non archiviare informazioni sensibili nei nomi dei documenti e dei campi dei documenti.

Impedisci l'accesso non autorizzato

Impedisci operazioni non autorizzate sul tuo database con Cloud Firestore Security Rules. Ad esempio, l'utilizzo delle regole potrebbe evitare uno scenario in cui un utente malintenzionato scarica ripetutamente l'intero database.

Scopri di più sull'utilizzo di Cloud Firestore Security Rules.