Merutekan peristiwa Firebase Alerts ke Cloud Run

Pemicu Eventarc mendeklarasikan minat Anda pada peristiwa atau kumpulan peristiwa tertentu. Anda dapat mengonfigurasi perutean peristiwa dengan menentukan filter untuk pemicu, termasuk sumber peristiwa, dan layanan Cloud Run target.

Eventarc mengirimkan peristiwa ke penerima peristiwa dalam format CloudEvents melalui permintaan HTTP.

Petunjuk ini menunjukkan cara mengonfigurasi perutean peristiwa ke layanan Cloud Run yang dipicu oleh peristiwaFirebase Alerts langsung. Untuk detail selengkapnya, lihat daftar peristiwa langsung yang didukung.

Bersiap untuk membuat pemicu

Sebelum Anda membuat pemicu, selesaikan prasyarat ini:

Konsol

  1. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat Google Cloud project.

    Buka pemilih project

  2. Aktifkan Cloud Logging, Eventarc, dan Eventarc Publishing API.

    Mengaktifkan API

  3. Jika memungkinkan, aktifkan API yang terkait dengan peristiwa langsung. Misalnya, untuk Firebase Alerts peristiwa, aktifkan Firebase Alerts API.

  4. Jika Anda belum memilikinya, buat akun layanan yang dikelola pengguna, lalu berikan peran dan izin yang diperlukan agar Eventarc dapat mengelola peristiwa untuk layanan target Anda.

    1. Di konsol Google Cloud, buka halaman Create service account.

      Buka Buat akun layanan

    2. Pilih project Anda.

    3. Di kolom Nama akun layanan, masukkan nama. Konsol Google Cloud akan mengisi kolom ID akun layanan berdasarkan nama ini.

      Di kolom Deskripsi akun layanan, masukkan sebuah deskripsi. Contoh, Service account for event trigger.

    4. Klik Buat dan lanjutkan.

    5. Untuk memberikan akses yang sesuai, dalam daftar Select a role, pilih peran Identity and Access Management (IAM) yang diperlukan yang akan diberikan ke akun layanan Anda untuk pemanggilan yang diautentikasi atau tidak diautentikasi. Untuk mengetahui informasi selengkapnya, lihat Peran dan izin untuk target Cloud Run.

      Untuk peran tambahan, klik Tambahkan peran lain, lalu tambahkan setiap peran tambahan.

    6. Klik Lanjutkan.

    7. Untuk menyelesaikan pembuatan akun, klik Selesai.

gcloud

  1. In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  2. Aktifkan Cloud Logging, Eventarc, dan Eventarc Publishing API.

    gcloud services enable logging.googleapis.com \
      eventarc.googleapis.com \
      eventarcpublishing.googleapis.com

  3. Jika memungkinkan, aktifkan API yang terkait dengan peristiwa langsung. Misalnya, untuk Firebase Alerts peristiwa, aktifkan firestore.googleapis.com.

  4. Jika Anda belum memilikinya, buat akun layanan yang dikelola pengguna, lalu berikan peran dan izin yang diperlukan agar Eventarc dapat mengelola peristiwa untuk layanan target Anda.

    1. Buat akun layanan:

      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

      Ganti SERVICE_ACCOUNT_NAME dengan nama akun layanan. Panjangnya harus antara 6 hingga 30 karakter, serta dapat berisi karakter alfanumerik huruf kecil dan tanda hubung. Setelah membuat akun layanan, Anda tidak dapat mengubah namanya.

    2. Berikan peran atau izin Identity and Access Management (IAM) yang diperlukan untuk pemanggilan yang diautentikasi atau tidak diautentikasi. Untuk mengetahui informasi selengkapnya, lihat Peran dan izin untuk target Cloud Run.

Buat pemicu

Anda dapat membuat pemicu Eventarc menggunakan Google Cloud CLI atau melalui Konsol Google Cloud.

