Menyiapkan pemberitahuan habis masa berlaku

Anda melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Gunakan pemberitahuan masa berlaku TLS untuk memunculkan notifikasi saat sertifikat TLS di lingkungan akan habis masa berlakunya.

Tentang sertifikat TLS

TLS (Transport Layer Security) adalah teknologi keamanan standar untuk membuat link terenkripsi antara server web dan klien web, seperti browser atau aplikasi. Link terenkripsi memastikan bahwa semua data yang melewati antara server dan klien tetap bersifat pribadi.

Sertifikat TLS adalah file digital yang mengidentifikasi entitas dalam transaksi TLS. Edge menggunakan sertifikat TLS untuk mengonfigurasi TLS untuk:

Sertifikat TLS berisi tanggal habis masa berlaku. Jika sertifikat TLS habis masa berlakunya, koneksi TLS akan gagal hingga Anda memperbarui sertifikat. Artinya, semua permintaan ke API Anda akan gagal hingga Anda memperbarui sertifikat.

Tentang pemberitahuan masa berlaku

Daripada menunggu sertifikat habis masa berlakunya, dan permintaan ke API Anda gagal, gunakan pemberitahuan masa berlaku untuk memunculkan notifikasi saat sertifikat TLS di lingkungan akan habis masa berlakunya. Setelah pemberitahuan dipicu, Anda dapat memperbarui sertifikat sehingga pelanggan tidak akan melihat gangguan layanan.

Saat mengonfigurasi pemberitahuan, jangan tentukan sertifikat individual, tetapi lingkungan tertentu. Pemberitahuan akan dipicu saat sertifikat yang di-deploy dijadwalkan habis masa berlakunya dalam rentang waktu yang ditentukan.

Anda dapat menetapkan pemberitahuan masa berlaku agar terjadi:

  • 1 hari sebelum sertifikat habis masa berlakunya
  • 14 hari sebelum sertifikat habis masa berlakunya
  • 30 hari sebelum sertifikat habis masa berlakunya
Untuk mengetahui informasi selengkapnya tentang pemberitahuan, lihat Menyiapkan pemberitahuan dan notifikasi.

Menambahkan pemberitahuan dan notifikasi masa berlaku

Untuk menambahkan pemberitahuan dan notifikasi masa berlaku:
  1. Klik Analyze > Alert Rules di UI Edge.
  2. Klik +Alert.
  3. Masukkan informasi umum berikut tentang pemberitahuan:
    Kolom Deskripsi
    Nama Notifikasi Nama notifikasi. Gunakan nama yang menjelaskan pemicu dan yang akan bermakna bagi Anda. Nama tidak boleh melebihi 128 karakter.
    Deskripsi Deskripsi pemberitahuan.
    Jenis Notifikasi Pilih TLS Expiry. Lihat Tentang jenis notifikasi untuk mengetahui informasi selengkapnya.
    Lingkungan Pilih lingkungan dari daftar drop-down.
    Status Beralih untuk mengaktifkan atau menonaktifkan pemberitahuan.
  4. Tentukan nilai minimum dan dimensi untuk kondisi yang akan memicu pemberitahuan.
    Kolom Kondisi Deskripsi
    Batas

    Konfigurasi rentang waktu untuk sertifikat yang akan habis masa berlakunya. Anda dapat memilih untuk memunculkan pemberitahuan saat sertifikat akan habis masa berlakunya dalam:

    • 1 hari
    • 14 hari
    • 30 hari
    Dimensi Dimensi ditetapkan ke nilai Any TLS Certificates yang sesuai dengan sertifikat TLS apa pun di lingkungan.
  5. Klik + Notification untuk menambahkan notifikasi pemberitahuan.
    Detail Notifikasi Deskripsi
    Saluran Pilih saluran notifikasi yang ingin Anda gunakan dan tentukan tujuannya: Email, Slack, PagerDuty, atau Webhook.
    Tujuan Tentukan tujuan berdasarkan jenis saluran yang dipilih:
    • Email - Alamat email, seperti joe@company.com
    • Slack - URL saluran Slack, seperti https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty - Kode PagerDuty, seperti abcd1234efgh56789
    • Webhook - URL Webhook, seperti https://apigee.com/test-webhook

      Catatan: Anda hanya dapat menentukan satu tujuan per notifikasi. Untuk menentukan beberapa tujuan untuk jenis saluran yang sama, tambahkan notifikasi tambahan.
  6. Untuk menambahkan notifikasi tambahan, ulangi langkah sebelumnya.
  7. Jika Anda menambahkan notifikasi, tetapkan kolom berikut:
    Kolom Deskripsi
    Playbook (Opsional) Kolom teks bebas untuk memberikan deskripsi singkat tentang tindakan yang direkomendasikan untuk mengatasi pemberitahuan saat dipicu. Anda juga dapat menentukan link ke wiki internal atau halaman komunitas tempat Anda mereferensikan praktik terbaik. Informasi di kolom ini akan disertakan dalam notifikasi. Konten di kolom ini tidak boleh melebihi 1.500 karakter.
    Pembatasan Frekuensi pengiriman notifikasi. Pilih nilai dari daftar drop-down.
  8. Klik Simpan.

Melihat pemberitahuan di dasbor Peristiwa

