Menyiapkan pemberitahuan dan notifikasi

Anda sedang melihat dokumentasi Apigee Edge.
Lihat dokumentasi Apigee X.

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

Misalnya, Anda mungkin ingin memicu pemberitahuan dan mengirimkan pemberitahuan ke tim Operasi ketika tingkat kesalahan 5xx melebihi 23% selama 5 menit untuk proxy API pesanan yang di-deploy ke lingkungan produksi.

Gambar berikut menunjukkan bagaimana pemberitahuan ditampilkan di UI:

Berikut adalah contoh notifikasi email yang mungkin Anda terima saat notifikasi dipicu.

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

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

Bagian berikut menjelaskan cara menyiapkan serta mengelola notifikasi dan notifikasi.

Tentang jenis notifikasi

Rilis awal API Monitoring memungkinkan Anda membuat aturan berbasis pola, yang menentukan kapan pemberitahuan akan dimunculkan berdasarkan serangkaian kondisi yang telah ditentukan. Jenis notifikasi ini disebut pemberitahuan tetap dan merupakan satu-satunya jenis notifikasi yang didukung dalam rilis awal Pemantauan API.

Misalnya, Anda dapat meningkatkan pemberitahuan tetap ketika:

• [rate of 5xx errors] [lebih besar dari] [10%] selama [10 menit] dari [target mytarget1]
• [count of 2xx errors] [kurang dari] [50] selama [5 menit] di [region us-east-1]
• [p90 latensi] [lebih dari] [750 md] selama [10 menit] di [proxy myproxy1]

Rilis Beta Keamanan 19.11.13 menambahkan jenis notifikasi baru:

• Notifikasi Total traffic (Beta). Jenis notifikasi yang memungkinkan Anda mengaktifkan pemberitahuan saat traffic berubah persentase tertentu selama rentang waktu tertentu.
• Notifikasi Anomali (Beta). Jenis peringatan yang memungkinkan Edge mendeteksi masalah traffic dan performa, bukan mengharuskan Anda menentukannya sendiri terlebih dahulu. Anda kemudian dapat mengaktifkan notifikasi untuk anomali tersebut.
• Pemberitahuan Masa Berlaku TLS (Beta). Jenis pemberitahuan yang memungkinkan Anda menampilkan notifikasi saat sertifikat TLS hampir habis masa berlakunya.

Karena Pemantauan API kini mendukung beberapa jenis pemberitahuan, kotak dialog Buat Notifikasi kini menampilkan opsi untuk memilih jenis pemberitahuan:

Melihat setelan notifikasi

Untuk melihat setelan pemberitahuan yang saat ini ditentukan, klik Analisis > Aturan Pemberitahuan di UI Edge.

Halaman Notifikasi akan ditampilkan, seperti yang ditunjukkan pada gambar berikut:

Sebagaimana disorot dalam gambar, halaman Notifikasi memungkinkan Anda:

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

Melihat histori notifikasi yang telah dipicu untuk organisasi Anda

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

Halaman Histori Notifikasi ditampilkan.

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

Menambahkan pemberitahuan dan notifikasi

