Suggerimenti utili
Questo documento descrive le best practice per la progettazione, l'implementazione, il test e il deployment di Cloud Functions.
Correttezza
Questa sezione descrive le best practice generali per la progettazione e l'implementazione di Cloud Functions.
Scrivere funzioni idempotenti
Le funzioni dovrebbero produrre lo stesso risultato anche se vengono chiamate più volte. Questo ti consente di riprovare a eseguire una chiamata se quella precedente non riesce a metà del tuo codice. Per maggiori informazioni, consulta Nuovo tentativo delle funzioni basate su eventi.
Assicurati che le funzioni HTTP inviino una risposta HTTP
Se la funzione è attivata tramite HTTP, ricordati di inviare una risposta HTTP, come mostrato di seguito. In caso contrario, la funzione potrebbe essere eseguita fino al timeout. In questo caso, ti verrà addebitato l'intero tempo di timeout. I timeout possono anche causare comportamenti imprevedibili o avvii a freddo nelle chiamate successive, generando comportamenti imprevedibili o ulteriore latenza.
Node.js
Python
Go
Java
C#
Ruby
PHP
Non avviare attività in background
L'attività in background è tutto ciò che accade dopo l'interruzione della funzione.
Una chiamata a una funzione termina una volta che la funzione restituisce o segnala in altro modo il completamento, ad esempio chiamando l'argomento callback
nelle funzioni basate su eventi Node.js. Qualsiasi codice eseguito dopo la terminazione controllata non può accedere alla CPU e
non consente di fare progressi.
Inoltre, quando una chiamata successiva viene eseguita nello stesso ambiente,
l'attività in background riprende, interferendo con la nuova chiamata. Ciò potrebbe causare comportamenti imprevisti ed errori difficili da diagnosticare. L'accesso
alla rete dopo il termine di una funzione in genere comporta la reimpostazione delle connessioni
(codice di errore ECONNRESET
).
L'attività in background viene spesso rilevata nei log delle singole chiamate, trovando tutto ciò che viene registrato dopo la riga in cui viene indicato che la chiamata è terminata. L'attività in background a volte può essere nascosta meglio nel codice, soprattutto quando sono presenti operazioni asincrone come callback o timer. Esamina il codice per assicurarti che tutte le operazioni asincrone terminino prima di terminare la funzione.
Elimina sempre i file temporanei
L'archiviazione su disco locale nella directory temporanea è un file system in memoria. I file che scrivi consumano la memoria disponibile per la funzione e, a volte, rimangono invariati tra una chiamata e l'altra. La mancata eliminazione esplicita di questi file potrebbe causare un errore di esaurimento della memoria e un successivo avvio a freddo.
Puoi visualizzare la memoria utilizzata da una singola funzione selezionandola nell'elenco delle funzioni nella console Google Cloud e scegliendo il grafico Utilizzo memoria.
Non tentare di scrivere al di fuori della directory temporanea e assicurati di utilizzare metodi piattaforma/indipendente dal sistema operativo per creare i percorsi dei file.
Puoi ridurre i requisiti di memoria durante l'elaborazione di file di grandi dimensioni utilizzando la pipeline. Ad esempio, puoi elaborare un file in Cloud Storage creando un flusso di lettura, facendolo passare attraverso un processo basato su flusso e scrivendo il flusso di output direttamente in Cloud Storage.
Framework di Functions
Quando esegui il deployment di una funzione, il framework di Functions viene aggiunto automaticamente come dipendenza, utilizzando la versione attuale. Per assicurarti che le stesse dipendenze siano installate in modo coerente in diversi ambienti, ti consigliamo di fissare la funzione a una versione specifica del framework di Functions.
Per farlo, includi la tua versione preferita nel file di blocco pertinente (ad esempio, package-lock.json
per Node.js o requirements.txt
per Python).
Strumenti
Questa sezione fornisce linee guida su come utilizzare gli strumenti per implementare, testare e interagire con Cloud Functions.
Sviluppo locale
Il deployment delle funzioni richiede un po' di tempo, pertanto spesso è più veloce testare il codice della funzione localmente.
Error Reporting
Nei linguaggi che utilizzano la gestione delle eccezioni, non generare eccezioni non rilevate, perché forzano l'avvio a freddo nelle chiamate future. Per informazioni su come segnalare correttamente gli errori, consulta la guida a Error Reporting.
Non uscire manualmente
L'uscita manuale può causare comportamenti imprevisti. Usa invece le seguenti idiomi specifiche della lingua:
Node.js
Non usare process.exit()
. Le funzioni HTTP devono inviare una risposta con res.status(200).send(message)
e le funzioni basate su eventi verranno chiuse in modo implicito o esplicito.
Python
Non usare sys.exit()
. Le funzioni HTTP devono restituire esplicitamente una risposta come stringa e le funzioni basate su eventi verranno chiuse quando restituiscono un valore (implicitamente o in modo esplicito).
Go
Non usare os.Exit()
. Le funzioni HTTP devono restituire esplicitamente una risposta come stringa e le funzioni basate su eventi verranno chiuse quando restituiscono un valore (implicitamente o in modo esplicito).
Java
Non usare System.exit()
. Le funzioni HTTP devono inviare una risposta con response.getWriter().write(message)
e le funzioni basate su eventi verranno chiuse in modo implicito o esplicito.
C#
Non usare System.Environment.Exit()
. Le funzioni HTTP devono inviare una risposta con context.Response.WriteAsync(message)
e le funzioni basate su eventi verranno chiuse in modo implicito o esplicito.
Ruby
Non usare exit()
o abort()
. Le funzioni HTTP devono restituire esplicitamente una risposta come stringa e le funzioni basate su eventi verranno chiuse quando restituiscono un valore (implicitamente o in modo esplicito).
PHP
Non usare exit()
o die()
. Le funzioni HTTP devono restituire esplicitamente una risposta come stringa e le funzioni basate su eventi verranno chiuse quando restituiscono un valore (implicitamente o in modo esplicito).
Utilizzare Sendgrid per inviare email
Cloud Functions non consente connessioni in uscita sulla porta 25, quindi non è possibile creare connessioni non sicure a un server SMTP. Il metodo consigliato per inviare email è SendGrid. Puoi trovare altre opzioni per l'invio di email nel tutorial sull'invio di email da un'istanza per Google Compute Engine.
Prestazioni
Questa sezione descrive le best practice per ottimizzare il rendimento.
Usa le dipendenze con oculatezza
Poiché le funzioni sono stateless, l'ambiente di esecuzione viene spesso inizializzato da zero (durante quello che è noto come avvio a freddo). In caso di avvio a freddo, viene valutato il contesto globale della funzione.
Se le funzioni importano moduli, il tempo di caricamento di questi moduli può aumentare la latenza di chiamata durante un avvio a freddo. Puoi ridurre questa latenza, oltre al tempo necessario per eseguire il deployment della funzione, caricando correttamente le dipendenze e non caricando quelle che la funzione non utilizza.
Usare le variabili globali per riutilizzare gli oggetti nelle chiamate future
Non vi è alcuna garanzia che lo stato di una Cloud Function venga conservato per le chiamate future. Tuttavia, Cloud Functions spesso ricicla l'ambiente di esecuzione di una chiamata precedente. Se dichiari una variabile in ambito globale, il suo valore può essere riutilizzato in chiamate successive senza dover essere ricalcolato.
In questo modo puoi memorizzare nella cache gli oggetti che possono essere costosi da ricreare a ogni chiamata di una funzione. Lo spostamento di questi oggetti dal corpo della funzione all'ambito globale può comportare miglioramenti significativi delle prestazioni. L'esempio seguente crea un oggetto pesante solo una volta per ogni istanza di funzione e lo condivide in tutte le chiamate di funzione che raggiungono l'istanza specifica:
Node.js
Python
Go
Java
C#
Ruby
PHP
È particolarmente importante memorizzare nella cache le connessioni di rete, i riferimenti alle librerie e gli oggetti client API in ambito globale. Per alcuni esempi, consulta la sezione Ottimizzazione del networking.
Inizializzazione lazy delle variabili globali
Se inizializza le variabili in ambito globale, il codice di inizializzazione verrà sempre eseguito tramite chiamata di avvio a freddo, aumentando la latenza della funzione.
In alcuni casi, questo causa timeout intermittenti per la chiamata dei servizi se non vengono gestiti correttamente in un blocco try
/catch
. Se alcuni oggetti non vengono utilizzati in tutti i percorsi di codice, valuta la possibilità di inizializzarli lentamente on demand:
Node.js
Python
Go
Java
C#
Ruby
PHP
Le funzioni PHP non possono conservare le variabili tra le richieste. L'esempio di ambiti riportato sopra utilizza il caricamento lento per memorizzare nella cache i valori delle variabili globali in un file.
Ciò è particolarmente importante se si definiscono più funzioni in un singolo file e funzioni diverse utilizzano variabili diverse. A meno che non utilizzi l'inizializzazione pigra, potresti sprecare risorse su variabili che sono state inizializzate ma mai utilizzate.
Riduci gli avvii a freddo impostando un numero minimo di istanze
Per impostazione predefinita, Cloud Functions scala il numero di istanze in base al numero di richieste in entrata. Puoi modificare questo comportamento predefinito impostando un numero minimo di istanze che Cloud Functions deve tenere pronte per gestire le richieste. L'impostazione di un numero minimo di istanze riduce gli avvii a freddo dell'applicazione. Ti consigliamo di impostare un numero minimo di istanze se la tua applicazione è sensibile alla latenza.
Per scoprire come impostare un numero minimo di istanze, consulta Utilizzo del numero minimo di istanze.
Risorse aggiuntive
Scopri di più sull'ottimizzazione delle prestazioni nel video "Atlas prestazioni di Google Cloud" Tempo di avvio a freddo di Cloud Functions.