Menyiapkan pemberitahuan dan notifikasi

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

Kondisi notifikasi menentukan kode status tertentu (misalnya 404/502/2xx/4xx/5xx), latensi, dan nilai minimum kode kesalahan yang jika terlampaui akan memicu notifikasi visual di UI dan mengirim notifikasi melalui berbagai saluran, seperti email, slack, pagerduty, atau webhook. Anda dapat menyiapkan pemberitahuan di tingkat lingkungan, proxy API atau layanan target, atau tingkat region. Saat pemberitahuan dipicu, Anda akan menerima notifikasi menggunakan metode yang Anda tentukan saat menambahkan pemberitahuan dan notifikasi.

Misalnya, Anda mungkin ingin memicu pemberitahuan dan mengirim notifikasi kepada tim Operasi saat tingkat error 5xx melebihi 23% selama 5 menit untuk proxy API produksi pesanan yang di-deploy ke lingkungan produksi Anda.

Gambar berikut menunjukkan cara pemberitahuan ditampilkan di UI:

Berikut ini contoh notifikasi email yang mungkin Anda terima saat pemberitahuan dipicu.

Dalam isi notifikasi peringatan, klik link berikut untuk informasi selengkapnya:

• Lihat detail untuk melihat detail selengkapnya, termasuk setelan notifikasi dan aktivitas untuk setiap kondisi selama satu jam terakhir.
• Definisi notifikasi untuk melihat definisi notifikasi.
• Histori notifikasi untuk melihat informasi lebih lanjut mengenai notifikasi tertentu.
• Lihat playbook untuk melihat tindakan yang disarankan, jika disediakan.
• Lihat Laporan Analisis API untuk melihat laporan kustom untuk kondisi pemberitahuan.

Bagian berikut menjelaskan cara menyiapkan serta mengelola pemberitahuan dan notifikasi.

Tentang jenis notifikasi

Rilis awal API Monitoring memungkinkan Anda membuat aturan berbasis pola yang menentukan kapan harus memunculkan pemberitahuan berdasarkan kondisi yang telah ditentukan sebelumnya. Jenis pemberitahuan ini disebut pemberitahuan tetap dan merupakan satu-satunya jenis pemberitahuan yang didukung dalam rilis awal API Monitoring.

Misalnya, Anda dapat memicu notifikasi tetap saat:

• [rasio error 5xx] [lebih besar dari] [10%] selama [10 menit] dari [target mytarget1]
• [jumlah error 2xx] [kurang dari] [50] selama [5 menit] di [region us-east-1]
• [latensi p90] [lebih besar dari] [750 md] selama [10 menit] pada [proxy myproxy1]

Rilis Security Reporting Beta 19.11.13 menambahkan jenis pemberitahuan baru:

• Notifikasi Total traffic (Beta). Jenis pemberitahuan yang memungkinkan Anda mengirim pemberitahuan saat traffic berubah sebesar persentase tertentu selama rentang waktu tertentu.
• Notifikasi Anomali (Beta). Jenis notifikasi saat Edge mendeteksi masalah traffic dan performa, dan Anda tidak perlu menentukannya sendiri. Anda kemudian dapat meningkatkan peringatan untuk anomali ini.
• Notifikasi Masa Berlaku TLS (Beta). Jenis pemberitahuan yang memungkinkan Anda mengirimkan notifikasi saat sertifikat TLS hampir habis masa berlakunya.

Karena API Monitoring sekarang mendukung beberapa jenis pemberitahuan, kotak dialog Buat Pemberitahuan sekarang menampilkan opsi untuk memilih jenis pemberitahuan:

Lihat setelan notifikasi

Untuk melihat setelan pemberitahuan yang saat ini ditentukan, klik Analyze > Alert Rules di UI Edge.

Halaman Notifikasi akan ditampilkan, seperti yang ditampilkan dalam gambar berikut:

Seperti yang disorot dalam gambar, halaman Peringatan memungkinkan Anda untuk:

• Tampilkan ringkasan setelan notifikasi yang saat ini ditentukan
• Melihat histori pemberitahuan yang telah dipicu
• Menambahkan pemberitahuan dan notifikasi
• Membuat laporan kustom dari notifikasi
• Mengaktifkan atau menonaktifkan pemberitahuan
• Mengedit notifikasi
• Menghapus notifikasi
• Menelusuri daftar peringatan untuk string tertentu

Melihat histori pemberitahuan yang telah dipicu untuk organisasi Anda