Saat Edge mendeteksi kondisi pemberitahuan, Edge akan otomatis mencatat kondisi tersebut ke dasbor Peristiwa di UI Edge. Daftar peristiwa yang ditampilkan di dasbor Peristiwa mencakup semua pemberitahuan, baik yang tetap maupun sertifikat.

Untuk melihat pemberitahuan:

  1. Klik Analyze > Events di UI Edge. Dasbor Peristiwa baru akan muncul:

  2. Filter dasbor Peristiwa menurut:

    • Lingkungan
    • Wilayah
    • Jangka waktu
  3. Pilih baris di dasbor Peristiwa untuk menampilkan Keystore yang berisi sertifikat yang akan habis masa berlakunya untuk menyelidiki lebih lanjut pemberitahuan tersebut. Dari halaman Keystore, Anda dapat mengupload sertifikat baru dan menghapus sertifikat yang akan habis masa berlakunya.

Menggunakan API pemberitahuan dengan pemberitahuan masa berlaku

Sebagian besar API yang Anda gunakan untuk membuat dan mengelola pemberitahuan masa berlaku sama dengan yang Anda gunakan dengan pemberitahuan tetap. API pemberitahuan berikut berfungsi dengan cara yang sama untuk pemberitahuan tetap dan masa berlaku:

Namun, beberapa API memiliki properti tambahan yang digunakan untuk mendukung pemberitahuan anomali, termasuk:

Membuat atau memperbarui pemberitahuan masa berlaku

Gunakan API yang sama untuk membuat atau memperbarui pemberitahuan masa berlaku seperti yang saat ini Anda lakukan untuk pemberitahuan tetap. Isi panggilan API untuk membuat atau memperbarui pemberitahuan masa berlaku sama dengan yang digunakan untuk pemberitahuan tetap, dengan perubahan berikut:

  • Anda harus menambahkan properti baru berikut untuk menentukan bahwa pemberitahuan tersebut adalah pemberitahuan masa berlaku:

    "alertType": "cert"
"alertSubType": "certfixed"

    Nilai default properti ini adalah:

    "alertType": "runtime"
"alertSubType": "fixed"

  • Dalam array conditions:

    • Properti metrics hanya mengambil nilai expiration.
    • Gunakan properti gracePeriodSeconds untuk menentukan rentang waktu habis masa berlaku sertifikat dalam detik, hingga durasi maksimum 30 hari.
    • Properti threshold, durationSeconds, dan comparator tidak didukung.
  • Dalam elemen dimensions dari array conditions:
    • Anda harus menetapkan nilai properti certificate ke ANY.
    • Anda harus menetapkan nilai properti proxy ke ALL.
    • Properti statusCode, developerApp, collection, faultCodeCategory, faultCodeSubCategory, faultCodeName tidak didukung.
  • Properti reportEnabled tidak didukung untuk pemberitahuan masa berlaku.

Contoh panggilan API berikut membuat pemberitahuan masa berlaku yang dipicu saat sertifikat di lingkungan produksi akan habis masa berlakunya dalam 30 hari ke depan. Notifikasi akan dikirim ke alamat email yang ditentukan saat pemberitahuan dipicu:

curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
 -X POST \
 -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -d '{
  "organization":"myorg",
  "name":"My Cert Expiry Alert",
  "description":"My Cert Expiry Alert",
  "environment":"prod",
  "enabled":true,
  "alertType": "cert",
  "alertSubType": "certfixed",
  "conditions":[
  {
    "description":"My Cert Expiry Alert",
    "dimensions":{
      "org":"myorg",
      "env":"prod",
      "proxy":"ALL",
      "certificate": "ANY"
    },
    "metric":"expiration",
    "gracePeriodSeconds": 2592000
  }],
  "notifications":[{
    "channel":"email",
    "destination":"ops@acme.com"
  }],
  "playbook":"http://acme.com/pb.html",
  "throttleIntervalSeconds":3600,
  "reportEnabled":false
}'

Tetapkan $ACCESS_TOKEN ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Untuk mengetahui informasi tentang opsi cURL yang digunakan dalam contoh ini, lihat Menggunakan cURL.

Mendapatkan pemberitahuan masa berlaku

Secara default, Get Alerts API menampilkan informasi tentang semua pemberitahuan yang ditentukan, baik yang tetap maupun masa berlaku. API ini kini menggunakan parameter kueri untuk memungkinkan Anda memfilter hasilnya:

  • enabled - Jika true menentukan untuk hanya menampilkan pemberitahuan yang diaktifkan. Nilai defaultnya adalah false.
  • alertType - Menentukan jenis pemberitahuan yang akan ditampilkan. Nilai yang diizinkan adalah runtime, default, dan cert.
  • alertSubType - Menentukan subjenis pemberitahuan yang akan ditampilkan. Nilai defaultnya tidak ditetapkan, yang berarti menampilkan semua subjenis pemberitahuan. Tentukan certfixed untuk menampilkan pemberitahuan masa berlaku.

Misalnya, gunakan panggilan API berikut untuk hanya menampilkan pemberitahuan yang diaktifkan untuk organisasi bernama myorg:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'

Panggilan berikut hanya menampilkan pemberitahuan masa berlaku, baik yang diaktifkan maupun dinonaktifkan:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=cert&alertSubType=certfixed'

Tetapkan $ACCESS_TOKEN ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0. Untuk mengetahui informasi tentang opsi cURL yang digunakan dalam contoh ini, lihat Menggunakan cURL.