Halaman ini diterjemahkan oleh Cloud Translation API.

Menyiapkan pemberitahuan dan notifikasi

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Lihat dokumentasi Apigee Edge.

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

Anda dapat menetapkan aturan tertentu untuk pemberitahuan—misalnya, pemberitahuan dapat dipicu oleh kode respons 500 (Internal Service Error) pada proxy. Saat insiden untuk pemberitahuan terjadi, Anda dapat melihat detailnya di panel Insiden di halaman Pemberitahuan. Google Cloud console

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

Ada dua jenis pemberitahuan di Pemantauan API:

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

Pemberitahuan berbasis metrik

Pemberitahuan 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: Kuantitas yang memicu pemberitahuan—misalnya, jumlah permintaan.
Nilai minimum: Tingkat yang harus dicapai metrik untuk memicu notifikasi.

Bagian berikut memberikan contoh pemberitahuan berbasis metrik.

Peringatan untuk kode respons 500 di proxy

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

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

Di konsol Google Cloud , buka halaman Monitoring > Alerting > Policies.

Buka Buat kebijakan pemberitahuan
Klik Pilih Metrik.
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.
Pilih metrik sebagai berikut:
1. Jika Anda menggunakan Apigee hybrid v1.12, salin dan tempel kode berikut di kolom Select a metric:
```
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 berikutnya di sebelah kanan, pilih Jumlah respons proxy Apigee.
5. Klik Terapkan.
Tambahkan filter untuk kode respons sebagai berikut:
1. Klik Tambahkan filter.
2. Klik kolom Filter, lalu pilih response_code dari menu drop-down.
3. Di Comparator, pilih =.
4. Di kolom Nilai, ketik 500.
5. Klik Selesai.

Mengonfigurasi pemicu pemberitahuan

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

Di bagian Jenis kondisi, pilih Nilai minimum.
Di kolom Pemicu pemberitahuan, pilih Deret waktu mana pun melanggar.
Di kolom Posisi nilai minimum, pilih Di atas nilai minimum.
Di kolom Nilai minimum, masukkan 1.

Dengan setelan ini, pemberitahuan akan dipicu setiap kali respons dengan kode 500 ditampilkan.

Klik Next untuk membuka panel Configure notifications and finalize alert.

Menyiapkan notifikasi untuk pemberitahuan

Di panel Konfigurasi notifikasi dan finalisasi pemberitahuan, Anda dapat menyiapkan notifikasi yang akan dikirim saat pemberitahuan dipicu. Untuk melakukannya:

Klik di kolom Notification Channels. Jika telah membuat saluran untuk notifikasi, seperti alamat email atau nomor SMS, Anda dapat memilihnya di bagian Saluran Notifikasi.

Jika tidak, Anda harus menambahkan saluran dengan memilih Kelola Saluran Notifikasi. Tindakan ini akan membuka panel Notification channels, tempat Anda dapat menambahkan satu atau beberapa saluran. Lihat Mengelola saluran notifikasi untuk mengetahui informasi selengkapnya. Setelah selesai, kembali ke panel Configure notifications and finalize alert.
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.
Di kolom Dokumentasi, Anda dapat menambahkan pesan yang akan dikirim dengan notifikasi. Misalnya, pesan dapat menjelaskan alasan peringatan, dan berisi link ke dokumentasi yang menjelaskan cara meresponsnya.
Klik Berikutnya untuk meninjau detail peringatan. Jika Anda puas dengan setelan tersebut, klik Buat Kebijakan untuk membuat kebijakan pemberitahuan.

Menambahkan kondisi: Pemberitahuan untuk kode respons 500 untuk permintaan POST HTTP di proxy

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

Klik Tambahkan filter.
Klik kolom Filter, lalu pilih method HTTP method di menu drop-down.
Di kolom Comparator, pilih =.
Di kolom Value, masukkan POST.
Klik Selesai.

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

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

Melihat detail insiden

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

Metrik dan filter

Metrik adalah kuantitas 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.

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 direkam.
`apigee.googleapis.com/proxy/response_count`	Jumlah respons yang dikirim oleh proxy API Apigee.
`apigee.googleapis.com/proxy/latencies`	Distribusi latensi, yang dihitung dari saat permintaan diterima oleh proxy Apigee hingga saat respons dikirim dari proxy Apigee ke klien.
`apigee.googleapis.com/target/request_count`	Jumlah permintaan yang dikirim ke target Apigee sejak sampel terakhir direkam.
`apigee.googleapis.com/target/response_count`	Jumlah respons yang diterima dari target Apigee sejak sampel terakhir dicatat.
`apigee.googleapis.com/target/latencies`	Distribusi latensi, yang dihitung dari waktu permintaan dikirim ke target Apigee hingga waktu respons diterima oleh proxy Apigee. Waktu tidak mencakup overhead proxy API Apigee.

Metrik asli

Berikut adalah daftar versi asli metrik yang ditampilkan dalam tabel di atas, yang masih didukung untuk digunakan dengan Apigee Hybrid v1.10 dan v1.11 saja.

Metrik	Deskripsi
`apigee.googleapis.com/proxyv2/details`	Detail yang relevan dengan proxy yang di-deploy ke lingkungan Apigee.
`apigee.googleapis.com/proxyv2/request_count`	Total jumlah 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 pemberitahuan untuk subkumpulan data API. Filter menentukan kondisi yang menentukan subset. Misalnya, Anda dapat membuat pemberitahuan berdasarkan data untuk satu proxy.

Anda dapat memilih dari filter berikut:

Filter	Deskripsi	Metrik yang dapat diterapkan filternya
`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 Membuat kueri di Logs Explorer untuk mengetahui informasi selengkapnya.

Buka Logs Explorer di Google Cloud console.
Pilih Tampilkan kueri di sisi kanan Logs Explorer.
Di panel Query, masukkan kueri seperti contoh yang ditunjukkan di bawah.
```
resource.type="apigee.googleapis.com/Environment"
logName="projects/<project_id>/logs/apigee.googleapis.com%2Fanomaly_event"
```
Catatan: / sebelum anomaly_event ([LOG_ID]) harus dienkode URL sebagai %2F. Lihat halaman referensi LogEntry.
Klik Run query. Hasilnya ditampilkan di Pastikan kueri menampilkan entri log yang ingin Anda beri tahu.
Klik Buat pemberitahuan di bawah panel Kueri.
Ikuti prosedur dalam dialog Buat kebijakan pemberitahuan berbasis log untuk membuat pemberitahuan. Lihat Mengonfigurasi pemberitahuan berbasis log untuk mengetahui detailnya.