Untuk melihat histori pemberitahuan yang telah dipicu oleh organisasi Anda selama 24 jam terakhir, klik Analyze > Alert Rules di UI Edge, lalu klik tab History.

Halaman Histori Pemberitahuan akan ditampilkan.

Klik nama notifikasi untuk melihat detail notifikasi di Dasbor investigasi. Anda dapat memfilter daftar dengan menelusuri semua atau sebagian nama notifikasi.

Tambahkan pemberitahuan dan notifikasi

Untuk menambahkan peringatan dan notifikasi:

1. Klik Analyze > Alert Rules di UI Edge.
2. Klik +Alert.
3. Masukkan informasi umum berikut tentang notifikasi:

   Kolom	Deskripsi
   Nama Pemberitahuan	Nama notifikasi. Gunakan nama yang mendeskripsikan pemicu dan yang berarti bagi Anda. Nama tidak boleh lebih dari 128 karakter.
   Jenis Notifikasi	Pilih Tetap. Untuk mendapatkan informasi lebih lanjut tentang jenis pemberitahuan, lihat Tentang jenis pemberitahuan.
   Deskripsi	Deskripsi notifikasi.
   Lingkungan	Pilih lingkungan dari menu dropdown.
   Status	Tekan tombol untuk mengaktifkan atau menonaktifkan notifikasi.

4. Tentukan metrik, nilai minimum, dan dimensi untuk kondisi pertama yang akan memicu pemberitahuan.

   Kolom Kondisi	Deskripsi
   Metrik	Pilih salah satu metrik berikut: Kode Status: Pilih kode status dari daftar, seperti HTTP 401, 404, 2xx, 4xx, atau 5xx. Catatan: API ini memungkinkan Anda menetapkan kode status dengan rentang yang lebih luas. Gunakan API untuk menentukan kode status antara 200-299, 400-599, dan nilai karakter pengganti 2xx, 4xx, atau 5xx. Lihat Membuat Pemberitahuan. Untuk pemberitahuan pembatasan kapasitas (kode status HTTP 429), tetapkan metrik ke Kode kesalahan Spike Arrest. Anda dapat menggunakan kebijakanAssignMessage untuk menulis ulang kode respons HTTP, baik dari error proxy atau error target. Pemantauan API mengabaikan kode yang ditulis ulang dan mencatat kode respons HTTP yang sebenarnya. Latensi: Pilih nilai latensi dari daftar dropdown. Khususnya: p50 (persentil ke-50), p90 (persentil ke-90), p95 (persentil ke-95), atau p99 (persentil 99 jam). Misalnya, pilih p95 untuk menyiapkan pemberitahuan yang akan dipicu saat latensi respons untuk persentil ke-95 lebih besar dari batas yang Anda tetapkan di bawah. Kode Kesalahan: Pilih kategori, subkategori, dan kode kesalahan dari daftar. Atau pilih salah satu dari hal berikut dalam sebuah kategori atau subkategori: Semua - Total gabungan di seluruh kode kesalahan dalam kategori/subkategori ini harus memenuhi kriteria metrik. Apa pun - Satu kode kesalahan dalam kategori/subkategori ini harus memenuhi kriteria metrik. Lihat Referensi kode kesalahan untuk mengetahui informasi selengkapnya. Total traffic (Beta): Pilih peningkatan atau penurunan traffic. Lihat Notifikasi lalu lintas (Beta) untuk mengetahui informasi selengkapnya.
   Nilai minimum	Konfigurasikan nilai minimum untuk metrik yang dipilih: Kode Status: Menetapkan nilai minimum sebagai persentase rasio, jumlah, atau transaksi per detik (TPS) dari waktu ke waktu. Latensi: Pilih nilai minimum sebagai durasi latensi total atau target (md) dari waktu ke waktu. Dalam hal ini, pemberitahuan akan diaktifkan jika latensi yang diamati dan persentil yang ditentukan, yang diperbarui setiap menit jika ada traffic, melebihi kondisi nilai minimum untuk rentang waktu yang mencakup durasi waktu yang ditentukan. Artinya, kondisi ambang batas tidak diagregasi selama durasi purnawaktu. Kode Kesalahan: Menetapkan nilai minimum sebagai persentase rasio, jumlah, atau transaksi per detik (TPS) dari waktu ke waktu.
   Dimensi	Klik +Tambahkan Dimensi lalu tentukan detail dimensi yang hasilnya akan ditampilkan, termasuk proxy API, layanan target, atau aplikasi developer, dan region. Jika Anda menetapkan dimensi tertentu ke: Semua - Semua entitas dalam dimensi harus memenuhi kriteria metrik. Anda tidak dapat memilih Semua untuk metrik dengan jenis Latensi. Apa pun - Hanya berlaku untuk wilayah. Entitas dalam dimensi harus memenuhi kriteria metrik untuk setiap wilayah. Catatan: Untuk proxy atau layanan target API, pilih Koleksi untuk mendukung fungsi Apa pun. Koleksi - Pilih koleksi dari daftar untuk menentukan kumpulan proxy atau layanan target API. Dalam hal ini, entitas apa pun dalam koleksi harus memenuhi kriteria. Jika menetapkan dimensi ke Target, Anda dapat memilih layanan target atau layanan yang ditentukan oleh kebijakan ServiceCallout. Target kebijakan ServiceCallout ditampilkan sebagai nilai yang diawali dengan `sc://`. Misalnya, `sc://my.endpoint.net`.

