Halaman ini berlaku untuk Apigee dan Apigee Hybrid.
Lihat dokumentasi
Apigee Edge.
Pemberitahuan Advanced API Security memungkinkan Anda membuat pemberitahuan untuk peristiwa yang terkait dengan keamanan API, seperti perubahan pada skor keamanan atau insiden penyalahgunaan API yang terdeteksi. Anda dapat membuat pemberitahuan menggunakan Cloud Monitoring. Anda dapat mengonfigurasi pemberitahuan untuk mengirimkan notifikasi kepada Anda melalui teks, email, atau saluran lain, saat pemberitahuan dipicu.
Lihat Membuat kebijakan pemberitahuan batas metrik untuk mengetahui informasi selengkapnya tentang cara membuat pemberitahuan dan Insiden untuk kebijakan pemberitahuan berbasis metrik untuk mengetahui informasi tentang cara mengelola pemberitahuan yang dihasilkan.
Peran yang diperlukan
Untuk menyiapkan pemberitahuan dan saluran notifikasi di Cloud Monitoring, Anda harus diberi peran berikut:
roles/monitoring.alertPolicyEditor
roles/monitoring.notificationChannelEditor
Batasan
Untuk pemberitahuan, batasan berikut berlaku:
- Jumlah maksimum kebijakan pemberitahuan adalah 500 untuk semua tingkat langganan Apigee.
- Data metrik disimpan selama 6 minggu.
- Jangka waktu maksimum yang dievaluasi oleh kondisi batas metrik adalah 23 jam 30 menit.
- Mungkin ada penundaan hingga 4 menit dari saat peristiwa yang memicu notifikasi terjadi hingga saat notifikasi dibuat dan dikirim.
Lihat Batas untuk pemberitahuan untuk mengetahui daftar lengkap batas untuk pemberitahuan.
Bagian berikut menyajikan contoh yang menunjukkan cara membuat pemberitahuan.
Contoh: Membuat pemberitahuan untuk penurunan skor keamanan proxy (Penilaian Risiko v1)
Contoh ini membuat pemberitahuan saat skor keamanan proxy berada di bawah nilai minimum yang ditentukan. Untuk membuat pemberitahuan, lakukan langkah-langkah berikut:
Di konsol Google Cloud , buka halaman Monitoring >Alerting > Policies > Create alerting policy.
- Klik Pilih Metrik.
- Batalkan pilihan Hanya tampilkan resource & metrik aktif.
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:
- Pilih Apigee API Security Profile Environment Association.
- Di panel yang terbuka di sebelah kanan, pilih Keamanan.
- Di panel berikutnya di sebelah kanan, pilih Skor keamanan proxy API Apigee.
- Klik Terapkan.
- (Opsional) Untuk membatasi data untuk pemberitahuan, misalnya ke lingkungan tertentu,
Anda dapat membuat filter sebagai berikut:
- Di bagian Tambahkan filter > Filter baru, klik di kolom Filter, lalu pilih label resource yang akan difilter, seperti env.
- Di kolom Comparator, pilih pembanding, seperti =.
- Di kolom Nilai, pilih nilai untuk label resource, seperti nama lingkungan.
Dengan filter ini, pemberitahuan hanya akan dipicu oleh data yang memenuhi kondisi filter. Lihat Filter untuk mengetahui daftar filter yang tersedia.
- Di bagian Transform data, di kolom Rolling window function, pilih sum.
- Klik Berikutnya.
- Di panel Konfigurasi pemicu pemberitahuan, tetapkan hal berikut:
- Di bagian Jenis Kondisi, pilih Nilai Minimum.
- Di bagian Pemicu pemberitahuan, pilih Deret waktu mana pun melanggar.
- Di bagian Posisi nilai minimum, pilih Di bawah nilai minimum.
- Di kolom Nilai minimum, masukkan nilai minimum yang memicu pemberitahuan, seperti 600.
- Klik Berikutnya.
- Di kolom Configure notifications, klik kolom Notification Channels dan pilih saluran, seperti pesan teks atau email, untuk notifikasi. Jika Anda belum mengonfigurasi saluran, klik Kelola Saluran Notifikasi dan tambahkan satu atau beberapa saluran.
- Klik Oke.
- Di kolom Dokumentasi, masukkan teks apa pun yang ingin Anda kirimkan bersama notifikasi, seperti deskripsi tentang apa yang memicu pemberitahuan. Misalnya, Anda dapat memasukkan "Skor keamanan telah turun di bawah 600."
- Di bagian Name the alert policy, masukkan nama untuk kebijakan pemberitahuan.
- Klik Berikutnya dan tinjau detail kebijakan pemberitahuan.
- Jika semuanya sudah oke, klik Buat Kebijakan untuk membuat kebijakan pemberitahuan.
Contoh: Membuat pemberitahuan untuk peningkatan traffic penyalahgunaan yang terdeteksi untuk aturan deteksi
Contoh ini menunjukkan cara membuat pemberitahuan saat jumlah permintaan dengan traffic penyalahgunaan yang terdeteksi melebihi batas yang ditentukan untuk satu aturan deteksi. Untuk membuat pemberitahuan, lakukan langkah-langkah berikut:
Di konsol Google Cloud , buka halaman Monitoring >Alerting > Policies > Create alerting policy.
Buka Buat kebijakan pemberitahuan
- Klik Pilih Metrik.
- Batalkan pilihan Hanya tampilkan resource & metrik aktif.
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:
- Pilih Apigee API Security Detection Rule.
- Di panel yang terbuka di sebelah kanan, pilih Keamanan.
- Di panel berikutnya di sebelah kanan, pilih Apigee API Security detected request count by rule.
- Klik Terapkan.
- (Opsional) Untuk membatasi data untuk pemberitahuan, misalnya ke lingkungan tertentu,
Anda dapat membuat filter sebagai berikut:
- Di bagian Tambahkan filter > Filter baru, klik di kolom Filter, lalu pilih label resource yang akan difilter, seperti env.
- Di kolom Comparator, pilih pembanding, seperti =.
- Di kolom Nilai, pilih nilai untuk label resource, seperti nama lingkungan.
Dengan filter ini, pemberitahuan hanya akan dipicu oleh data yang lulus kondisi filter, seperti data di lingkungan. Lihat Filter untuk mengetahui daftar filter yang tersedia.
- Di bagian Transform data, di kolom Rolling window function, pilih sum.
- Klik Berikutnya.
- Di panel Konfigurasi pemicu pemberitahuan, tetapkan hal berikut:
- Di bagian Jenis Kondisi, pilih Nilai Minimum.
- Di bagian Pemicu pemberitahuan, pilih Deret waktu mana pun melanggar.
- Di bagian Posisi nilai minimum, pilih Di atas nilai minimum.
- Di kolom Nilai minimum, masukkan nilai minimum yang memicu pemberitahuan, seperti 100.
- Klik Berikutnya.
- Di kolom Configure notifications, klik kolom Notification Channels dan pilih saluran, seperti pesan teks atau email, untuk notifikasi. Jika Anda belum mengonfigurasi saluran, klik Kelola Saluran Notifikasi dan tambahkan satu atau beberapa saluran.
- Klik Oke.
- Di kolom Dokumentasi, masukkan teks apa pun yang ingin Anda kirimkan bersama notifikasi, seperti deskripsi tentang apa yang memicu pemberitahuan. Misalnya, Anda dapat memasukkan "Traffic penyalahgunaan yang terdeteksi melebihi 100 untuk $(resource.label.env)." Hal ini menggunakan label $(resource.label.env), yang menampilkan lingkungan yang datanya memicu pemberitahuan.
- Di bagian Name the alert policy, masukkan nama untuk kebijakan pemberitahuan.
- Klik Berikutnya dan tinjau detail kebijakan pemberitahuan.
- Jika semuanya sudah oke, klik Buat Kebijakan untuk membuat kebijakan pemberitahuan.
Contoh: Membuat pemberitahuan pemantauan kondisi pemantauan penilaian risiko (Penilaian Risiko v2)
Contoh ini membuat kebijakan pemberitahuan Cloud Monitoring baru untuk kondisi pemantauan Penilaian Risiko yang akan memberikan pemberitahuan jika skor keamanan pada proxy yang dipantau berada di bawah nilai minimum tertentu.
- Buat kondisi pemantauan.
- Ikuti petunjuk di Membuat pemberitahuan pemantauan untuk membuat pemberitahuan pemantauan baru. Apigee akan mengisi beberapa kolom untuk Anda saat halaman dimuat.
- Jika diinginkan, Anda dapat mengubah setelan untuk menyesuaikan kebijakan pemberitahuan. Ikuti panduan di Membuat kebijakan pemberitahuan. Anda harus memberikan nama untuk kebijakan pemberitahuan.
- Klik Buat kebijakan untuk menyimpan kebijakan pemberitahuan baru.
Metrik untuk notifikasi keamanan
Tabel di bawah ini menjelaskan metrik yang tersedia untuk membuat pemberitahuan keamanan:
Resource | Metrik | Deskripsi | Filter yang didukung |
---|---|---|---|
Lingkungan Apigee | Jumlah permintaan Apigee API Security:apigee.googleapis.com/security/request_count |
Jumlah permintaan API yang diproses oleh Keamanan API Tingkat Lanjut, sejak sampel terakhir. | location, org, env, proxy |
Lingkungan Apigee | Jumlah permintaan yang terdeteksi oleh Apigee API Security:apigee.googleapis.com/security/detected_request_count |
Jumlah permintaan API yang terdeteksi oleh deteksi penyalahgunaan Advanced API Security, sejak sampel terakhir. | location, org, env, proxy |
Aturan Deteksi Keamanan API Apigee | Jumlah permintaan yang terdeteksi oleh aturan Apigee API Security:apigee.googleapis.com/security/detected_request_count_by_rule |
Jumlah permintaan API yang terdeteksi oleh deteksi penyalahgunaan Advanced API Security dan dikelompokkan menurut aturan deteksi sejak sampel terakhir. | location, org, env, proxy, detection_rule |
Insiden Keamanan API Apigee | Jumlah permintaan insiden Apigee API Security:apigee.googleapis.com/security/incident_request_count |
Jumlah permintaan API yang terdeteksi sebagai bagian dari insiden Keamanan API. Nilai ini diukur sekali setiap jam. | location, org, env, proxy |
Insiden Keamanan API Apigee | Jumlah permintaan insiden Apigee API Security menurut aturan deteksi:apigee.googleapis.com/security/incident_request_count_by_rule |
Jumlah permintaan API yang terdeteksi sebagai bagian dari insiden Keamanan API yang dikelompokkan menurut aturan deteksi. Nilai ini diukur sekali setiap jam. | location, org, env, incident_id, detection_rule |
Asosiasi Lingkungan Profil Keamanan API Apigee | Skor keamanan sumber API Apigee:apigee.googleapis.com/security/source_score |
Berlaku untuk Penilaian Risiko v1. Skor keamanan saat ini untuk proxy API Apigee berdasarkan penilaian sumber Advanced API Security. Nilai ini diukur setidaknya sekali setiap 3 jam. | location, org, env, profile |
Asosiasi Lingkungan Profil Keamanan API Apigee | Skor keamanan proxy API Apigee:apigee.googleapis.com/security/proxy_score |
Berlaku untuk Penilaian Risiko v1. Skor keamanan saat ini untuk proxy API Apigee berdasarkan penilaian proxy Advanced API Security. Nilai ini diukur setidaknya sekali setiap 3 jam. | location, org, env, profile, proxy |
Asosiasi Lingkungan Profil Keamanan API Apigee | Skor keamanan target API Apigee:apigee.googleapis.com/security/target_score |
Berlaku untuk Penilaian Risiko v1. Skor keamanan saat ini untuk proxy API Apigee berdasarkan penilaian target Advanced API Security. Nilai ini diukur setidaknya sekali setiap 3 jam. | location, org, env, profile, target_server |
Asosiasi Lingkungan Profil Keamanan API Apigee | Skor keamanan lingkungan Apigee:apigee.googleapis.com/security/environment_score |
Berlaku untuk Penilaian Risiko v1. Skor keamanan total lingkungan Apigee saat ini berdasarkan penilaian Advanced API Security terhadap sumber, proxy, dan target. Nilai ini diukur setidaknya sekali setiap 3 jam. | location, org, env, profile |
Hasil Penilaian Keamanan API Apigee | Skor keamanan:apigee.googleapis.com/security/score |
Berlaku untuk Penilaian Risiko v2. Skor keamanan saat ini dari resource yang di-deploy berdasarkan profil keamanan. | location, org, scope, resource, security_profile |
Filter
Label Filter | Deskripsi |
---|---|
location | Lokasi resource: selalu global. |
diagram | Nama organisasi Apigee |
env | Nama lingkungan Apigee |
profil | Nama profil Keamanan API Apigee |
proxy | Nama proxy API Apigee |
target_server | Nama server target Apigee |
detection_rule | Nama aturan deteksi keamanan API Apigee |
cakupan | Untuk Penilaian Risiko v2, ID cakupan yang terkait dengan resource yang dinilai. |
resource | Untuk Penilaian Risiko v2, ID resource yang dinilai. |
security_profile | Untuk Penilaian Risiko v2, ID profil keamanan yang digunakan untuk menilai resource. |