Halaman ini berlaku untuk Apigee dan Apigee Hybrid.
Baca dokumentasi Apigee Edge.
Dengan Pemberitahuan Keamanan API Lanjutan, Anda dapat membuat pemberitahuan untuk peristiwa yang terkait dengan keamanan API, seperti perubahan pada skor keamanan atau insiden penyalahgunaan API yang terdeteksi. Anda membuat pemberitahuan menggunakan Cloud Monitoring. Anda dapat mengonfigurasi pemberitahuan agar dapat mengirimkan notifikasi melalui SMS, email, atau saluran lain saat notifikasi dipicu. Lihat Membuat kebijakan pemberitahuan batas metrik untuk informasi selengkapnya tentang cara membuat pemberitahuan.
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 sejak peristiwa yang memicu notifikasi terjadi hingga saat notifikasi dibuat dan notifikasi dikirim.
Lihat Batas pemberitahuan untuk mengetahui daftar lengkap batas untuk pemberitahuan.
Bagian berikut menampilkan contoh yang menunjukkan cara membuat pemberitahuan.
Contoh: Membuat pemberitahuan untuk penurunan skor keamanan proxy
Contoh ini membuat pemberitahuan saat skor keamanan proxy turun di bawah batas yang ditentukan. Untuk membuat pemberitahuan, lakukan langkah-langkah berikut:
Buka halaman Create alerts di Konsol Google Cloud.
- Klik Select a Metric.
- Batalkan pilihan Hanya tampilkan resource & metrik aktif.
Catatan: Jika tidak ada data traffic API terbaru di organisasi Anda, metrik di langkah berikutnya tidak akan ditampilkan kecuali 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 Security score of Apigee API proxy.
- Klik Terapkan
- (Opsional) Guna membatasi data untuk pemberitahuan, misalnya ke lingkungan yang ditentukan, Anda dapat membuat filter sebagai berikut:
- Di bagian Add filters > New filter, klik kolom Filter, lalu pilih label resource yang akan difilter, seperti env.
- Di kolom Comparator, pilih pembanding, seperti =.
- Di kolom Value, pilih nilai untuk label resource, seperti nama lingkungan.
Dengan filter ini, pemberitahuan hanya akan dipicu oleh data yang lulus kondisi filter. Buka Filter untuk melihat daftar filter yang tersedia.
- Di bagian Transform data, di kolom Rolling window function, pilih sum.
- Klik Next.
- Di panel Configure alert trigger, tetapkan hal berikut:
- Di bagian Jenis Kondisi, pilih Nilai Minimum.
- Di bagian Pemicu pemberitahuan, pilih Deret waktu mana saja melanggar.
- Pada Posisi nilai minimum, pilih Di bawah nilai minimum.
- Di kolom Threshold value, masukkan nilai minimum yang memicu pemberitahuan, seperti 600.
- Klik Next.
- Di kolom Configure notifications, klik kolom Notification Channels, lalu pilih saluran, seperti pesan teks atau email, untuk notifikasi tersebut. Jika Anda belum mengonfigurasi saluran apa pun, klik Kelola Saluran Notifikasi, lalu tambahkan satu saluran atau saluran.
- Klik OK.
- Di kolom Documentation, masukkan teks apa pun yang ingin Anda kirim bersama notifikasi, seperti deskripsi tentang hal yang memicu pemberitahuan. Misalnya, Anda dapat memasukkan "Skor keamanan turun di bawah 600".
- Di bagian Name the alert policy, masukkan nama untuk kebijakan pemberitahuan tersebut.
- Klik Berikutnya dan tinjau detail kebijakan pemberitahuan.
- Jika semuanya sudah benar, klik Create Policy 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:
Buka halaman Create alerts di Konsol Google Cloud.
- Klik Select a Metric.
- Batalkan pilihan Hanya tampilkan resource & metrik aktif.
Catatan: Jika tidak ada data traffic API terbaru di organisasi Anda, metrik di langkah berikutnya tidak akan ditampilkan kecuali 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) Guna membatasi data untuk pemberitahuan, misalnya ke lingkungan yang ditentukan, Anda dapat membuat filter sebagai berikut:
- Di bagian Add filters > New filter, klik kolom Filter, lalu pilih label resource yang akan difilter, seperti env.
- Di kolom Comparator, pilih pembanding, seperti =.
- Di kolom Value, pilih nilai untuk label resource, seperti nama lingkungan.
Dengan filter ini, pemberitahuan hanya akan dipicu oleh data yang meneruskan kondisi filter, seperti data di lingkungan. Lihat Filter untuk daftar filter yang tersedia.
- Di bagian Transform data, di kolom Rolling window function, pilih sum.
- Klik Next.
- Di panel Configure alert trigger, tetapkan hal berikut:
- Di bagian Jenis Kondisi, pilih Nilai Minimum.
- Di bagian Pemicu pemberitahuan, pilih Deret waktu mana saja melanggar.
- Di bagian Posisi nilai minimum, pilih Di atas nilai minimum.
- Di kolom Nilai minimum, masukkan nilai minimum yang memicu pemberitahuan, seperti 100.
- Klik Next.
- Di kolom Configure notifications, klik kolom Notification Channels, lalu pilih saluran, seperti pesan teks atau email, untuk notifikasi tersebut. Jika Anda belum mengonfigurasi saluran apa pun, klik Kelola Saluran Notifikasi, lalu tambahkan satu saluran atau saluran.
- Klik OK.
- Di kolom Documentation, masukkan teks apa pun yang ingin Anda kirim bersama notifikasi, seperti deskripsi tentang hal yang memicu pemberitahuan. Misalnya, Anda dapat memasukkan "Traffic penyalahgunaan yang terdeteksi melebihi 100 untuk $(resource.label.env)". Langkah ini menggunakan label $(resource.label.env), yang menampilkan lingkungan yang datanya memicu pemberitahuan.
- Di bagian Name the alert policy, masukkan nama untuk kebijakan pemberitahuan tersebut.
- Klik Berikutnya dan tinjau detail kebijakan pemberitahuan.
- Jika semuanya sudah benar, klik Create Policy untuk membuat kebijakan pemberitahuan.
Metrik untuk notifikasi keamanan
Tabel di bawah menjelaskan metrik yang tersedia untuk membuat notifikasi keamanan:
Resource | Metrik | Deskripsi | Filter yang didukung |
---|---|---|---|
Lingkungan Apigee | Jumlah permintaan Keamanan API Apigee:apigee.googleapis.com/security/request_count |
Jumlah permintaan API yang diproses oleh Advanced API Security, sejak sampel terakhir. | lokasi, org, env, proxy |
Lingkungan Apigee | Apigee API Security mendeteksi jumlah permintaan:apigee.googleapis.com/security/detected_request_count |
Jumlah permintaan API yang terdeteksi oleh deteksi penyalahgunaan Advanced API Security, sejak sampel terakhir. | lokasi, org, env, proxy |
Aturan Deteksi Keamanan API Apigee | Apigee API Security mendeteksi jumlah permintaan berdasarkan aturan:apigee.googleapis.com/security/detected_request_count_by_rule |
Jumlah permintaan API yang terdeteksi oleh deteksi penyalahgunaan Advanced API Security dan dikelompokkan berdasarkan aturan deteksi sejak sampel terakhir. | lokasi, org, env, proxy, pendeteksian_rule |
Insiden Keamanan API Apigee | Jumlah permintaan insiden Keamanan Apigee API:apigee.googleapis.com/security/incident_request_count |
Jumlah permintaan API yang terdeteksi sebagai bagian dari insiden Keamanan API. Nilai ini diukur sekali setiap jam. | lokasi, org, env, proxy |
Insiden Keamanan API Apigee | Jumlah permintaan insiden Keamanan Apigee API berdasarkan aturan deteksi:apigee.googleapis.com/security/incident_request_count_by_rule |
Jumlah permintaan API yang terdeteksi sebagai bagian dari insiden Keamanan API yang dikelompokkan berdasarkan aturan deteksi. Nilai ini diukur sekali setiap jam. | lokasi, org, env, insiden_id, detection_rule |
Asosiasi Lingkungan Profil Keamanan API Apigee | Skor keamanan sumber API Apigee:apigee.googleapis.com/security/source_score |
Skor keamanan proxy Apigee API saat ini berdasarkan penilaian sumber Advanced API Security. Nilai ini diukur setidaknya sekali setiap 3 jam. | lokasi, org, env, profil |
Asosiasi Lingkungan Profil Keamanan API Apigee | Skor keamanan proxy API Apigee:apigee.googleapis.com/security/proxy_score |
Skor keamanan proxy Apigee API saat ini berdasarkan penilaian proxy Advanced API Security. Nilai ini diukur setidaknya sekali setiap 3 jam. | lokasi, org, env, profil, proxy |
Asosiasi Lingkungan Profil Keamanan API Apigee | Skor keamanan target Apigee API:apigee.googleapis.com/security/target_score |
Skor keamanan proxy Apigee API saat ini berdasarkan penilaian target Keamanan API Lanjutan. Nilai ini diukur setidaknya sekali setiap 3 jam. | lokasi, org, env, profil, target_server |
Asosiasi Lingkungan Profil Keamanan API Apigee | Skor keamanan lingkungan Apigee:apigee.googleapis.com/security/environment_score |
Total skor keamanan lingkungan Apigee saat ini berdasarkan penilaian Keamanan API Lanjutan terhadap sumber, proxy, dan target. Nilai ini diukur setidaknya sekali setiap 3 jam. | lokasi, org, env, profil |
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 |