Menyiapkan peringatan dan notifikasi

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Dokumentasi Apigee Edge.

Salah satu tujuan utama Pemantauan API adalah untuk terus memberi Anda informasi peristiwa atau pola yang tidak biasa, misalnya lonjakan traffic atau latensi. Untuk melacak peristiwa seperti ini, Anda dapat siapkan pemberitahuan, yang dipicu saat terjadi peristiwa tertentu. Peristiwa sebenarnya yang memicu pemberitahuan disebut insiden.

Anda dapat menetapkan aturan khusus untuk notifikasi, misalnya mungkin dipicu oleh kode respons 500 (Error Layanan Internal) pada {i>proxy<i}. Saat insiden untuk pemberitahuan terjadi, Anda dapat melihat detailnya di panel Insiden pada halaman Alerting Konsol Google Cloud.

Catatan: Anda menyiapkan pemberitahuan dan notifikasi di Konsol Google Cloud, bukan UI Pemantauan API. Lihat Pengantar pemberitahuan untuk mengetahui informasi selengkapnya tentang cara membuat pemberitahuan di Konsol Google Cloud.

Catatan: Untuk menyiapkan saluran pemberitahuan dan notifikasi, Anda memerlukan yang akan diberi peran berikut:

• roles/monitoring.alertPolicyEditor
• roles/monitoring.notificationChannelEditor

Lihat Peran Apigee.

Jika Anda ingin diberi tahu saat adanya peringatan tertentu dipicu, Anda dapat menyiapkan notifikasi untuk pemberitahuan. Saat terjadi insiden, Apigee mengirimkan Anda pemberitahuan yang berisi ringkasan peristiwa, termasuk link ke konsol Google Cloud dan UI Apigee untuk penyelidikan lebih lanjut.

Ada dua jenis pemberitahuan dalam Pemantauan API:

• Pemberitahuan berbasis metrik, yang dipicu oleh perubahan dalam Metrik API.
• Pemberitahuan berbasis log, yang didasarkan pada data API yang disimpan oleh Cloud Logging.

Pemberitahuan berbasis metrik

Notifikasi berbasis metrik dipicu saat metrik untuk data API mencapai tingkat yang ditentukan, atau mulai berubah dengan cepat. Anda menentukan aturan pemberitahuan menggunakan dua properti utama:

• Metrik: Jumlah yang memicu pemberitahuan, misalnya, jumlah permintaan.
• Nilai minimum: Tingkat yang harus dicapai metrik untuk memicu pemberitahuan.

Bagian berikut memberikan contoh pemberitahuan berbasis metrik.

Notifikasi untuk kode respons 500 pada proxy

Contoh berikutnya akan membuat pemberitahuan saat kode respons 500 (Error Server Internal) akan dikembalikan. Anda dapat membuat pemberitahuan yang serupa untuk kode respons apa pun.

Untuk membuat pemberitahuan, mulailah dengan melakukan langkah-langkah berikut:

1. Buka Halaman Buat kebijakan pemberitahuan di Konsol Google Cloud.

2. Klik Pilih Metrik.
3. Batalkan pilihan tombol Active.

   Catatan: Jika tidak ada data traffic API terbaru di organisasi Anda, metrik pada langkah berikutnya tidak akan ditampilkan kecuali jika opsi ini tidak dipilih.

4. Pilih metrik sebagai berikut:
   1. Jika Anda menggunakan Apigee Hybrid v1.12. salin dan tempel teks berikut di kolom Pilih metrik:

      apigee.googleapis.com/proxy/response_count

      Catatan: Jika Anda menggunakan Apigee hybrid v1.10 atau v1.11, gunakan metrik berikut:

      apigee.googleapis.com/proxyv2/response_count

   2. Pilih Apigee Proxy.
   3. Di panel yang terbuka di sebelah kanan, pilih Proxy.
   4. Di panel sebelah kanan, pilih Apigee proxy response count.
   5. Klik Terapkan.
5. Tambahkan filter untuk kode respons sebagai berikut:
   1. Klik Add filter.
   2. Klik kolom Filter dan pilih response_code dari menu drop-down.
   3. Di Comparator, pilih =.
   4. Di kolom Value, ketik 500.
   5. Klik Done.

Mengonfigurasi pemicu pemberitahuan

Untuk mengonfigurasi peristiwa yang memicu pemberitahuan, klik Konfigurasi pemicu terlebih dahulu di di panel sebelah kiri. Kemudian, lakukan langkah-langkah berikut:

1. Di bagian Jenis kondisi, pilih Nilai minimum.
2. Di kolom Alert trigger, pilih Any time series violations.
3. Di kolom Threshold position, pilih Above threshold.
4. Di kolom Nilai minimum, masukkan 1.