5. Klik Tampilkan data kondisi untuk menampilkan data terbaru untuk kondisi tersebut selama satu jam terakhir.
   Tingkat error dalam grafik akan berwarna merah jika melebihi nilai minimum kondisi pemberitahuan.
   

   Klik Sembunyikan data kondisi untuk menyembunyikan data.

6. Klik + Tambahkan Kondisi untuk menambahkan kondisi tambahan dan ulangi langkah 4 dan 5.

   Catatan: Jika Anda menetapkan beberapa kondisi, notifikasi akan dipicu saat semua kondisi terpenuhi.

7. Klik Create an API analytics reports based on alert condition jika Anda ingin membuat laporan kustom berdasarkan kondisi pemberitahuan yang Anda konfigurasikan. Opsi ini akan berwarna abu-abu jika Anda bukan administrator organisasi.

   Untuk informasi selengkapnya, lihat Membuat laporan kustom dari notifikasi.

   Catatan: Anda dapat mengubah laporan kustom setelah menyimpan notifikasi, seperti yang dijelaskan dalam Mengelola laporan kustom.

8. Klik + Notifikasi untuk menambahkan notifikasi.

   Detail Notifikasi	Deskripsi
   Channel	Pilih saluran notifikasi yang ingin Anda gunakan dan tentukan tujuannya: Email, Slack, PagerDuty, atau Webhook.
   Destination	Tentukan tujuan berdasarkan jenis saluran yang dipilih: Email - Alamat email, seperti joe@company.com Slack - URL channel Slack, seperti https://hooks.slack.com/services/T00000000/B00000000/XXXXX PagerDuty - Kode PagerDuty, seperti abcd1234efgh56789 Webhook - URL webhook, seperti https://apigee.com/test-webhook. Lihat Format objek webhook untuk mengetahui deskripsi objek yang dikirim ke URL. Teruskan informasi kredensial apa pun di URL webhook. Contoh: https://apigee.com/test-webhook?auth_token=1234_abcd Anda dapat menentukan URL ke endpoint yang dapat mengurai objek webhook untuk mengubah atau memprosesnya. Misalnya, Anda dapat menentukan URL ke API, seperti Edge API, atau ke endpoint lain yang dapat memproses objek. Catatan: Anda hanya dapat menentukan satu tujuan per notifikasi. Guna menentukan beberapa tujuan untuk jenis saluran yang sama, tambahkan notifikasi lainnya.

9. Untuk menambahkan notifikasi lainnya, ulangi langkah 8.
10. Jika Anda menambahkan notifikasi, tetapkan kolom berikut:

    Kolom	Deskripsi
    Playbook	(Opsional) Kolom teks bentuk bebas untuk memberikan deskripsi singkat tentang tindakan yang disarankan guna menyelesaikan notifikasi saat diaktifkan. Anda juga dapat menentukan tautan ke wiki internal atau laman komunitas tempat Anda merujuk pada praktik terbaik. Informasi di kolom ini akan disertakan dalam notifikasi. Konten di kolom ini tidak boleh lebih dari 1500 karakter.
    Gas	Frekuensi yang digunakan untuk mengirimkan notifikasi. Pilih nilai dari daftar dropdown. Nilai yang valid termasuk: 15 menit, 30 menit, dan 1 jam.

11. Klik Simpan.

Format objek webhook

