Notifikasi keamanan

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Dokumentasi Apigee Edge.

Peringatan Keamanan API Lanjutan memungkinkan Anda membuat pemberitahuan untuk peristiwa yang terkait dengan keamanan API, seperti perubahan pada skor keamanan Anda, atau tentang penyalahgunaan API yang terdeteksi. Anda buat pemberitahuan menggunakan Cloud Pemantauan. Anda dapat mengonfigurasi pemberitahuan untuk mengirimkan notifikasi melalui SMS, email, atau saluran lain, saat notifikasi dipicu. Lihat Buat nilai minimum metrik kebijakan pemberitahuan untuk mengetahui informasi lebih lanjut tentang cara membuat pemberitahuan.

Peran yang diperlukan

Untuk menyiapkan pemberitahuan dan saluran notifikasi di Cloud Monitoring, Anda harus ditetapkan peran berikut:

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

Batasan

Untuk pemberitahuan, batasan berikut berlaku:

  • Jumlah maksimum kebijakan pemberitahuan adalah 500 untuk semua level langganan Apigee.
  • Data metrik disimpan selama 6 minggu.
  • Jangka waktu maksimum nilai minimum metrik yang dievaluasi adalah 23 jam 30 menit.
  • Mungkin terdapat keterlambatan hingga 4 menit sejak peristiwa yang memicu pemberitahuan terjadi hingga saat pemberitahuan dibuat dan notifikasi dikirimkan.

Lihat Batas pemberitahuan untuk mengetahui daftar lengkap batasan pemberitahuan.

Bagian berikut menampilkan contoh yang menunjukkan cara membuat pemberitahuan.

Contoh: Membuat notifikasi untuk penurunan skor keamanan proxy

Contoh ini membuat peringatan ketika skor keamanan proxy berada di bawah ambang batas yang ditentukan. Untuk membuat pemberitahuan, lakukan langkah-langkah berikut:

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

  2. Klik Pilih Metrik.
  3. 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.

  4. Pilih metrik sebagai berikut:
    1. Pilih Apigee API Security Profile Environment Association.
    2. Di panel yang terbuka di sebelah kanan, pilih Keamanan
    3. Di panel berikutnya di sebelah kanan, pilih Skor keamanan proxy API Apigee.
    4. Klik Terapkan
  5. (Opsional) Untuk membatasi data notifikasi, misalnya ke lingkungan tertentu, Anda dapat membuat filter sebagai berikut:
    1. Di bagian Add filters > Filter baru, klik kolom Filter, lalu pilih label resource yang akan difilter, seperti env.
    2. Di kolom Pembanding, pilih pembanding, seperti =.
    3. Di kolom Value, pilih nilai untuk label resource, seperti nama lingkungan.

    Dengan filter ini, notifikasi hanya akan dipicu oleh data yang lulus kondisi filter. Lihat Filter untuk daftar filter yang tersedia.

  6. Di bagian Transform data, di kolom Rolling window function, pilih sum.
  7. Klik Berikutnya.
  8. Di panel Configure alert trigger, tetapkan setelan berikut ini:
    • Di bagian Jenis Kondisi, pilih Nilai Minimum.
    • Di bagian Alert trigger, pilih Kapan saja deret waktu melanggar.
    • Di bagian Posisi minimum, pilih Di bawah nilai minimum.
    • Di kolom Nilai minimum, masukkan nilai minimum yang memicu pemberitahuan, misalnya sebagai 600..
  9. Klik Berikutnya.
  10. Di kolom Configure notifications, klik kolom Notification Channels dan pilih saluran, seperti pesan teks atau email, untuk notifikasi. Jika Anda belum mengonfigurasi saluran apa pun, klik Kelola Saluran Notifikasi, lalu tambahkan satu atau beberapa saluran.
  11. Klik Oke.
  12. Di kolom Dokumentasi, masukkan teks yang ingin Anda kirimkan bersama notifikasi, seperti deskripsi tentang hal yang memicu notifikasi. Misalnya, Anda bisa memasukkan "Skor keamanan turun di bawah 600."
  13. Di bagian Beri nama kebijakan pemberitahuan, masukkan nama untuk kebijakan pemberitahuan.
  14. Klik Berikutnya dan tinjau detail kebijakan pemberitahuan.
  15. Jika semuanya sudah oke, klik Create Policy untuk membuat kebijakan pemberitahuan.

