Memantau hasil kueri SQL dengan kebijakan pemberitahuan

Dokumen ini menjelaskan cara membuat kebijakan pemberitahuan untuk memantau hasil kueri yang Anda jalankan di Observability Analytics. Kueri ini ditulis dalam SQL dan harus mengkueri tampilan observabilitas bernama _AllSpans. Kebijakan pemberitahuan akan memberi tahu Anda saat hasil kueri memenuhi kondisi yang Anda tentukan.

Kebijakan pemberitahuan yang Anda buat dari halaman Observability Analytics berjalan di mesin BigQuery. Oleh karena itu, data yang dikueri harus dapat diakses melalui set data BigQuery tertaut.

Untuk mengetahui informasi umum tentang Observability Analytics, lihat Mengkueri dan menganalisis trace dengan Observability Analytics.

Cara kerja kebijakan pemberitahuan

Kebijakan pemberitahuan menjelaskan kondisi yang mensyaratkan pelaksanaan tindakan tersebut dan cara Anda ingin mendapatkan notifikasi tentang insiden. Ada beberapa pendekatan berbeda yang dapat Anda gunakan untuk mendapatkan notifikasi saat konten atau pola muncul dalam data trace Anda:

  • Untuk memantau jumlah rentang Cloud Trace yang diserap per bulan, penggunaan kuota, dan rasio penyerapan rentang, buat kebijakan pemberitahuan di Cloud Monitoring. Jika Anda belum pernah membuat kebijakan pemberitahuan, lihat Membuat kebijakan pemberitahuan untuk mengetahui informasi mendetail tentang penggunaan konsol Cloud Monitoring.

  • Untuk melihat atau menjelajahi trace atau rentang individual, atau melihat atribut yang dilampirkan ke rentang, gunakan halaman Trace Explorer. Untuk mengetahui informasi tentang halaman tersebut, lihat Menemukan dan menjelajahi trace.

  • Untuk memantau analisis gabungan data trace Anda, gabungkan Observability Analytics dengan kebijakan pemberitahuan. Dalam skenario ini, Anda menggunakan kueri SQL untuk mengkueri tampilan _AllSpans di bucket observabilitas bernama _Trace. Terakhir, Anda membuat kebijakan pemberitahuan untuk memantau hasil kueri SQL. Jenis kebijakan pemberitahuan ini disebut kebijakan pemberitahuan berbasis SQL.

    Untuk mempelajari lebih lanjut cara data trace Anda disimpan, lihat Ringkasan penyimpanan.

    Bagian selanjutnya dari dokumen ini menjelaskan cara menggunakan kebijakan pemberitahuan berbasis SQL.

Komponen kebijakan pemberitahuan

Kebijakan pemberitahuan berbasis SQL berisi kondisi dan jadwal:

  • Kondisi berisi kueri, yang merupakan kueri SQL yang mengkueri data Anda. Kondisi ini juga menentukan kondisi yang menyebabkan hasil kueri membuat Monitoring membuat insiden.

  • Jadwal menentukan frekuensi kebijakan pemberitahuan menjalankan kuerinya. Jadwal juga menentukan ukuran periode lihat balik, yang merupakan filter yang hanya memilih data yang telah diterima sejak terakhir kali kueri dievaluasi. Misalnya, jika Anda menetapkan jadwal ke 60 menit, kueri akan dijalankan setiap 60 menit menggunakan periode lihat balik yang memilih 60 menit data terbaru.

Kebijakan pemberitahuan juga berisi daftar saluran notifikasi. Saat kondisi kebijakan pemberitahuan terpenuhi, Cloud Monitoring akan membuat insiden, lalu mengirim notifikasi tentang insiden tersebut melalui saluran ini. Insiden adalah catatan data yang menyebabkan kondisi terpenuhi beserta informasi relevan lainnya. Informasi ini dapat membantu Anda memecahkan masalah yang menyebabkan insiden. Anda dapat melihat insiden menggunakan Google Cloud konsol.

Jenis evaluasi untuk kebijakan pemberitahuan berbasis SQL

Kondisi yang memantau hasil kueri SQL mendukung dua jenis evaluasi:

  • Batas jumlah baris: Kondisi terpenuhi saat jumlah baris dalam hasil kueri lebih besar dari, sama dengan, atau kurang dari nilai batas.

  • Boolean: Kondisi terpenuhi saat kolom boolean tertentu dalam tabel hasil kueri berisi baris dengan nilai true.