{
  "alertInstanceId": "event-id",
  "alertName": "name",
  "org": "org-name",
  "description": "alert-description",
  "alertId": "alert-id",
  "alertTime": "alert-timestamp",
  "thresholdViolations":{"Count0": "Duration=threshold-duration Region=region Status Code=2xx Proxy=proxy Violation=violation-description"
  },
  "thresholdViolationsFormatted": [
    {
      "metric": "count",
      "duration": "threshold-duration",
      "proxy": "proxy",
      "region": "region",
      "statusCode": "2xx",
      "violation": "violation-description"
    }
  ],
  "playbook": "playbook-link"
}

Properti thresholdViolations dan thresholdViolationsFormatted berisi detail tentang notifikasi. Properti thresholdViolations berisi satu string dengan detailnya, sedangkan thresholdViolationsFormatted berisi objek yang menjelaskan pemberitahuan. Biasanya Anda menggunakan properti thresholdViolationsFormatted karena lebih mudah untuk didekode.

Contoh di atas menampilkan konten properti ini untuk pemberitahuan yang tetap saat Anda mengonfigurasi metrik pemberitahuan yang akan dipicu berdasarkan kode status HTTP 2xx, seperti yang ditunjukkan oleh properti statusCode.

Isi properti ini bergantung pada jenis notifikasi, seperti tetap atau anomali, dan konfigurasi spesifik notifikasi tersebut. Misalnya, jika Anda membuat pemberitahuan tetap berdasarkan kode kesalahan, properti thresholdViolationsFormatted akan berisi properti faultCode, bukan properti statusCode.

Tabel berikut menampilkan semua kemungkinan properti properti thresholdViolationsFormatted untuk berbagai jenis notifikasi:

metric, proxy, target, developerApp,
region, statusCode, faultCodeCategory, faultCodeSubCategory,
faultCode, percentile, comparisonType, thresholdValue,
triggerValue, duration, violation

metric, proxy, target, developerApp,
region, comparisonType, thresholdValue, triggerValue,
duration, violation

metric, proxy, target, region,
statusCode, faultCode, percentile, sensitivity,
violation

envName, certificateName, thresholdValue, violation

Membuat laporan kustom dari notifikasi

Untuk membuat laporan kustom dari notifikasi:

1. Saat membuat pemberitahuan, klik Buat laporan analisis API berdasarkan kondisi pemberitahuan, seperti yang dijelaskan dalam Menambahkan pemberitahuan dan notifikasi.

   Setelah Anda menyimpan pemberitahuan, UI akan menampilkan pesan berikut:

   Alert alertName saved successfully. To customize the report generated, click here.

   Klik pesan untuk membuka laporan di tab baru dengan kolom yang relevan telah diisi sebelumnya. Secara default, laporan kustom diberi nama: API Monitoring Generated alertName

2. Edit laporan kustom sesuai keinginan, lalu klik Simpan.
3. Klik nama laporan pada daftar dan jalankan laporan kustom.

Untuk mengelola laporan kustom yang dibuat berdasarkan kondisi notifikasi:

1. Klik Analyze > Alert Rules di UI Edge.
2. Klik tab Setelan.
3. Di kolom Laporan, klik laporan kustom yang terkait dengan notifikasi yang ingin Anda kelola.

   Halaman laporan kustom akan ditampilkan di tab baru. Jika kolom Laporan kosong, laporan kustom belum dibuat. Anda dapat mengedit notifikasi untuk menambahkan laporan kustom, jika diinginkan.

4. Edit laporan kustom sesuai keinginan, lalu klik Simpan.
5. Klik nama laporan pada daftar dan jalankan laporan kustom.

Mengaktifkan atau menonaktifkan pemberitahuan

Untuk mengaktifkan atau menonaktifkan pemberitahuan:

1. Klik Analyze > Alert Rules di UI Edge.
2. Klik tombol di kolom Status yang terkait dengan pemberitahuan yang ingin Anda aktifkan atau nonaktifkan.
   

Mengedit lansiran

Untuk mengedit sebuah notifikasi:

1. Klik Analyze > Alert Rules di UI Edge.
2. Klik nama notifikasi yang ingin Anda edit.
3. Edit notifikasi, sesuai kebutuhan.
4. Klik Simpan.

Menghapus lansiran

Untuk menghapus notifikasi:

1. Klik Analyze > Alert Rules di UI Edge.
2. Arahkan kursor ke pemberitahuan yang ingin dihapus, lalu klik di menu tindakan.

Pemberitahuan yang disarankan

