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 log. Kebijakan pemberitahuan akan memberi tahu Anda saat hasil kueri memenuhi kondisi yang Anda tentukan. Misalnya, Anda dapat mengonfigurasi kebijakan pemberitahuan sehingga Anda akan diberi tahu saat setidaknya 25% entri log dalam periode tertentu memiliki tingkat keparahan ERROR.

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. Karena alasan ini, kueri SQL ini hanya dapat mengkueri tampilan log. Kueri ini tidak dapat mengkueri tampilan analisis.

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

Cara kerja kebijakan pemberitahuan

Kebijakan pemberitahuan menjelaskan situasi saat Anda ingin mendapatkan pemberitahuan dan cara Anda ingin mendapatkan notifikasi tentang insiden. Ada tiga pendekatan berbeda yang dapat Anda gunakan untuk mendapatkan notifikasi saat konten atau pola muncul dalam data log Anda:

  • Untuk memindai setiap entri log untuk menemukan frasa tertentu, buat kebijakan pemberitahuan berbasis log. Gunakan kebijakan pemberitahuan ini jika Anda ingin mendapatkan notifikasi tentang hal-hal seperti peristiwa terkait keamanan.

  • Untuk memantau peristiwa dalam data entri log, Anda dapat membuat metrik berbasis log, lalu membuat kebijakan pemberitahuan untuk memantau metrik tersebut. Jenis kebijakan pemberitahuan ini efektif jika Anda ingin memantau tren dalam data entri log dari waktu ke waktu. Namun, kebijakan ini tidak efektif jika Anda hanya mengharapkan beberapa peristiwa.

  • Untuk memantau analisis gabungan data entri log, gabungkan Observability Analytics dengan kebijakan pemberitahuan. Dalam skenario ini, Anda mengupgrade bucket log untuk menggunakan Observability Analytics dan membuat set data BigQuery tertaut untuk bucket log tersebut. Selanjutnya, Anda menggunakan Observability Analytics, yang mendukung kueri SQL, untuk mengkueri tampilan log di bucket log. Terakhir, Anda membuat kebijakan pemberitahuan untuk memantau hasil kueri SQL. Jenis kebijakan pemberitahuan ini disebut kebijakan pemberitahuan berbasis SQL.

Kebijakan pemberitahuan berbasis SQL paling efektif untuk mengevaluasi nilai pasti di beberapa entri log. Jika Anda ingin mengevaluasi setiap entri log, buat kebijakan pemberitahuan berbasis log.

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 situasi saat hasil kueri menyebabkan Monitoring membuat insiden.

  • Jadwal menentukan frekuensi kebijakan pemberitahuan menjalankan kuerinya. Jadwal ini 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 data 60 menit 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.

    Misalnya, Anda ingin mendapatkan notifikasi saat lebih dari 50 entri log dalam periode lihat balik memiliki tingkat keparahan lebih dari 200. Anda membuat kueri yang melaporkan entri log yang tingkat keparahannya lebih dari 200. Kemudian, Anda mengonfigurasi kondisi, memilih Batas jumlah baris, dan menetapkan batas ke 50.

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

    Misalnya, Anda ingin mendapatkan notifikasi saat lebih dari 25% entri log dalam periode lihat balik memiliki tingkat keparahan ERROR. Anda membuat kueri yang menghitung persentase entri log yang tingkat keparahannya adalah ERROR. Hasil kueri menulis true ke kolom notify saat persentase tersebut melebihi 25%. Selanjutnya, Anda membuat kondisi, menetapkan jenis ke Boolean, dan mengonfigurasi kondisi untuk memantau kolom notify.

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

Kebijakan pemberitahuan dan BigQuery

Agar kebijakan pemberitahuan dapat mengkueri data log Anda, Anda harus mengonfigurasi set data BigQuery tertaut . Set data tertaut memungkinkan BigQuery membaca data log 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.

Entri log yang dievaluasi

Agar entri log dapat dievaluasi oleh kueri SQL dari kebijakan pemberitahuan, kedua hal berikut harus benar:

  • _Stempel waktu diterima_ entri log, yang mencatat waktu entri log diterima oleh Cloud Logging, harus berada dalam periode lihat balik kebijakan pemberitahuan.
  • _Stempel waktu_ entri log, yang mencatat waktu entri log dibuat, harus berada dalam waktu 15 menit dari periode lihat balik.

Misalnya, kebijakan pemberitahuan berbasis SQL Anda memiliki periode lihat balik 60 menit. Observability Analytics menjalankan kueri SQL dari kebijakan pemberitahuan pada pukul 13.30. Agar disertakan dalam kueri, entri log harus cocok dengan kedua kriteria berikut:

  • Stempel waktu diterima harus antara pukul 12.30 dan 13.30.
  • Stempel waktu harus antara pukul 12.15 dan 13.45.

Saat Anda menjalankan kueri dari antarmuka Observability Analytics, semua entri log dalam rentang waktu yang dipilih akan dievaluasi berdasarkan stempel waktu entri log.

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 untuk 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, insiden dapat memerlukan waktu hingga dua menit tambahan untuk disebarkan melalui sistem.

Kegagalan kueri

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

  • Akun Layanan Monitoring tidak ada lagi atau tidak lagi memiliki izin yang diperlukan untuk membaca data log 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 telah mengupgrade bucket log untuk menggunakan Observability Analytics dan Anda dapat mengkueri serta melihat data log menggunakan halaman Observability Analytics. Bagian ini juga mengasumsikan bahwa Anda telah membuat set data BigQuery tertaut untuk bucket log Anda.

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

  1. Untuk mendapatkan izin yang diperlukan untuk membuat dan mengelola kebijakan pemberitahuan berbasis SQL, minta administrator untuk memberi Anda peran IAM berikut:

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

    1. Monitoring Service Agent (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 log Anda.

    Untuk mengetahui informasi selengkapnya tentang cara menulis kueri SQL untuk tampilan log, lihat Mengkueri tampilan log.

  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, 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 dijalankan 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 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 daftar lengkap batas yang terkait dengan kebijakan pemberitahuan, lihat Batas Monitoring.

Harga

Untuk mengetahui informasi tentang harga, lihat dokumen berikut:

Langkah berikutnya