Konsol

  1. Di Konsol Google Cloud, buka halaman Triggers Eventarc.

    Buka Pemicu

  2. Klik Create trigger.
  3. Ketik Nama pemicu.

    Ini adalah ID pemicu dan harus diawali dengan huruf. Kolom ini dapat berisi hingga 63 huruf kecil, angka, atau tanda hubung.

  4. Untuk Jenis pemicu, pilih Sumber Google.
  5. Dalam daftar Event provider, pilih Firebase Alerts.

    Perhatikan bahwa nama penyedia peristiwa yang digunakan dalam Google Cloud dokumentasi terkait mungkin tidak memiliki awalan Cloud atau Google Cloud. Misalnya, di konsol, Memorystore for Redis disebut sebagai Google Cloud Memorystore for Redis.

  6. Dalam daftar Event type, dari peristiwa Direct, pilih jenis peristiwa.
  7. Untuk menentukan encoding payload peristiwa, dalam daftar Jenis konten data peristiwa, pilih application/json atau application/protobuf.

    Perhatikan bahwa payload peristiwa yang diformat dalam JSON lebih besar dari yang diformat dalam Protobuf. Hal ini dapat memengaruhi keandalan, bergantung pada tujuan peristiwa Anda dan batasnya pada ukuran peristiwa. Untuk mengetahui informasi selengkapnya, lihat Masalah umum.

  8. Dalam daftar Region, pilih global (Global).

    Untuk mengetahui informasi selengkapnya, lihat Lokasi Eventarc.

  9. Di kolom Atribut 1, ID resource alerttype berfungsi sebagai filter peristiwa. Pilih operator untuk filter ini:
  10. Di kolom Nilai atribut 1, masukkan salah satu opsi berikut:
    • appDistribution.inAppFeedback: peristiwa dikirim saat penguji mengirimkan masukan dalam aplikasi untuk aplikasi tertentu
    • appDistribution.newTesterIosDevice: peristiwa dikirim saat perangkat penguji iOS baru didaftarkan untuk aplikasi tertentu
    • billing.planAutomatedUpdate: peristiwa dikirim saat paket penagihan untuk project Firebase diperbarui secara otomatis; misalnya, saat paket didowngrade karena masalah pembayaran
    • billing.planUpdate: peristiwa dikirim saat paket penagihan untuk project Firebase diubah oleh pengguna; misalnya, saat akun penagihan dikaitkan ke atau dilepaskan dari project
    • crashlytics.missingSymbolFile: peristiwa dikirim saat Firebase Crashlytics menyimpulkan bahwa peristiwa tersebut tidak memiliki simbol debug yang sesuai untuk menyimbolkan laporan error yang masuk
    • crashlytics.newAnrIssue: peristiwa dikirim saat aplikasi mengalami error aplikasi baru tidak merespons (ANR) (bukan untuk peristiwa identik berikutnya)
    • crashlytics.newFatalIssue: peristiwa dikirim saat aplikasi mengalami error fatal baru (bukan untuk peristiwa identik berikutnya)
    • crashlytics.newNonfatalIssue: peristiwa dikirim saat aplikasi mengalami error non-fatal baru (bukan untuk peristiwa identik berikutnya)
    • crashlytics.regression: peristiwa dikirim saat aplikasi mengalami error untuk masalah yang ditandai sebagai ditutup untuk versi aplikasi sebelumnya
    • crashlytics.stabilityDigest: peristiwa dikirim saat ada notifikasi tentang masalah trending teratas di Crashlytics
    • crashlytics.velocity: peristiwa dikirim saat satu masalah menyebabkan sejumlah besar sesi aplikasi mengalami error
    • performance.threshold: peristiwa dikirim saat performa metrik melewati nilai minimum yang ditetapkan
  11. Secara opsional, Anda dapat memfilter peristiwa untuk ID Aplikasi Firebase tertentu. Klik Tambahkan filter, lalu tentukan appid.
  12. Pilih Service account yang akan memanggil layanan atau alur kerja Anda.

    Atau, Anda dapat membuat akun layanan baru.

    Tindakan ini menentukan email akun layanan Identity and Access Management (IAM) yang terkait dengan pemicu dan tempat Anda sebelumnya memberikan peran tertentu yang diperlukan oleh Eventarc.

  13. Dalam daftar Event destination, pilih Cloud Run.
  14. Pilih layanan.

    Ini adalah nama layanan yang menerima peristiwa untuk pemicu. Layanan harus berada dalam project yang sama dengan pemicu dan akan menerima peristiwa sebagai permintaan POST HTTP yang dikirim ke jalur URL root-nya (/), setiap kali peristiwa dibuat.

  15. Anda juga dapat menentukan Jalur URL layanan sebagai tujuan pengiriman permintaan masuk.

    Ini adalah jalur relatif pada layanan tujuan tempat peristiwa untuk pemicu harus dikirim. Contoh: /, /route, route, route/subroute.

  16. Jika ingin, untuk menambahkan label, Anda dapat mengklik Tambahkan label. Label adalah key-value pair yang membantu Anda mengatur Google Cloud resource. Untuk mengetahui informasi selengkapnya, lihat Apa yang dimaksud dengan label?
  17. Klik Buat.
  18. Setelah pemicu dibuat, filter sumber peristiwa tidak dapat diubah. Sebagai gantinya, buat pemicu baru dan hapus yang lama. Untuk mengetahui informasi selengkapnya, lihat Mengelola pemicu.