Apigee menyarankan agar Anda menyiapkan pemberitahuan berikut agar diberi tahu tentang masalah umum. Beberapa pemberitahuan ini khusus untuk implementasi API Anda dan hanya berguna dalam situasi tertentu. Misalnya, beberapa notifikasi yang ditampilkan di bawah hanya berlaku jika Anda menggunakan kebijakan ServiceCallout atau kebijakan JavaCallout.

Menyiapkan peringatan kode status 5xx untuk proxy API

Berikut contoh cara menyiapkan pemberitahuan menggunakan UI yang dipicu saat transaksi per detik (TPS) dari kode status 5xx untuk proxy API hotel melebihi 100 selama 10 menit untuk wilayah mana pun. Untuk mengetahui informasi selengkapnya, lihat Menambahkan pemberitahuan dan notifikasi.

Untuk informasi tentang penggunaan API, lihat Menyiapkan peringatan kode status 5xx untuk proxy menggunakan API.

Menyiapkan pemberitahuan latensi P95 untuk proxy API

Berikut contoh cara menyiapkan pemberitahuan menggunakan UI yang dipicu saat latensi respons total untuk persentil ke-95 lebih besar dari 100 milidetik selama 5 menit untuk proxy API hotel untuk region mana pun. Untuk mengetahui informasi selengkapnya, lihat Menambahkan pemberitahuan dan notifikasi.

Untuk informasi tentang cara menggunakan API, lihat Menyiapkan pemberitahuan latensi P95 untuk proxy API menggunakan API

Menyiapkan pemberitahuan 404 (Aplikasi Tidak Ditemukan) untuk semua proxy API

Berikut adalah contoh cara menyiapkan pemberitahuan menggunakan UI yang dipicu saat persentase kode status 404 untuk semua proxy API melebihi 5% selama 5 menit untuk region mana pun. Untuk mengetahui informasi selengkapnya, lihat Menambahkan pemberitahuan dan notifikasi.

Untuk informasi tentang penggunaan API, lihat Menyiapkan pemberitahuan 404 (Aplikasi Tidak Ditemukan) untuk semua proxy API yang menggunakan API.

Menyiapkan pemberitahuan jumlah proxy API untuk API

Berikut ini contoh cara menyiapkan pemberitahuan menggunakan UI yang dipicu saat jumlah kode 5xx untuk API melebihi 200 selama 5 menit untuk region mana pun. Dalam contoh ini, API ditangkap dalam kumpulan Proxy API Penting. Untuk informasi selengkapnya, lihat:

• Menambahkan pemberitahuan dan notifikasi
• Mengelola koleksi

Untuk informasi tentang penggunaan API, lihat Menyiapkan pemberitahuan jumlah proxy API untuk API menggunakan API.

Menyiapkan pemberitahuan tingkat error untuk layanan target

Berikut contoh cara menyiapkan pemberitahuan menggunakan UI yang dipicu saat tarif kode 500 untuk layanan target melebihi 10% selama 1 jam untuk region mana pun. Dalam contoh ini, layanan target tercakup dalam kumpulan Target penting. Untuk informasi selengkapnya, lihat:

• Menambahkan pemberitahuan dan notifikasi
• Mengelola koleksi

Untuk informasi tentang penggunaan API, lihat Menyiapkan pemberitahuan tingkat error untuk layanan target menggunakan API.

Menyiapkan pemberitahuan tingkat error untuk kebijakan ServiceInfo

Berikut contoh cara menyiapkan pemberitahuan menggunakan UI yang dipicu saat tarif kode 500 untuk layanan yang ditentukan oleh kebijakan ServiceCallout melebihi 10% selama 1 jam untuk wilayah mana pun. Untuk informasi selengkapnya, lihat:

• Menambahkan pemberitahuan dan notifikasi

Untuk mengetahui informasi tentang cara menggunakan API, lihat Menyiapkan pemberitahuan tingkat error untuk kebijakan Info Layanan menggunakan API.

Menyiapkan peringatan kode kesalahan kebijakan

Berikut ini contoh cara menyiapkan pemberitahuan menggunakan UI yang dipicu saat jumlah kode kesalahan JWT AlgorithmMismatch untuk kebijakan VerifyJWT lebih besar dari 5 selama 10 menit untuk semua API. Untuk informasi selengkapnya, lihat:

• Menambahkan pemberitahuan dan notifikasi
• Mengelola koleksi

Untuk mengetahui informasi tentang penggunaan API, lihat Menyiapkan pemberitahuan kode kesalahan untuk kode kesalahan kebijakan menggunakan API.