Mengonfigurasi pemberitahuan untuk pemanggilan alur kerja yang gagal

Dokumen ini menunjukkan cara mengonfigurasi pemberitahuan berbasis log untuk pemanggilan alur kerja Dataform yang gagal menggunakan Logs Explorer.

Anda dapat menggunakan Cloud Monitoring untuk mengamati tren di log Cloud Logging untuk pemanggilan alur kerja Dataform dan untuk memberi tahu Anda saat kondisi yang Anda jelaskan terjadi.

Setiap pemanggilan alur kerja Dataform dicatat ke dalam log menggunakan Cloud Logging. Logging diaktifkan secara otomatis untuk pemanggilan alur kerja Dataform, yang dapat dikenai biaya penagihan Cloud Logging. Untuk mengetahui informasi selengkapnya, lihat Harga formulir data.

Untuk menerima pemberitahuan saat pemanggilan alur kerja Dataform gagal, Anda dapat membuat pemberitahuan berbasis log.

Anda dapat membuat pemberitahuan berbasis log dari halaman Logs Explorer di Konsol Google Cloud atau dengan menggunakan Monitoring API. Panduan ini menjelaskan cara membuat pemberitahuan berbasis log untuk kegagalan pemanggilan alur kerja Dataform menggunakan Logs Explorer.

Sebelum memulai

Untuk membuat dan mengelola notifikasi berbasis log, pastikan peran Identity and Access Management Anda menyertakan izin yang dijelaskan di Izin untuk pemberitahuan berbasis log.

Mengonfigurasi pemberitahuan berbasis log untuk pemanggilan alur kerja Dataform yang gagal

Guna mengonfigurasi pemberitahuan berbasis log untuk pemanggilan alur kerja Dataform yang gagal, ikuti langkah-langkah berikut:

  1. Di Konsol Google Cloud, pilih Logging, lalu pilih Logs Explorer:

    Buka Logs Explorer

  2. Di panel Query, pilih Show query dan masukkan kueri berikut:

        resource.type="dataform.googleapis.com/Repository"
    jsonPayload.@type="type.googleapis.com/google.cloud.dataform.logging.v1.WorkflowInvocationCompletionLogEntry"
    jsonPayload.terminalState="FAILED"

    Kueri ini akan memberi tahu Anda tentang semua pemanggilan alur kerja Dataform yang gagal.

    1. Opsional: Untuk memfilter pemanggilan alur kerja yang gagal berdasarkan konfigurasi rilis, tambahkan baris berikut ke kueri:

      jsonPayload.releaseConfigId="RELEASE_CONFIGURATION_ID"

    2. Opsional: Untuk memfilter pemanggilan alur kerja yang gagal berdasarkan konfigurasi alur kerja, tambahkan kode berikut ke kueri:

      jsonPayload.workflowConfigId="WORKFLOW_CONFIGURATION_ID"

    Kueri berikut memperingatkan saat pemanggilan alur kerja Dataform yang terkait dengan konfigurasi rilis daily dan konfigurasi alur kerja production gagal:

     resource.type="dataform.googleapis.com/Repository"
 jsonPayload.@type="type.googleapis.com/google.cloud.dataform.logging.v1.WorkflowInvocationCompletionLogEntry"
 jsonPayload.terminalState="FAILED"
 jsonPayload.releaseConfigId="daily"
 jsonPayload.workflowConfigId="production"

  3. Opsional: Gunakan Run query di panel Query results untuk memvalidasi kueri.

  4. Di header panel Query results, klik Create alert. Jika jendela Anda sempit, opsi Buat pemberitahuan mungkin muncul di menu Tindakan.

  5. Di panel Alert details, beri nama dan deskripsi notifikasi:

    1. Masukkan nama untuk notifikasi Anda di kolom Nama Notifikasi. Misalnya: "Dataform: alur kerja kegagalan".

    2. Masukkan deskripsi notifikasi ini. Anda juga dapat menyertakan informasi yang dapat membantu penerima notifikasi mendiagnosis masalah. String berikut meringkas alasan pemberitahuan:

      Log-based alert in project ${project} detected a failed Dataform workflow.

      Untuk mengetahui informasi tentang cara memformat dan menyesuaikan konten kolom ini, lihat Menggunakan Markdown dan variabel dalam template dokumentasi.

  6. Untuk melanjutkan ke langkah berikutnya, klik Berikutnya.

  7. Di panel Choose logs to include in the alert, periksa kueri dan hasilnya dengan mengklik Preview logs.

    Sebaiknya build kueri di panel Query Logs Explorer. Kueri yang Anda build di panel Query juga akan ditampilkan di panel ini.

    Anda dapat mengedit kueri di panel ini, jika perlu. Jika Anda mengedit kueri, periksa hasilnya dengan mengklik Preview logs.

  8. Klik Next.

  9. Pilih waktu minimum antar-notifikasi. Nilai ini memungkinkan Anda mengontrol jumlah notifikasi yang diterima dari pemberitahuan ini jika dipicu beberapa kali. Untuk contoh ini, pilih 5 min dari opsi.

  10. Opsional: Pilih durasi penutupan otomatis insiden. Secara default, durasi tutup otomatis insiden ditetapkan ke 7 hari.

  11. Klik Next.

  12. Pilih satu atau beberapa saluran notifikasi untuk pemberitahuan Anda. Untuk contoh ini, pilih saluran notifikasi email.

    Jika sudah mengonfigurasi saluran notifikasi email, Anda dapat memilihnya dari daftar. Jika belum, klik Manage notifikasi channels dan tambahkan saluran email. Untuk informasi tentang pembuatan saluran notifikasi, lihat Mengelola saluran notifikasi.

  13. Klik Simpan.

Notifikasi berbasis log Anda kini siap diuji. Untuk mengetahui petunjuk pengujian pemberitahuan, lihat Menguji contoh pemberitahuan berbasis log.

Langkah selanjutnya