Contoh: Membuat notifikasi 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 tertentu untuk satu aturan deteksi apa pun. Untuk membuat pemberitahuan, lakukan langkah-langkah berikut:

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

    Membuat halaman kebijakan pemberitahuan

  2. Klik Pilih Metrik.
  3. 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.

  4. Pilih metrik sebagai berikut:
    1. Pilih Apigee API Security Detection Rule.
    2. Di panel yang terbuka di sebelah kanan, pilih Keamanan
    3. Di panel sebelah kanan, pilih Apigee API Security detected request count by rule.
    4. Klik Terapkan
  5. (Opsional) Untuk membatasi data notifikasi, misalnya ke lingkungan tertentu, Anda dapat membuat filter sebagai berikut:
    1. Di bagian Add filters > Filter baru, klik kolom Filter, lalu pilih label resource yang akan difilter, seperti env.
    2. Di kolom Pembanding, pilih pembanding, seperti =.
    3. Di kolom Value, pilih nilai untuk label resource, seperti nama lingkungan.

    Dengan filter ini, notifikasi hanya akan dipicu oleh data yang memenuhi kondisi filter, seperti data dalam lingkungan. Lihat Filter untuk daftar filter yang tersedia filter.

  6. Di bagian Transform data, di kolom Rolling window function, pilih sum.
  7. Klik Berikutnya.
  8. Di panel Configure alert trigger, tetapkan setelan berikut ini:
    • Di bagian Jenis Kondisi, pilih Nilai Minimum.
    • Di bagian Alert trigger, pilih Kapan saja deret waktu melanggar.
    • Di bagian Posisi minimum, pilih Di atas nilai minimum.
    • Di kolom Nilai minimum, masukkan nilai minimum yang memicu pemberitahuan, misalnya sebagai 100..
  9. Klik Berikutnya.
  10. Di kolom Configure notifications, klik kolom Notification Channels dan pilih saluran, seperti pesan teks atau email, untuk notifikasi. Jika Anda belum mengonfigurasi saluran apa pun, klik Kelola Saluran Notifikasi, lalu tambahkan satu atau beberapa saluran.
  11. Klik Oke.
  12. Di kolom Dokumentasi, masukkan teks yang ingin Anda kirimkan bersama notifikasi, seperti deskripsi tentang hal yang memicu notifikasi. Misalnya, Anda bisa memasukkan "Traffic penyalahgunaan yang terdeteksi melampaui 100 untuk $(resource.label.env)." Ini menggunakan label $(resource.label.env), yang menampilkan lingkungan yang datanya memicu pemberitahuan.
  13. Di bagian Beri nama kebijakan pemberitahuan, masukkan nama untuk kebijakan pemberitahuan.
  14. Klik Berikutnya dan tinjau detail kebijakan pemberitahuan.
  15. Jika semuanya sudah oke, 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 contoh terakhir. lokasi, org, env, proxy
Lingkungan Apigee Jumlah permintaan yang terdeteksi Keamanan API Apigee:
apigee.googleapis.com/security/detected_request_count
Jumlah permintaan API yang terdeteksi oleh deteksi penyalahgunaan Advanced API Security, sejak contoh terakhir. lokasi, org, env, proxy
Aturan Deteksi Keamanan API Apigee Keamanan API Apigee 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 oleh aturan deteksi sejak sampel terakhir. lokasi, org, env, proxy, detection_rule
Insiden Keamanan API Apigee Jumlah permintaan insiden Keamanan API Apigee:
apigee.googleapis.com/security/incident_request_count
Jumlah permintaan API yang terdeteksi sebagai bagian dari insiden Keamanan API. Nilai ini adalah diukur sekali setiap jam. lokasi, org, env, proxy
Insiden Keamanan API Apigee Jumlah permintaan insiden Keamanan API Apigee 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 oleh 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 API Apigee saat ini berdasarkan penilaian sumber Keamanan API Lanjutan. Nilai ini diukur minimal setiap 3 jam sekali. 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 minimal setiap 3 jam sekali. lokasi, org, env, profil, proxy
Asosiasi Lingkungan Profil Keamanan API Apigee Skor keamanan target API Apigee:
apigee.googleapis.com/security/target_score
Skor keamanan proxy API Apigee saat ini berdasarkan penilaian target Keamanan API Lanjutan. Nilai ini diukur minimal setiap 3 jam sekali. 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 dari sumber, proxy, dan target. Nilai ini diukur minimal setiap 3 jam sekali. 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