Kebijakan pemberitahuan yang memantau hasil kueri SQL hanya boleh memiliki satu kondisi.

Kebijakan pemberitahuan dan BigQuery

Agar kebijakan pemberitahuan dapat mengkueri data trace Anda, Anda harus mengonfigurasi set data BigQuery tertaut . Set data tertaut memungkinkan BigQuery membaca data trace Anda, dan memungkinkan Anda menjalankan fungsi BigQuery pada data yang ditampilkan oleh kueri SQL Anda.

Saat kebijakan pemberitahuan menjalankan kueri SQL, kueri tersebut dijalankan di mesin BigQuery di Google Cloud project tempat kebijakan pemberitahuan ditentukan. Secara default, kueri yang berjalan di mesin BigQuery menggunakan slot sesuai permintaan. Slot sesuai permintaan dan slot yang dipesan tunduk pada harga BigQuery.

Anda juga dapat memilih untuk mengonfigurasi reservasi slot BigQuery khusus untuk project Anda:

  1. Buat reservasi dengan slot khusus atau identifikasi reservasi yang ada.
  2. Buat penetapan reservasi untuk project Anda.

Periode lihat balik dan waktu propagasi insiden

Saat kebijakan pemberitahuan dijadwalkan untuk mengevaluasi kondisinya, Observability Analytics akan menunda eksekusi kueri SQL selama lima menit untuk memberi waktu bagi Cloud Logging mengindeks data yang diterima selama periode lihat balik. Misalnya, jika kebijakan pemberitahuan menggunakan periode lihat balik yang berakhir pada pukul 14.00, Observability Analytics tidak akan menjalankan kueri SQL hingga pukul 14.05.

Jika kondisi pemberitahuan terpenuhi setelah kueri dijalankan, propagasi insiden melalui sistem dapat memerlukan waktu hingga dua menit tambahan.

Kegagalan kueri

Kueri yang dikeluarkan oleh kebijakan pemberitahuan berbasis SQL dapat gagal karena berbagai alasan, termasuk hal berikut:

  • Akun Layanan Monitoring tidak ada lagi atau tidak lagi memiliki izin yang diperlukan untuk membaca data trace yang dikueri.

  • Waktu eksekusi kueri melebihi lima menit.

  • Terjadi error internal.

Kueri yang gagal akan menghasilkan entri log yang berisi ID kebijakan pemberitahuan dan status error. Anda dapat menggunakan kebijakan pemberitahuan berbasis log untuk membuat pemberitahuan saat error dicatat ke dalam log.

Sebelum memulai

Bagian ini mengasumsikan bahwa Anda memiliki set data BigQuery tertali untuk data trace Anda.

Sebelum membuat kebijakan pemberitahuan berbasis SQL, selesaikan langkah-langkah berikut:

  1. Untuk mendapatkan izin yang Anda perlukan guna mengkueri data trace dan membuat kebijakan pemberitahuan berbasis SQL, minta administrator Anda untuk memberi Anda peran IAM berikut di project Anda:

  2. Pastikan Akun Layanan Monitoring ada dan memiliki peran berikut:

    1. Agen Layanan Monitoring (roles/monitoring.notificationServiceAgent) di project Anda.
    2. BigQuery Data Viewer (roles/bigquery.dataViewer) di set data tertaut Anda.

    Jika Akun Layanan Monitoring tidak ada, lihat Memecahkan masalah: Tidak ada Akun Layanan Monitoring.

  3. Konfigurasi saluran notifikasi yang ingin Anda gunakan untuk menerima notifikasi insiden. Untuk tujuan redundansi, sebaiknya buat beberapa jenis saluran notifikasi. Untuk mengetahui informasi selengkapnya, lihat Membuat dan mengelola saluran notifikasi.

Membuat kebijakan pemberitahuan berbasis SQL

Untuk membuat kebijakan pemberitahuan berbasis SQL, lakukan langkah berikut:

Konsol

  1. Di Google Cloud konsol, buka halaman Observability Analytics:

    Buka Observability Analytics

    Jika Anda menggunakan kotak penelusuran untuk menemukan halaman ini, pilih hasil yang subjudulnya adalah Logging.

  2. Di halaman Observability Analytics, di editor kueri, masukkan kueri SQL yang mengkueri data trace Anda.

  3. Di toolbar, klik Run on BigQuery.

    Observability Analytics menjalankan kueri Anda di mesin BigQuery dan menampilkan hasilnya di tabel Results.

    Jika Run on BigQuery tidak ditampilkan, klik Select query engine lalu klik BigQuery. Tombol Run query akan berubah menjadi Run on BigQuery.

  4. Di tabel Results pada halaman Observability Analytics, klik  Create alert.

    Halaman Observability Analytics menampilkan jendela Create sql alert policy, yang menampilkan kueri Anda di bagian SQL query.

  5. Di bagian Alert condition , konfigurasi kondisi dan jadwal kebijakan pemberitahuan Anda.

  6. Konfigurasi detail pemberitahuan kebijakan pemberitahuan Anda.

    1. Tambahkan saluran notifikasi dan konfigurasi konten notifikasi, seperti baris subjek kustom.

    2. Opsional: Tambahkan label kebijakan pemberitahuan dan dokumentasi.

    3. Klik Next.

  7. Tinjau kebijakan pemberitahuan Anda, lalu buat dengan mengklik Save.

Terraform

  1. Instal dan konfigurasi Terraform untuk project Anda. Untuk konfigurasi App Hub, pilih project host App Hub atau project pengelolaan.

  2. Di Cloud Shell, buka direktori yang berisi konfigurasi Terraform Anda.

  3. Dalam konfigurasi Terraform Anda, konfigurasi instance resource google_monitoring_alert_policy, termasuk condition_sql.

  4. Di Cloud Shell, masukkan terraform apply.

Untuk mengubah kebijakan pemberitahuan Anda, lakukan pengeditan, lalu terapkan kembali konfigurasi Terraform. Untuk mengetahui informasi selengkapnya, lihat Mengelola kebijakan pemberitahuan dengan Terraform.

Untuk mengetahui informasi umum tentang penggunaan Google Cloud dengan Terraform, lihat Terraform dengan Google Cloud.

REST

Gunakan alertPolicies.create metode untuk membuat kebijakan pemberitahuan secara terprogram. Jenis Condition kebijakan pemberitahuan Anda harus berupa MonitoringQueryLanguageCondition, yang merupakan instance SqlCondition. Jenis kondisi ini memungkinkan kondisi kebijakan pemberitahuan Anda ditentukan dengan SQL.

Untuk menentukan jadwal, tetapkan nilai periodicity untuk salah satu kolom minutes, hours, atau days. Misalnya, jika Anda ingin kueri berjalan setiap 12 jam, tetapkan periodisitas kolom hours ke 12.

Untuk menentukan kondisi, gunakan kolom berikut:

  • boolean_test: Mengonfigurasi kebijakan pemberitahuan sehingga kondisinya terpenuhi saat baris kolom boolean dalam tabel hasil kueri berisi nilai benar.
  • row_count_test: Mengonfigurasi kebijakan pemberitahuan sehingga kondisinya terpenuhi saat jumlah baris dalam tabel hasil kueri memenuhi batas tertentu.

Untuk mengetahui daftar lengkap kolom dan definisi, lihat SqlCondition dalam dokumentasi Cloud Monitoring API.

Untuk mengetahui informasi selengkapnya tentang Monitoring API untuk kebijakan pemberitahuan, lihat Mengelola kebijakan pemberitahuan berdasarkan API.

Batasan

  • Anda dapat memiliki satu kondisi per kebijakan pemberitahuan berbasis SQL.
  • Kebijakan pemberitahuan berbasis SQL tidak dapat mengkueri tampilan analisis.

  • Kueri yang dikeluarkan oleh kebijakan pemberitahuan berbasis SQL akan gagal jika waktu eksekusinya melebihi lima menit.

  • Ada penundaan hingga tujuh menit, ditambah waktu eksekusi kueri, antara saat kueri dijadwalkan dan saat insiden dibuat.

Untuk mengetahui daftar lengkap batas yang terkait dengan kebijakan pemberitahuan, lihat Batas Monitoring.

Langkah berikutnya