Dengan setelan ini, notifikasi akan dipicu setiap kali respons dengan kode 500 dikembalikan.

Klik Next untuk membuka panel Configure notifications and finalize alert.

Menyiapkan notifikasi untuk pemberitahuan

Di panel Configure notifications and finalize alert, Anda dapat menyiapkan sebuah notifikasi yang akan dikirim saat peringatan dipicu. Untuk melakukannya:

1. Klik di Notification Channels. Jika Anda sudah membuat saluran untuk notifikasi, seperti alamat email atau nomor SMS, Anda dapat memilihnya di bagian Notification Channels.

   Jika tidak, Anda perlu menambahkan saluran dengan memilih Kelola Saluran Notifikasi. Tindakan ini akan membuka panel Notification channels, tempat Anda dapat menambahkan satu atau beberapa channel. Lihat Kelola saluran notifikasi untuk mengetahui informasi selengkapnya. Setelah selesai, kembali ke Konfigurasikan notifikasi dan selesaikan panel pemberitahuan.

   Catatan: Anda mungkin perlu mengklik tombol muat ulang di samping Kelola Saluran Notifikasi untuk menampilkan saluran baru setelah Anda membuatnya.

   Setelah memilih satu atau beberapa saluran notifikasi, klik Oke.

2. Di kolom Dokumentasi, Anda dapat menambahkan pesan yang akan dikirim dengan notifikasi. Misalnya, pesan mungkin menjelaskan alasan pemberitahuan, dan berisi tautan ke dokumentasi yang menjelaskan cara menanggapinya.
3. Klik Berikutnya untuk meninjau detail pemberitahuan. Jika Anda puas dengannya, Klik Create Policy untuk membuat kebijakan pemberitahuan.

Menambahkan kondisi: Notifikasi untuk kode respons 500 untuk permintaan POST HTTP pada proxy

Anda dapat membuat beberapa kondisi untuk pemberitahuan. Misalnya, di kolom untuk kode respons 500 pada proxy yang dijelaskan di bagian sebelumnya, sebaiknya tambahkan kondisi bahwa pemberitahuan hanya dipicu untuk permintaan POST HTTP. Untuk melakukannya, cukup ikuti langkah yang sama seperti di contoh sebelumnya, tetapi setelah langkah 8, tambahkan filter lain seperti berikut:

1. Klik Add filter.
2. Klik kolom Filter dan pilih method HTTP method di drop-down daftar.
3. Di kolom Comparator, pilih =.
4. Di kolom Nilai, masukkan POST.
5. Klik Done.

Kemudian lanjutkan dengan langkah-langkah dalam Konfigurasi pemicu pemberitahuan. Setelah Anda selesai, peringatan akan dipicu saat proxy menerima kode respons 500 dari permintaan POST HTTP.

Lihat Pemberitahuan untuk kombinasi kode respons dan metode HTTP untuk hal terkait contoh.

Melihat detail insiden

Peristiwa API yang memicu pemberitahuan disebut insiden. Anda dapat melihat detail insiden terbaru di Konsol Google Cloud Halaman Alerting.

Metrik dan filter

Metrik adalah jumlah yang memicu pemberitahuan, misalnya, jumlah permintaan. Bagian ini menjelaskan metrik dan filter yang dapat Anda gunakan untuk membuat pemberitahuan berbasis metrik. Ada dua jenis metrik:

• Metrik baru: Versi baru metrik Apigee dengan peningkatan performa dan keandalan. Metrik ini saat ini tersedia untuk Apigee dan Apigee Hybrid v1.12 dan yang lebih baru. Sebaiknya gunakan metrik baru jika memungkinkan.
• Metrik asli: Metrik asli masih didukung untuk digunakan dengan Apigee Hybrid v1.10 dan v1.11.

Metrik baru

Tabel di bawah mencantumkan metrik baru.

Catatan: Metrik berikut saat ini tersedia untuk Apigee dan Apigee Hybrid v1.12 dan yang lebih baru. Untuk Apigee hybrid v1.10 dan v1.11, gunakan metrik asli.

