Memperluas Cloud Run dengan pemicu peristiwa menggunakan fungsi Cloud Run
Dengan fungsi Cloud Run, Anda dapat men-deploy kode untuk menangani peristiwa yang dipicu oleh perubahan pada database Cloud Run. Dengan begitu, Anda dapat menambahkan fungsionalitas sisi server tanpa harus menjalankan server Anda sendiri.
Panduan ini menjelaskan cara membuat pemicu untuk fungsi Cloud Run dari peristiwa Firestore.
Anda dapat memicu fungsi Cloud Run dari peristiwa di database Firestore. Saat dipicu, fungsi Anda akan membaca dan mengupdate database Firestore sebagai respons terhadap peristiwa ini melalui API Firestore dan library klien.
Proses peristiwa Firestore yang memicu fungsi Cloud Run terdiri dari langkah-langkah berikut:
Layanan menunggu perubahan pada dokumen tertentu.
Saat perubahan terjadi, layanan akan dipicu dan menjalankan tugasnya.
Layanan menerima objek data dengan snapshot dokumen yang terpengaruh. Untuk peristiwa
write
atauupdate
, objek data berisi snapshot yang mewakili status dokumen sebelum dan setelah peristiwa pemicuan.
Sebelum memulai
- Pastikan Anda telah menyiapkan project baru untuk Cloud Run seperti yang dijelaskan di halaman setup.
Aktifkan Artifact Registry, Cloud Build, Cloud Run Admin API, Eventarc, Firestore Cloud Logging, dan Pub/Sub API:
Peran yang diperlukan
Anda atau administrator Anda harus memberikan akses ke akun deployer dan identitas pemicu. Secara opsional, berikan peran IAM berikut kepada agen layanan Pub/Sub.
Peran yang diperlukan untuk akun deployer
Untuk mendapatkan izin yang Anda perlukan untuk memicu dari peristiwa Firestore, minta administrator Anda untuk memberi Anda peran IAM berikut di project Anda:
-
Editor Cloud Build (
roles/cloudbuild.builds.editor
) -
Admin Cloud Run (
roles/run.admin
) -
Pemilik Datastore (
roles/datastore.owner
) -
Eventarc Admin (
roles/eventarc.admin
) -
Logs View Accessor (
roles/logging.viewAccessor
) -
Project IAM Admin (
roles/resourcemanager.projectIamAdmin
) -
Service Account Admin (
roles/iam.serviceAccountAdmin
) -
Service Account User (
roles/iam.serviceAccountUser
) -
Service Usage Admin (
roles/serviceusage.serviceUsageAdmin
)
Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.
Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran khusus atau peran bawaan lainnya.
Perhatikan bahwa secara default, izin Cloud Build mencakup izin untuk mengupload dan mendownload artefak Artifact Registry.
Peran yang diperlukan untuk identitas pemicu
Catat akun layanan default Compute Engine karena Anda akan melampirkannya ke pemicu Eventarc untuk merepresentasikan identitas pemicu untuk tujuan pengujian. Akun layanan ini dibuat secara otomatis setelah mengaktifkan atau menggunakan layanan Google Cloud yang menggunakan Compute Engine, dan dengan format email berikut:
PROJECT_NUMBER-compute@developer.gserviceaccount.com
Ganti
PROJECT_NUMBER
dengan Google Cloud nomor project Anda. Anda dapat menemukan nomor project di halaman Selamat Datang di konsol Google Cloud atau dengan menjalankan perintah berikut:gcloud projects describe PROJECT_ID --format='value(projectNumber)'
Untuk lingkungan produksi, sebaiknya buat akun layanan baru dan berikan satu atau beberapa peran IAM yang berisi izin minimum yang diperlukan dan ikuti prinsip hak istimewa terendah.
- Secara default, layanan Cloud Run hanya dapat dipanggil oleh
Project Owner, Project Editor, Cloud Run Admin dan Invoker.
Anda dapat
mengontrol
akses per layanan; namun, untuk tujuan pengujian, berikan
peran Cloud Run
Invoker (
run.invoker
) di project Google Cloud ke akun layanan Compute Engine. Peran ini akan memberikan peran tersebut di semua layanan dan tugas Cloud Run dalam suatu project.gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \ --role=roles/run.invoker
Perhatikan bahwa pemicu akan berhasil dibuat dan diaktifkan jika Anda membuat pemicu untuk layanan Cloud Run yang diautentikasi tanpa memberikan peran Cloud Run Namun, pemicu tidak akan berfungsi seperti yang diharapkan dan pesan yang mirip dengan berikut ini akan muncul di log:
The request was not authenticated. Either allow unauthenticated invocations or set the proper Authorization header.
- Berikan
Peran
Eventarc Event Receiver (
roles/eventarc.eventReceiver
) pada project ke akun layanan default Compute Engine agar pemicu Eventarc dapat menerima peristiwa dari penyedia peristiwa.gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \ --role=roles/eventarc.eventReceiver
Peran opsional untuk agen layanan Pub/Sub
- Jika Anda mengaktifkan agen layanan Cloud Pub/Sub pada atau sebelum
8 April 2021, untuk mendukung permintaan push Pub/Sub yang diautentikasi, berikan
peran
Service Account Token Creator (
roles/iam.serviceAccountTokenCreator
) kepada agen layanan. Jika tidak, peran ini akan diberikan secara default:gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com \ --role=roles/iam.serviceAccountTokenCreator
Menyiapkan database Firestore
Sebelum men-deploy layanan, Anda harus membuat database Firestore:
Buka halaman Firestore.
Pilih Create a Firestore database.
Di kolom Name your database, masukkan ID Database, seperti
firestore-db
.Di bagian Opsi konfigurasi, Firestore native dipilih secara default bersama dengan aturan keamanan yang berlaku.
Di Location type, pilih Region dan pilih region tempat database Anda berada. Pilihan ini bersifat permanen.
Klik Buat database.
Model data Firestore terdiri dari koleksi yang berisi dokumen. Setiap dokumen berisi kumpulan key-value pair.
Menulis fungsi yang dipicu Firestore
Untuk menulis fungsi yang merespons peristiwa Firestore, bersiaplah untuk menentukan hal berikut selama deployment:
- jenis peristiwa pemicu
- filter peristiwa pemicu untuk memilih dokumen yang terkait dengan fungsi
- kode fungsi yang akan dijalankan
Jenis peristiwa
Firestore mendukung peristiwa create
, update
, delete
, dan write
. Peristiwa write
mencakup semua perubahan pada dokumen.
Jenis peristiwa | Pemicu |
---|---|
google.cloud.firestore.document.v1.created (default) |
Dipicu saat dokumen ditulisi untuk pertama kalinya. |
google.cloud.firestore.document.v1.updated |
Dipicu saat dokumen sudah ada dan nilainya berubah. |
google.cloud.firestore.document.v1.deleted |
Dipicu saat dokumen yang memuat data dihapus. |
google.cloud.firestore.document.v1.written |
Dipicu saat dokumen dibuat, diperbarui, atau dihapus. |
google.cloud.firestore.document.v1.created.withAuthContext |
Sama seperti created , tetapi menambahkan informasi autentikasi. |
google.cloud.firestore.document.v1.updated.withAuthContext |
Sama seperti updated , tetapi menambahkan informasi autentikasi. |
google.cloud.firestore.document.v1.deleted.withAuthContext |
Sama seperti deleted , tetapi menambahkan informasi autentikasi. |
google.cloud.firestore.document.v1.written.withAuthContext |
Sama seperti written , tetapi menambahkan informasi autentikasi. |
Karakter pengganti ditulis dalam pemicu menggunakan tanda kurung kurawal, misalnya:
projects/YOUR_PROJECT_ID/databases/(default)/documents/collection/{document_wildcard}
Filter peristiwa pemicu
Untuk memicu layanan Anda, tentukan jalur dokumen yang akan diproses. Jalur dokumen harus berada dalam project yang sama dengan layanan. Google Cloud
Berikut adalah beberapa contoh jalur dokumen yang valid:
users/marie
: Memantau satu dokumen,/users/marie
.users/{username}
: Memantau semua dokumen pengguna. Karakter pengganti digunakan untuk memantau semua dokumen dalam koleksi.users/{username}/addresses/home
: Memantau dokumen alamat rumah untuk semua pengguna.users/{username}/addresses/{addressId}
: Memantau semua dokumen alamat.users/{user=**}
: Memantau semua dokumen pengguna dan setiap dokumen dalam subkoleksi pada setiap dokumen pengguna seperti/users/userID/address/home
atau/users/userID/phone/work
.users/{username}/addresses
: jalur alamat tidak valid. Mengacu pada subkoleksiaddresses
, bukan dokumen.
Karakter pengganti dan parameter
Jika tidak mengetahui secara spesifik dokumen yang ingin dipantau, gunakan {wildcard}
, bukan ID dokumen:
users/{username}
akan memproses perubahan pada semua dokumen pengguna.
Dalam contoh ini, saat kolom dalam dokumen pada users
diubah, maka akan dicocokkan dengan karakter pengganti yang disebut {username}
.
Jika dokumen dalam users
memiliki
subkoleksi, dan kolom di salah satu dokumen subkoleksi tersebut diubah, karakter pengganti {username}
tidak akan terpicu. Jika sasaran Anda adalah juga merespons peristiwa di subkoleksi, gunakan karakter pengganti multi-segmen {username=**}
.
Kecocokan karakter pengganti diekstrak dari jalur dokumen. Anda dapat menentukan karakter pengganti sebanyak yang Anda inginkan untuk mengganti koleksi eksplisit atau ID dokumen. Anda dapat menggunakan maksimal satu karakter pengganti multi-segmen seperti {username=**}
.
Kode fungsi
Lihat contoh cara menggunakan peristiwa Firestore dalam Mode Native untuk memicu fungsi Cloud Run.
Sertakan dependensi proto dalam sumber Anda
Anda harus menyertakan file Cloud Run data.proto
di direktori sumber untuk fungsi Anda. File ini mengimpor proto berikut yang juga harus Anda sertakan dalam direktori sumber:
Gunakan struktur direktori yang sama untuk dependensi. Misalnya, tempatkan
struct.proto
dalam google/protobuf
.
File ini diperlukan untuk mendekode data peristiwa. Jika sumber fungsi Anda tidak menyertakan file ini, fungsi akan menampilkan error saat dijalankan.
Atribut peristiwa
Setiap peristiwa mencakup atribut data yang mencakup informasi tentang peristiwa seperti waktu pemicuan peristiwa. Cloud Run menambahkan data tambahan tentang database dan dokumen yang terlibat dalam peristiwa. Anda dapat mengakses atribut ini sebagai berikut:
Java
logger.info("Function triggered by event on: " + event.getSource()); logger.info("Event type: " + event.getType()); logger.info("Event time " + event.getTime()); logger.info("Event project: " + event.getExtension("project")); logger.info("Event location: " + event.getExtension("location")); logger.info("Database name: " + event.getExtension("database")); logger.info("Database document: " + event.getExtension("document")); // For withAuthContext events logger.info("Auth information: " + event.getExtension("authid")); logger.info("Auth information: " + event.getExtension("authtype"));
Node.js
console.log(`Function triggered by event on: ${cloudEvent.source}`); console.log(`Event type: ${cloudEvent.type}`); console.log(`Event time: ${cloudEvent.time}`); console.log(`Event project: ${cloudEvent.project}`); console.log(`Event location: ${cloudEvent.location}`); console.log(`Database name: ${cloudEvent.database}`); console.log(`Document name: ${cloudEvent.document}`); // For withAuthContext events console.log(`Auth information: ${cloudEvent.authid}`); console.log(`Auth information: ${cloudEvent.authtype}`);
Python
print(f"Function triggered by change to: {cloud_event['source']}") print(f"Event type: {cloud_event['type']}") print(f"Event time: {cloud_event['time']}") print(f"Event project: {cloud_event['project']}") print(f"Location: {cloud_event['location']}") print(f"Database name: {cloud_event['database']}") print(f"Document: {cloud_event['document']}") // For withAuthContext events print(f"Auth information: {cloud_event['authid']}") print(f"Auth information: {cloud_event['authtype']}")
Struktur peristiwa
Pemicu ini memanggil layanan Anda dengan peristiwa yang mirip dengan:
{ "oldValue": { // Update and Delete operations only A Document object containing a pre-operation document snapshot }, "updateMask": { // Update operations only A DocumentMask object that lists changed fields. }, "value": { // A Document object containing a post-operation document snapshot } }
Setiap objek Document
berisi satu atau beberapa objek Value
. Lihat
dokumentasi Value
untuk referensi jenis.
Membuat pemicu untuk fungsi
Klik tab untuk mendapatkan petunjuk cara menggunakan alat pilihan Anda.
Konsol
Saat menggunakan konsol Google Cloud untuk membuat fungsi, Anda juga dapat menambahkan pemicu ke fungsi. Ikuti langkah-langkah berikut untuk membuat pemicu bagi fungsi Anda:
Di konsol Google Cloud , buka Cloud Run:
Klik Write a function, lalu masukkan detail fungsi. Untuk mengetahui informasi selengkapnya tentang cara mengonfigurasi fungsi selama deployment, lihat Men-deploy fungsi.
Di bagian Pemicu, klik Tambahkan pemicu.
Pilih Pemicu Firestore.
Di panel Eventarc trigger, ubah detail pemicu sebagai berikut:
Masukkan nama pemicu di kolom Nama pemicu, atau gunakan nama default.
Pilih Jenis pemicu dari daftar:
Sumber Google untuk menentukan pemicu bagi Pub/Sub, Cloud Storage, Firestore, dan penyedia peristiwa Google lainnya.
Pihak ketiga untuk berintegrasi dengan penyedia non-Google yang menawarkan sumber Eventarc. Untuk mengetahui informasi selengkapnya, lihat Peristiwa pihak ketiga di Eventarc.
Pilih Firestore dari daftar Event provider, untuk memilih produk yang menyediakan jenis peristiwa untuk memicu fungsi Anda. Untuk daftar penyedia peristiwa, lihat Penyedia dan tujuan peristiwa.
Pilih type=google.cloud.firestore.document.v1.created dari daftar Event type. Konfigurasi pemicu Anda bervariasi, bergantung pada jenis peristiwa yang didukung. Untuk mengetahui informasi selengkapnya, lihat Jenis peristiwa.
Di bagian Filter, pilih database, operasi, dan nilai atribut, atau gunakan pilihan default.
Jika kolom Region diaktifkan, pilih lokasi untuk pemicu Eventarc. Secara umum, lokasi pemicu Eventarc harus cocok dengan lokasi resource Google Cloud yang ingin Anda pantau peristiwanya. Dalam sebagian besar skenario, Anda juga harus men-deploy fungsi di region yang sama. Lihat Memahami lokasi Eventarc untuk mengetahui detail selengkapnya tentang lokasi pemicu Eventarc.
Di kolom Service account, pilih akun layanan. Pemicu Eventarc ditautkan ke akun layanan untuk digunakan sebagai identitas saat memanggil fungsi Anda. Akun layanan pemicu Eventarc Anda harus memiliki izin untuk memanggil fungsi Anda. Secara default, Cloud Run menggunakan akun layanan default Compute Engine.
Jika perlu, tentukan Jalur URL layanan untuk mengirim permintaan masuk ke. Ini adalah jalur relatif pada layanan tujuan yang akan menjadi tempat pengiriman peristiwa untuk pemicu. Misalnya:
/
,/route
,route
, danroute/subroute
.
Setelah Anda mengisi kolom yang wajib diisi, klik Simpan pemicu.
gcloud
Saat membuat fungsi menggunakan gcloud CLI, Anda harus men-deploy fungsi terlebih dahulu, lalu membuat pemicu. Ikuti langkah-langkah berikut untuk membuat pemicu bagi fungsi Anda:
Jalankan perintah berikut di direktori yang berisi kode contoh untuk men-deploy fungsi Anda:
gcloud run deploy FUNCTION \ --source . \ --function FUNCTION_ENTRYPOINT \ --base-image BASE_IMAGE_ID \ --region REGION
Ganti:
FUNCTION dengan nama fungsi yang Anda deploy. Anda dapat menghilangkan parameter ini sepenuhnya, tetapi Anda akan diminta untuk memasukkan nama jika menghilangkannya.
FUNCTION_ENTRYPOINT dengan titik entri ke fungsi Anda dalam kode sumber. Ini adalah kode yang dieksekusi Cloud Run saat fungsi Anda berjalan. Nilai flag ini harus berupa nama fungsi atau nama class yang sepenuhnya memenuhi syarat yang ada dalam kode sumber Anda.
BASE_IMAGE_ID dengan lingkungan image dasar untuk fungsi Anda. Untuk mengetahui detail selengkapnya tentang image dasar dan paket yang disertakan dalam setiap image, lihat Image dasar runtime.
REGION dengan Google Cloud region tempat Anda ingin men-deploy fungsi Anda. Contohnya,
europe-west1
Jalankan perintah berikut untuk membuat pemicu yang memfilter peristiwa:
gcloud eventarc triggers create TRIGGER_NAME \ --location=EVENTARC_TRIGGER_LOCATION \ --destination-run-service=FUNCTION \ --destination-run-region=REGION \ --event-filters="type=google.cloud.firestore.document.v1.created" \ --service-account=PROJECT_NUMBER-compute@developer.gserviceaccount.com
Ganti:
TRIGGER_NAME dengan nama pemicu Anda.
EVENTARC_TRIGGER_LOCATION dengan lokasi untuk pemicu Eventarc. Secara umum, lokasi pemicu Eventarc harus cocok dengan lokasi resource Google Cloud yang ingin Anda pantau peristiwanya. Dalam sebagian besar skenario, Anda juga harus men-deploy fungsi di region yang sama. Untuk mengetahui informasi selengkapnya, lihat Lokasi Eventarc.
FUNCTION dengan nama fungsi yang Anda deploy.
REGION dengan region Cloud Run fungsi.
PROJECT_NUMBER dengan Google Cloud nomor project Anda. Pemicu Eventarc ditautkan ke akun layanan untuk digunakan sebagai identitas saat memanggil fungsi Anda. Akun layanan pemicu Eventarc Anda harus memiliki izin untuk memanggil fungsi Anda. Secara default, Cloud Run menggunakan Akun layanan komputasi default.
Setiap tanda
event-filters
menentukan jenis peristiwa, dengan fungsi dipicu hanya jika peristiwa memenuhi semua kriteria yang ditentukan dalam tandaevent-filters
-nya. Setiap pemicu harus memiliki tandaevent-filters
yang menentukan jenis peristiwa yang didukung, seperti dokumen baru yang ditulis ke Firestore atau file yang diupload ke Cloud Storage. Anda tidak dapat mengubah jenis filter peristiwa setelah pembuatan. Untuk mengubah jenis filter peristiwa, Anda harus membuat pemicu baru dan menghapus pemicu lama. Secara opsional, Anda dapat mengulangi tanda--event-filters
dengan filter yang didukung dalam bentukATTRIBUTE=VALUE
untuk menambahkan lebih banyak filter.
Terraform
Untuk membuat pemicu Eventarc bagi fungsi Cloud Run, lihat Membuat pemicu menggunakan Terraform.
Contoh
Contoh berikut menjelaskan cara menggunakan peristiwa Firestore dalam Mode Native untuk memicu fungsi Cloud Run.
Contoh 1: Fungsi Hello Firestore
Contoh berikut mencetak kolom peristiwa Firestore yang memicu:
Node.js
Python
Go
Java
C#
Men-deploy fungsi
Untuk men-deploy fungsi Hello Firestore
, jalankan perintah berikut:
Jika Anda belum melakukannya, siapkan database Firestore.
Untuk men-deploy fungsi, lihat Membuat pemicu untuk fungsi.
Menguji fungsi
Untuk menguji fungsi Hello Firestore
, siapkan koleksi bernama
users
di database Firestore Anda:
Di konsol Google Cloud , buka halaman database Firestore:
Klik Mulai koleksi.
Tentukan
users
sebagai ID koleksi.Untuk mulai menambahkan dokumen pertama koleksi, di bagian Tambahkan dokumen pertamanya, terima ID Dokumen yang dihasilkan secara otomatis.
Tambahkan setidaknya satu kolom untuk dokumen, dengan menentukan nama dan nilai. Misalnya, di Nama kolom, masukkan
username
, dan di Nilai kolom, masukkanrowan
.Bila telah selesai, klik Simpan.
Tindakan ini akan membuat dokumen baru, sehingga memicu fungsi Anda.
Untuk mengonfirmasi bahwa fungsi Anda dipicu, klik nama fungsi tertaut di Google Cloud konsol halaman Ringkasan Cloud Run untuk membuka halaman Detail layanan.
Pilih tab Log, lalu cari string ini:
Function triggered by change to: //firestore.googleapis.com/projects/your-project-id/databases/(default)'
Contoh 2: Fungsi Mengonversi ke Huruf Besar
Contoh berikut mengambil nilai yang ditambahkan oleh pengguna, mengubah string di lokasi tersebut menjadi huruf besar, dan mengganti nilai dengan string huruf besar:
Node.js
Gunakan protobufjs untuk mendekode data peristiwa. Sertakan google.events.cloud.firestore.v1
data.proto
dalam sumber Anda.
Python
Go
Java
C#
Men-deploy fungsi
Untuk men-deploy fungsi Convert to Uppercase
, jalankan perintah berikut:
Jika Anda belum melakukannya, siapkan database Firestore.
Untuk men-deploy fungsi, lihat Membuat pemicu untuk fungsi.
Menguji fungsi
Untuk menguji fungsi Convert to Uppercase
yang baru saja Anda deploy, siapkan koleksi bernama messages
di database Firestore Anda:
Di konsol Google Cloud , buka halaman database Firestore:
Klik Mulai koleksi.
Tentukan
messages
sebagai ID koleksi.Untuk mulai menambahkan dokumen pertama koleksi, di bagian Tambahkan dokumen pertamanya, terima ID Dokumen yang dihasilkan secara otomatis.
Untuk memicu fungsi yang di-deploy, tambahkan dokumen dengan Nama kolom
original
dan Nilai kolomminka
.Saat menyimpan dokumen, Anda dapat melihat kata dalam huruf kecil di kolom nilai yang dikonversi menjadi huruf besar.
Jika kemudian Anda mengedit nilai kolom agar berisi huruf kecil, hal tersebut akan memicu fungsi lagi, dan mengonversi semua huruf kecil menjadi huruf besar.
Batasan untuk fungsi
- Pengurutan tidak dijamin. Perubahan cepat dapat memicu pemanggilan fungsi dalam urutan yang tidak terduga.
- Peristiwa dikirim setidaknya satu kali, tetapi satu peristiwa dapat menghasilkan beberapa pemanggilan fungsi. Hindari mengandalkan mekanisme tepat satu kali, dan tulis fungsi idempoten.
- Pemicu dikaitkan dengan satu database. Anda tidak dapat membuat pemicu yang cocok dengan beberapa database.
- Menghapus database tidak secara otomatis menghapus pemicu untuk database tersebut. Pemicu berhenti mengirim peristiwa, tetapi akan tetap ada sampai Anda menghapus pemicu.