Untuk menambahkan notifikasi dan notifikasi:

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

   Kolom	Deskripsi
   Nama Pemberitahuan	Nama notifikasi. Gunakan nama yang menjelaskan pemicu yang akan berarti bagi Anda. Nama tidak boleh melebihi 128 karakter.
   Jenis Notifikasi	Pilih Tetap. Untuk informasi selengkapnya tentang jenis notifikasi, lihat Tentang jenis notifikasi.
   Deskripsi	Deskripsi notifikasi.
   Lingkungan	Pilih lingkungan dari daftar dropdown.
   Status	Alihkan 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 menyetel rentang kode status yang lebih luas. Gunakan API untuk menentukan kode status antara 200-299, 400-599, dan nilai karakter pengganti 2xx, 4xx, atau 5xx. Baca bagian Membuat Notifikasi. Untuk peringatan pembatasan kapasitas (kode status HTTP 429), setel metrik ke Spike Arrest code. Anda dapat menggunakan kebijakan TetapkanMessage 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. Secara khusus: p50 (persentil ke-50), p90 (persentil ke-90), p95 (persentil ke-95), atau p99 (persentil ke-99). Misalnya, pilih p95 untuk menyiapkan pemberitahuan yang 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 opsi berikut dalam kategori atau subkategori: Semua - Total gabungan di seluruh kode kesalahan dalam kategori/subkategori ini harus memenuhi kriteria metrik. Apa pun - Kode kesalahan tunggal dalam kategori/subkategori ini harus memenuhi kriteria metrik. Lihat Referensi kode kesalahan untuk informasi selengkapnya. Total traffic (Beta): Pilih peningkatan atau penurunan traffic. Lihat pemberitahuan Traffic (Beta) untuk mengetahui info selengkapnya.
   Ambang batas	Konfigurasikan nilai minimum untuk metrik yang dipilih: Kode Status: Tetapkan nilai minimum sebagai rasio persentase, jumlah, atau transaksi per detik (TPS) dari waktu ke waktu. Latensi: Pilih ambang batas sebagai total atau durasi latensi target (md) dari waktu ke waktu. Dalam kasus ini, notifikasi akan diaktifkan jika persentil yang ditentukan diamati dengan latensi, yang diperbarui setiap menit jika traffic ada, melebihi kondisi nilai minimum untuk rentang waktu yang mencakup durasi waktu yang ditentukan. Artinya, kondisi nilai minimum tidak digabungkan selama durasi penuh. Kode Kesalahan: Menetapkan ambang batas sebagai rasio persentase, jumlah, atau transaksi per detik (TPS) dari waktu ke waktu.
   Dimensi	Klik +Tambahkan Dimensi dan tentukan detail dimensi untuk menampilkan hasil, termasuk proxy API, layanan target, atau aplikasi developer, dan wilayah. Jika Anda menetapkan dimensi tertentu ke: Semua - Semua entitas dalam dimensi harus memenuhi kriteria metrik. Anda tidak dapat memilih Semua untuk metrik jenis Latensi. Apa pun - Hanya berlaku untuk wilayah. Entitas dalam dimensi harus memenuhi kriteria metrik untuk setiap wilayah. Catatan: Untuk proxy API atau layanan target, pilih Koleksi untuk mendukung fungsi apa pun. Koleksi - Pilih koleksi dari daftar untuk menentukan kumpulan proxy API atau layanan target. Dalam hal ini, entitas apa pun dalam koleksi harus memenuhi kriteria. Jika menyetel dimensi ke Target, Anda dapat memilih layanan target atau layanan yang ditentukan berdasarkan kebijakan ServiceInfo. Target kebijakan ServiceInfo ditampilkan sebagai nilai yang diawali dengan `sc://`. Misalnya, `sc://my.endpoint.net`.

5. Klik Tampilkan data kondisi untuk menampilkan data kondisi terbaru dalam satu jam terakhir.
   Rasio error pada grafik akan ditampilkan dengan warna merah jika melebihi batas kondisi pemberitahuan.
   

   Klik Sembunyikan data kondisi untuk menyembunyikan data.

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

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

7. Klik Buat laporan analisis API berdasarkan kondisi pemberitahuan jika Anda ingin membuat laporan kustom berdasarkan kondisi pemberitahuan yang Anda konfigurasikan. Opsi ini 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 pemberitahuan.

   Detail Notifikasi	Deskripsi
   Saluran	Pilih saluran notifikasi yang ingin digunakan dan tentukan tujuannya: Email, Slack, PagerDuty, atau Webhook.
   Destination	Tentukan tujuan berdasarkan jenis saluran yang dipilih: Email - Alamat email, misalnya 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. Lihat Format objek webhook untuk mengetahui deskripsi objek yang dikirim ke URL. Teruskan informasi kredensial apa pun di URL webhook. Misalnya: 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 tambahan.