Metrik	Deskripsi
apigee.googleapis.com/proxy/details	Detail yang relevan dengan proxy yang di-deploy ke lingkungan Apigee.
apigee.googleapis.com/proxy/request_count	Jumlah permintaan ke proxy Apigee sejak sampel terakhir dicatat.
apigee.googleapis.com/proxy/response_count	Jumlah respons yang dikirim oleh proxy API Apigee.
apigee.googleapis.com/proxy/latencies	Distribusi latensi, yang dihitung dari waktu permintaan diterima oleh proxy Apigee ke saat respons dikirim dari proxy Apigee ke klien.
apigee.googleapis.com/target/request_count	Jumlah permintaan yang dikirim ke target Apigee sejak sampel terakhir dicatat.
apigee.googleapis.com/target/response_count	Jumlah respons yang diterima dari target Apigee sejak terakhir sampel dicatat.
apigee.googleapis.com/target/latencies	Distribusi latensi, yang dihitung dari waktu permintaan dikirim target Apigee saat respons diterima oleh proxy Apigee. Waktu tidak termasuk overhead proxy Apigee API.

Metrik asli

Berikut adalah daftar versi asli metrik yang ditampilkan pada tabel di atas. yang masih didukung untuk digunakan dengan Apigee Hybrid.

Metrik	Deskripsi
apigee.googleapis.com/proxyv2/details	Detail yang relevan dengan proxy yang di-deploy ke lingkungan Apigee.
apigee.googleapis.com/proxyv2/request_count	Jumlah total permintaan yang diterima oleh proxy API Apigee.
apigee.googleapis.com/proxyv2/response_count	Jumlah total respons yang ditampilkan oleh proxy API Apigee.
apigee.googleapis.com/proxyv2/latencies_percentile	Persentil semua respons proxy API terhadap permintaan.
apigee.googleapis.com/targetv2/request_count	Jumlah total permintaan yang diterima oleh target API Apigee.
apigee.googleapis.com/targetv2/response_count	Jumlah total respons yang ditampilkan oleh target API Apigee.
apigee.googleapis.com/targetv2/latencies_percentile	Persentil semua respons target API terhadap permintaan.

Filter

Filter memungkinkan Anda membuat notifikasi untuk subkumpulan data API. Filter menentukan kondisi yang mendefinisikan {i>subset<i}. Misalnya, Anda dapat membuat pemberitahuan berdasarkan data untuk {i>proxy<i} tunggal.

Anda dapat memilih dari filter berikut:

Filter	Deskripsi	Metrik yang filternya dapat diterapkan
env	Lingkungan untuk data.	Semua
location	Lokasi untuk data.	Semua
proxy_name	Proxy untuk data.	Semua
proxy_deployment_type	Jenis deployment proxy Apigee	apigee.googleapis.com/proxy/details apigee.googleapis.com/proxyv2/details
runtime_version	Versi runtime untuk data.	Metrik asli
instance_id	ID instance untuk data.	Metrik asli
method	Metode HTTP untuk data.	Semua
response_code	Kode respons HTTP untuk data.	apigee.googleapis.com/proxy/response_count apigee.googleapis.com/proxyv2/response_count
fault_code	Kode kesalahan untuk data.	apigee.googleapis.com/proxy/response_count apigee.googleapis.com/proxyv2/response_count
fault_source	Sumber kesalahan untuk data. Jika Anda ingin menangkap error umum yang dapat terjadi di mana saja dalam Jaringan API, tetapkan fault_source ke proxy.	apigee.googleapis.com/proxy/response_count apigee.googleapis.com/proxyv2/response_count
percentile	Persentil latensi respons proxy Apigee.	apigee.googleapis.com/proxyv2/latencies_percentile

Pemberitahuan berbasis log

Selain pemberitahuan berbasis metrik yang dijelaskan di bagian sebelumnya, Anda juga dapat membuat pemberitahuan berbasis log, yang memantau data API yang disimpan oleh Cloud Logging.

Menyiapkan pemberitahuan berbasis log

Contoh berikutnya menunjukkan cara menyiapkan pemberitahuan berbasis log. Lihat Buat kueri di Logs Explorer untuk informasi selengkapnya.

1. Buka Logs Explorer di Konsol Google Cloud.
2. Pilih Show query di sisi kanan Logs Explorer.
3. Di panel Query, masukkan kueri seperti contoh yang ditampilkan di bawah ini.

   resource.type="apigee.googleapis.com/Environment"
   logName="projects/<project_id>/logs/apigee.googleapis.com%2Fanomaly_event"

   Catatan: / sebelum anomaly_event ([LOG_ID]) harus dienkode ke URL sebagai %2F. Lihat LogEntry halaman referensi.

   

4. Klik Run query. Hasilnya ditampilkan di Verifikasi bahwa kueri menampilkan entri log yang ingin Anda peringatkan.
5. Klik Create alert di bawah panel Query.
6. Ikuti prosedur dalam dialog Buat kebijakan pemberitahuan berbasis log untuk membuat pemberitahuan. Lihat Mengonfigurasi pemberitahuan berbasis log untuk mengetahui detailnya.