Funkcje kolejki zadań korzystają z zadań w chmurze Google, aby ułatwić aplikacji asynchroniczne wykonywanie zadań, które zajmują czasochłonne, wymagające znacznych zasobów lub z ograniczoną przepustowością, poza głównym przepływem aplikacji.
Załóżmy na przykład, że chcesz utworzyć kopie zapasowe dużego zestawu plików graficznych, które są obecnie hostowane w interfejsie API z limitem liczby żądań. Aby korzystać z tego interfejsu API w sposób odpowiedzialny, musisz przestrzegać związanych z nim limitów liczby żądań. Dodatkowo tego rodzaju długotrwałe zadanie może być podatne na awarie z powodu przekroczenia limitów czasu i limitów pamięci.
Aby zmniejszyć złożoność, możesz napisać funkcję kolejki zadań, która ustawia podstawowe opcje zadań, takie jak scheduleTime i dispatchDeadline, a następnie przekazać ją do kolejki w Cloud Tasks. Środowisko Cloud Tasks zostało zaprojektowane tak, aby zapewnić skuteczną kontrolę nad zatorami oraz konieczność ponawiania zasad w przypadku tego typu operacji.
Pakiet Firebase SDK dla Cloud Functions dla Firebase w wersji 3.20.1 lub nowszej współpracuje z pakietem Firebase Admin SDK w wersji 10.2.0 lub nowszej, aby obsługiwać funkcje kolejki zadań.
Korzystanie z funkcji kolejki zadań w Firebase może spowodować naliczenie opłat za przetwarzanie w Cloud Tasks. Więcej informacji znajdziesz w cenniku Cloud Tasks.
Tworzenie funkcji kolejki zadań
Aby użyć funkcji kolejki zadań, wykonaj ten przepływ pracy:
- Napisz funkcję kolejki zadań za pomocą pakietu SDK Firebase dla Cloud Functions.
- Przetestuj funkcję przez aktywowanie jej za pomocą żądania HTTP.
- wdrożyć funkcję za pomocą interfejsu wiersza poleceń Firebase, Przy pierwszym wdrożeniu funkcji kolejki zadań interfejs wiersza poleceń utworzy w Cloud Tasks kolejkę zadań z opcjami (ograniczenie liczby żądań i ponowienie próby) określonymi w kodzie źródłowym.
- Do nowo utworzonej kolejki zadań możesz dodawać zadania, przekazując parametry, aby w razie potrzeby skonfigurować harmonogram wykonywania. Aby to zrobić, napisz kod za pomocą pakietu Admin SDK i wdróż go w Cloud Functions dla Firebase.
Zapisywanie funkcji kolejki zadań
Aby rozpocząć tworzenie funkcji kolejki zadań, użyj narzędzia onDispatch. Ważnym elementem tworzenia funkcji kolejki zadań jest ustawienie konfiguracji ponownych prób w kolejce i konfiguracji ograniczania liczby żądań. Przykładowe fragmenty kodu na tej stronie pochodzą z aplikacji konfigurującej usługę tworzącą kopie zapasowe wszystkich zdjęć ze zdjęcia dnia NASA Astronomy Picture of the Day:
Konfigurowanie funkcji kolejki zadań
Funkcje kolejki zadań mają rozbudowany zestaw ustawień, które pozwalają precyzyjnie kontrolować limity liczby żądań i ponawiać próby działania kolejki zadań:
exports.backupApod = functions
.runWith( {secrets: ["NASA_API_KEY"]})
.tasks.taskQueue({
retryConfig: {
maxAttempts: 5,
minBackoffSeconds: 60,
},
rateLimits: {
maxConcurrentDispatches: 6,
},
}).onDispatch(async (data) => {
retryConfig.maxAttempts=5: każde zadanie w kolejce zadań jest automatycznie powtarzane maksymalnie 5 razy. Pomaga to ograniczyć przejściowe błędy, takie jak błędy sieci lub tymczasowe zakłócenia w działaniu zależnej usługi zewnętrznej.retryConfig.minBackoffSeconds=60: każde zadanie jest powtarzane co najmniej 60 sekund po każdej próbie. Pozwala to utworzyć duży bufor pomiędzy każdą kolejną próbą, aby nie spieszyć się do zbyt szybkiego wykorzystania 5 prób.rateLimits.maxConcurrentDispatch=6: wysyłanych jest maksymalnie 6 zadań naraz. Pomaga to zapewnić stały strumień żądań do funkcji bazowej oraz zmniejszyć liczbę aktywnych instancji i uruchomień „na zimno”.
Testowanie funkcji kolejki zadań
Funkcje kolejki zadań w Pakiecie emulatorów lokalnych Firebase są dostępne jako proste funkcje HTTP. Możesz przetestować emulowaną funkcję zadania, wysyłając żądanie HTTP POST z ładunkiem danych JSON:
# start the Firebase Emulators
firebase emulators:start
# trigger the emulated task queue function
curl \
-X POST # An HTTP POST request...
-H "content-type: application/json" \ # ... with a JSON body
http://localhost:$PORT/$PROJECT_ID/$REGION/$NAME \ # ... to function url
-d '{"data": { ... some data .... }}' # ... with JSON encoded data
Wdrażanie funkcji kolejki zadań
Wdróż funkcję kolejki zadań za pomocą interfejsu wiersza poleceń Firebase:
$ firebase deploy --only functions:backupApod
Przy pierwszym wdrażaniu funkcji kolejki zadań interfejs wiersza poleceń tworzy w Cloud Tasks kolejkę zadań z opcjami (ograniczanie liczby żądań i ponawianie prób) określonymi w kodzie źródłowym.
Jeśli podczas wdrażania funkcji wystąpią błędy uprawnień, sprawdź, czy do użytkownika, który wykonuje polecenia wdrażania, przypisane są odpowiednie role uprawnień.
Kolejkowanie funkcji kolejki zadań
Funkcje kolejki zadań można dodawać do kolejki w Cloud Tasks z zaufanego środowiska serwera, takiego jak Cloud Functions dla Firebase, przy użyciu pakietu SDK Firebase Admin dla Node.js. Jeśli nie znasz jeszcze pakietów Admin SDK, przeczytaj artykuł Dodawanie Firebase do serwera.
W typowym przepływie pakiet Admin SDK tworzy nowe zadanie, dodaje je do kolejki w Cloud Tasks i ustawia jego konfigurację:
exports.enqueueBackupTasks = functions.https.onRequest(
async (_request, response) => {
const queue = getFunctions().taskQueue("backupApod");
const enqueues = [];
for (let i = 0; i <= 10; i += 1) {
// Enqueue each task with i*60 seconds delay. Our task queue function
// should process ~1 task/min.
const scheduleDelaySeconds = i * 60
enqueues.push(
queue.enqueue(
{ id: `task-${i}` },
{
scheduleDelaySeconds,
dispatchDeadlineSeconds: 60 * 5 // 5 minutes
},
),
);
}
await Promise.all(enqueues);
response.sendStatus(200);
});
scheduleDelaySeconds: przykładowy kod próbuje rozłożyć wykonywanie zadań przez powiązanie z n-tym zadaniem opóźnienie wynoszące n-te minuty. Oznacza to wyzwalanie ok. 1 zadania na minutę. Pamiętaj, że możesz też użyć poleceniascheduleTime, jeśli chcesz, aby usługa Cloud Tasks wyzwalała zadanie w określonym czasie.dispatchDeadlineSeconds: maksymalny czas, przez jaki Cloud Tasks będzie czekać na wykonanie zadania. Cloud Tasks spróbuje ponownie wykonać zadanie po ponownej konfiguracji kolejki lub do upłynięcia tego terminu. W przykładzie kolejka jest skonfigurowana tak, aby ponawiać zadanie nawet 5 razy, ale zadanie jest automatycznie anulowane, jeśli cały proces (w tym ponowna próba) trwa dłużej niż 5 minut.
Rozwiązywanie problemów
Włącz logowanie w Cloud Tasks
Logi z Cloud Tasks zawierają przydatne informacje diagnostyczne, takie jak stan żądania powiązanego z zadaniem. Domyślnie logi z Cloud Tasks są wyłączone ze względu na dużą liczbę logów, które może wygenerować w projekcie. Zalecamy włączenie logów debugowania na czas aktywnego rozwijania i debugowania funkcji kolejki zadań. Zobacz Włączanie rejestrowania.
Uprawnienia
Podczas dodawania zadań do kolejki lub próby wywołania funkcji kolejki zadań Cloud Tasks może wystąpić błąd PERMISSION DENIED. Sprawdź, czy Twój projekt ma te powiązania uprawnień:
Tożsamość używana do umieszczania zadań w kolejce w Cloud Tasks wymaga uprawnienia
cloudtasks.tasks.create.W przykładzie jest to domyślne konto usługi App Engine.
gcloud projects add-iam-policy-binding $PROJECT_ID \
--member=serviceAccount:${PROJECT_ID}@appspot.gserviceaccount.com \
--role=roles/cloudtasks.enqueuer
Tożsamość używana do umieszczania zadań w kolejce w Cloud Tasks wymaga uprawnień do korzystania z konta usługi powiązanego z zadaniem w Cloud Tasks.
W przykładzie jest to domyślne konto usługi App Engine.
Instrukcje dodawania domyślnego konta usługi App Engine jako użytkownika domyślnego konta usługi App Engine znajdziesz w dokumentacji Google Cloud IAM.
Tożsamość używana do aktywowania funkcji kolejki zadań wymaga uprawnienia
cloudfunctions.functions.invoke.W przykładzie jest to domyślne konto usługi App Engine.
gcloud functions add-iam-policy-binding $FUNCTION_NAME \
--region=us-central1 \
--member=serviceAccount:${PROJECT_ID}@appspot.gserviceaccount.com \
--role=roles/cloudfunctions.invoker