gcloud

Anda dapat membuat pemicu dengan menjalankan perintah gcloud eventarc triggers create beserta flag wajib dan opsional.

gcloud eventarc triggers create TRIGGER \
    --location=global \
    --destination-run-service=DESTINATION_RUN_SERVICE \
    --destination-run-region=DESTINATION_RUN_REGION \
    --event-filters="type=google.firebase.firebasealerts.alerts.v1.published" \
    --event-filters="alerttype=ALERT_TYPE" \
    --event-data-content-type="EVENT_DATA_CONTENT_TYPE" \
    --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com"

Ganti kode berikut:

  • TRIGGER: ID pemicu atau ID yang sepenuhnya memenuhi syarat.
  • DESTINATION_RUN_SERVICE: nama layanan Cloud Run yang menerima peristiwa untuk pemicu. Layanan dapat berada di salah satu lokasi yang didukung Cloud Run dan tidak harus berada di lokasi yang sama dengan pemicu. Namun, layanan harus berada dalam project yang sama dengan pemicu dan akan menerima peristiwa sebagai permintaan POST HTTP yang dikirim ke jalur URL root-nya (/), setiap kali peristiwa dibuat.
  • DESTINATION_RUN_REGION: (opsional) region tempat layanan Cloud Run tujuan dapat ditemukan. Jika tidak ditentukan, layanan diasumsikan bahwa layanan berada di region yang sama dengan pemicu.
  • ALERT_TYPE: jenis pemberitahuan Firebase dan dapat berupa salah satu nilai berikut:
    • appDistribution.inAppFeedback: peristiwa dikirim saat penguji mengirimkan masukan dalam aplikasi untuk aplikasi tertentu
    • appDistribution.newTesterIosDevice: peristiwa dikirim saat perangkat penguji iOS baru didaftarkan untuk aplikasi tertentu
    • billing.planAutomatedUpdate: peristiwa dikirim saat paket penagihan untuk project Firebase diperbarui secara otomatis; misalnya, saat paket didowngrade karena masalah pembayaran
    • billing.planUpdate: peristiwa dikirim saat paket penagihan untuk project Firebase diubah oleh pengguna; misalnya, saat akun penagihan dikaitkan ke atau dilepaskan dari project
    • crashlytics.missingSymbolFile: peristiwa dikirim saat Firebase Crashlytics menyimpulkan bahwa peristiwa tersebut tidak memiliki simbol debug yang sesuai untuk menyimbolkan laporan error yang masuk
    • crashlytics.newAnrIssue: peristiwa dikirim saat aplikasi mengalami error aplikasi baru tidak merespons (ANR) (bukan untuk peristiwa identik berikutnya)
    • crashlytics.newFatalIssue: peristiwa dikirim saat aplikasi mengalami error fatal baru (bukan untuk peristiwa identik berikutnya)
    • crashlytics.newNonfatalIssue: peristiwa dikirim saat aplikasi mengalami error non-fatal baru (bukan untuk peristiwa identik berikutnya)
    • crashlytics.regression: peristiwa dikirim saat aplikasi mengalami error untuk masalah yang ditandai sebagai ditutup untuk versi aplikasi sebelumnya
    • crashlytics.stabilityDigest: peristiwa dikirim saat ada notifikasi tentang masalah trending teratas di Crashlytics
    • crashlytics.velocity: peristiwa dikirim saat satu masalah menyebabkan sejumlah besar sesi aplikasi mengalami error
    • performance.threshold: peristiwa dikirim saat performa metrik melewati nilai minimum yang ditetapkan
    Operator untuk ALERT_TYPE harus berupa salah satu dari yang berikut:
    • Sama; misalnya, --event-filters="alerttype=appDistribution.inAppFeedback"
    • Pola jalur; misalnya, --event-filters-path-pattern="alerttype=appDistribution.*" atau --event-filters-path-pattern="alerttype=crashlytics.new*".

      Untuk mengetahui informasi selengkapnya, lihat Memahami pola jalur.

  • EVENT_DATA_CONTENT_TYPE: (opsional) encoding payload peristiwa. ID ini dapat berupa application/json atau application/protobuf. Encoding default-nya adalah application/json.

    Perhatikan bahwa payload peristiwa yang diformat dalam JSON lebih besar dari yang diformat dalam Protobuf. Hal ini dapat memengaruhi keandalan, bergantung pada tujuan peristiwa Anda dan batas ukuran peristiwa. Untuk mengetahui informasi selengkapnya, lihat Masalah umum.

  • SERVICE_ACCOUNT_NAME: nama akun layanan yang dikelola pengguna.
  • PROJECT_ID: Google Cloud Project ID Anda.