9. Untuk menambahkan notifikasi tambahan, 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 untuk menyelesaikan notifikasi saat diaktifkan. Anda juga dapat menentukan link ke halaman wiki internal atau komunitas tempat Anda mereferensikan praktik terbaik. Informasi di kolom ini akan disertakan dalam notifikasi. Isi kolom ini tidak boleh lebih dari 1.500 karakter.
    Gas	Frekuensi yang digunakan untuk mengirimkan notifikasi. Pilih nilai dari menu dropdown. Nilai yang valid meliputi: 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 pemberitahuan. Properti thresholdViolations berisi satu string dengan detail, sedangkan thresholdViolationsFormatted berisi objek yang menjelaskan pemberitahuan. Biasanya Anda menggunakan properti thresholdViolationsFormatted karena lebih mudah untuk didekode.

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

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

Tabel berikut menunjukkan semua kemungkinan properti dari properti thresholdViolationsFormatted untuk jenis notifikasi yang berbeda:

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 notifikasi, klik Buat laporan analisis API berdasarkan kondisi notifikasi, seperti yang dijelaskan dalam Menambahkan notifikasi dan notifikasi.

   Setelah Anda menyimpan pemberitahuan, UI akan menampilkan pesan berikut:

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

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

2. Edit laporan kustom, seperti yang diinginkan, lalu klik Simpan.
3. Klik nama laporan dalam 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 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, seperti yang diinginkan, lalu klik Simpan.
5. Klik nama laporan dalam daftar dan jalankan laporan kustom.

Mengaktifkan atau menonaktifkan notifikasi

Untuk mengaktifkan atau menonaktifkan notifikasi:

1. Klik Analyze > Alert Rules di UI Edge.
2. Klik tombol di kolom Status yang terkait dengan notifikasi yang ingin diaktifkan atau dinonaktifkan.
   

Mengedit lansiran

Untuk mengedit notifikasi:

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

Menghapus lansiran

Untuk menghapus notifikasi:

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

Pemberitahuan yang disarankan

Apigee menyarankan agar Anda menyiapkan pemberitahuan berikut untuk mendapatkan pemberitahuan tentang masalah umum. Beberapa notifikasi ini khusus untuk penerapan API dan hanya berguna dalam situasi tertentu. Misalnya, beberapa pemberitahuan yang ditampilkan di bawah ini hanya berlaku jika Anda menggunakan kebijakan ServiceInfo atau kebijakan JavaInfo.

Menyiapkan notifikasi kode status 5xx untuk proxy API

Berikut ini adalah 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 notifikasi dan notifikasi.

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

Menyiapkan pemberitahuan latensi P95 untuk proxy API

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

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

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

Berikut ini 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 notifikasi dan notifikasi.

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

Menyiapkan pemberitahuan jumlah proxy API untuk API

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

• Menambahkan notifikasi dan notifikasi
• Mengelola koleksi

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

Siapkan notifikasi rasio error untuk layanan target

Berikut ini adalah contoh cara menyiapkan pemberitahuan menggunakan UI yang dipicu saat tarif kode 500 untuk layanan target melampaui 10% selama 1 jam untuk wilayah mana pun. Dalam contoh ini, layanan target diambil dalam kumpulan target Kritis. Untuk informasi selengkapnya, lihat:

• Menambahkan notifikasi dan notifikasi
• Mengelola koleksi

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

Menyiapkan notifikasi rasio error untuk kebijakan ServiceInfo

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

• Menambahkan notifikasi dan notifikasi

Untuk informasi tentang penggunaan API, lihat Menyiapkan notifikasi tingkat error untuk kebijakan Info Layanan menggunakan API.

Menyiapkan notifikasi kode kesalahan kebijakan

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

• Menambahkan notifikasi dan notifikasi
• Mengelola koleksi

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