Catatan:

  • Flag --location harus global. Untuk mengetahui informasi selengkapnya, lihat Lokasi Eventarc.
  • Tanda berikut diperlukan:

    • --event-filters="type=google.firebase.firebasealerts.alerts.v1.published"
    • --event-filters="alerttype=ALERT_TYPE" atau --event-filters-path-pattern="alerttype=ALERT_TYPE"
  • Secara opsional, Anda dapat memfilter peristiwa untuk ID Aplikasi Firebase tertentu menggunakan tanda --event-filters="appid=APP_ID" dan dengan menentukan pencocokan persis.

  • Setelah pemicu dibuat, jenis filter peristiwa tidak dapat diubah. Untuk jenis peristiwa yang berbeda, Anda harus membuat pemicu baru.
  • Tanda --service-account digunakan untuk menentukan email akun layanan Identity and Access Management (IAM) yang terkait dengan pemicu tersebut.
  • Secara opsional, tentukan jalur relatif di layanan Cloud Run tujuan tempat peristiwa untuk pemicu harus dikirim menggunakan tanda --destination-run-path.

Contoh:

gcloud eventarc triggers create helloworld-trigger \
    --location=global \
    --destination-run-service=helloworld-events \
    --destination-run-region=us-central1 \
    --event-filters="type=google.firebase.firebasealerts.alerts.v1.published" \
    --event-filters="alerttype=crashlytics.velocity" \
    --service-account=${SERVICE_ACCOUNT_NAME}@${PROJECT_ID}.iam.gserviceaccount.com

Perintah ini akan membuat pemicu yang disebut helloworld-trigger untuk peristiwa yang diidentifikasi sebagai google.firebase.firebasealerts.alerts.v1.published, dan untuk jenis pemberitahuan crashlytics.velocity.

Terraform

Anda dapat membuat pemicu untuk tujuan Cloud Run menggunakan Terraform. Untuk mengetahui detailnya, baca Membuat pemicu menggunakan Terraform.

Membuat daftar pemicu

Anda dapat mengonfirmasi pembuatan pemicu dengan mencantumkan pemicu Eventarc menggunakan Google Cloud CLI atau melalui Konsol Google Cloud.

Konsol

  1. Di Konsol Google Cloud, buka halaman Triggers Eventarc.

    Buka Pemicu

    Halaman ini mencantumkan pemicu Anda di semua lokasi, dan menyertakan detail seperti nama, wilayah, penyedia peristiwa, tujuan, dan lainnya.

  2. Untuk memfilter pemicu:

    1. Klik Filter atau kolom Pemicu filter.
    2. Di daftar Properti, pilih opsi untuk memfilter pemicu.

    Anda dapat memilih satu properti atau menggunakan operator logika OR untuk menambahkan lebih banyak properti.

  3. Untuk mengurutkan pemicu, di samping judul kolom yang didukung, klik Urutkan.

gcloud

Jalankan perintah berikut untuk membuat daftar pemicu:

gcloud eventarc triggers list --location=-

Perintah ini mencantumkan pemicu Anda di semua lokasi, dan menyertakan detail seperti nama, jenis, tujuan, dan status.

Langkah berikutnya