Mengintegrasikan Pemberitahuan Alert dengan Sistem IM

Pendahuluan

Dalam lingkungan bisnis yang terdigitalisasi saat ini, pemantauan dan peringatan memainkan peran yang sangat penting. Tidak hanya membantu perusahaan mendeteksi anomali sistem secara tepat waktu, tetapi juga secara efektif mengurangi kerugian bisnis yang disebabkan oleh gangguan. API7 Enterprise menawarkan berbagai aturan peringatan, memungkinkan pengguna untuk menetapkan strategi peringatan yang fleksibel. Melalui metode notifikasi template Webhook, informasi peringatan dikirim ke sistem Pesan Instan (IM) yang biasa kita gunakan. Ini membantu kita memantau status operasional sistem dengan cepat dan efektif, memungkinkan respons yang tepat waktu dan memastikan kelangsungan dan stabilitas bisnis.

Sekarang, mari kita bahas lebih dalam tentang bagaimana menggunakan API7 Enterprise untuk mengonfigurasi aturan peringatan dan mengirim informasi peringatan ke sistem IM yang ada melalui Webhook, membantu Anda dengan mudah menguasai proses konfigurasi untuk skenario ini.

Aturan Peringatan dan Notifikasi

1. Strategi Peringatan

API7 Enterprise saat ini mendukung berbagai strategi peringatan, memungkinkan pengguna untuk mengonfigurasi secara fleksibel berdasarkan kebutuhan bisnis. Strategi peringatan umum meliputi:

• Memicu peringatan ketika sertifikat hampir kedaluwarsa.
• Memicu peringatan ketika instance gateway offline.
• Memicu peringatan berdasarkan jumlah kode status 4xx dan 5xx.
• Memicu peringatan berdasarkan rasio kode status 4xx dan 5xx.

Dalam aplikasi praktis, beberapa strategi dapat digabungkan untuk memenuhi berbagai kebutuhan peringatan, memastikan peringatan otomatis terpicu dan memberi tahu personel terkait, sehingga meningkatkan kecepatan respons dan efisiensi penyelesaian gangguan.

2. Definisi dan Manajemen Tingkat Peringatan

Tingkat peringatan mengklasifikasikan dan mengidentifikasi situasi peringatan yang berbeda, memungkinkan pengguna untuk dengan jelas mengenali pentingnya peringatan. Tingkat peringatan umum meliputi tinggi, sedang, dan rendah. Administrator menetapkan tingkat peringatan yang berbeda untuk memastikan peringatan penting mendapatkan perhatian dan penanganan yang tepat waktu. API7 Enterprise mendukung pengguna dalam mengonfigurasi dan mengelola tingkat peringatan dengan mudah untuk memenuhi kebutuhan pemantauan dalam berbagai skenario.

3. Mekanisme Notifikasi Peringatan

Kita dapat membuat template Webhook di API7 Enterprise. Ketika sistem mendeteksi anomali dan memicu peringatan, API7 Enterprise secara otomatis memanggil alamat Webhook yang telah dikonfigurasi sebelumnya. Ini mengirim informasi peringatan dalam bentuk permintaan HTTP POST ke alamat tujuan yang ditentukan. Webhook adalah teknologi yang umum digunakan untuk komunikasi antar aplikasi, memungkinkan pengguna untuk secara otomatis mengirim data ke URL tertentu ketika peristiwa tertentu terjadi.

Sistem IM populer seperti Slack, Microsoft Teams, Lark, DingTalk, dan WeCom menyediakan robot Webhook untuk mengirim dan menerima pesan. Di bawah ini, kita menggunakan Lark sebagai contoh untuk merinci bagaimana mengintegrasikan notifikasi peringatan dengan API7 Enterprise.

Integrasi dengan Robot Webhook Sistem IM

Robot Webhook dalam sistem IM adalah akun khusus yang digunakan untuk mengirim pesan secara otomatis, memberi tahu peristiwa, atau melakukan operasi tertentu. Dengan mengonfigurasi notifikasi template Webhook API7 Enterprise untuk mengintegrasikan dengan alamat robot Webhook dalam sistem IM, push otomatis informasi peringatan dapat dicapai, sangat meningkatkan real-time dan akurasi notifikasi peringatan.

Mengonfigurasi Robot Webhook Lark

1. Pertama, kita perlu membuat dan mengonfigurasi robot Webhook di Lark. Dalam grup yang sesuai, temukan opsi untuk menambahkan robot grup. Kemudian kita dapat melihat opsi untuk Custom Bot.

2. Setelah menambahkan avatar dan deskripsi yang relevan untuk robot, klik Next, dan Anda akan melihat alamat Webhook. Alamat ini digunakan untuk menerima informasi peringatan.

3. Tergantung pada kebutuhan Anda, Anda dapat menetapkan beberapa aturan kebijakan keamanan untuk robot Anda, seperti kata kunci, whitelist IP, dan lainnya.

Mengonfigurasi Aturan Peringatan di API7 Enterprise

1. Di API7 Enterprise, tambahkan strategi peringatan dan tentukan kondisi pemicu.

2. Konfigurasi template notifikasi Webhook:

{ "msg_type": "text", "content": { "text": "API7 EE Alarm: 4xx error" } }

3. Untuk memudahkan pengujian di masa depan, kita ubah interval pemeriksaan peringatan menjadi 1 menit.

4. Aktifkan strategi peringatan dan notifikasi Webhook yang sesuai.

5. Kirim permintaan dengan kode status 401 untuk memicu peringatan:

curl -i http://127.0.0.1:9080/get

HTTP/1.1 401 Unauthorized
...
{"message":"Missing API key found in request"}

6. Selanjutnya, Anda akan melihat pesan peringatan yang sesuai dikirim oleh robot Webhook di grup Lark.

Penggunaan Lanjutan

API7 Enterprise mendukung pengiriman variabel konteks peringatan melalui Webhook. Variabel umum meliputi:

• Judul: {{ .Title }} Judul Peringatan
• Tingkat Keparahan: {{ .Severity }} Tingkat Keparahan Peringatan
• Detail: {{ .Detail }} Deskripsi Peringatan
• AlertEvents: {{ .AlertEvents.XXX }} Peristiwa peringatan yang sesuai berdasarkan pengaturan kebijakan yang berbeda.

Kesimpulan

API7 Enterprise menawarkan banyak fitur yang kuat, memberikan kemudahan dan dukungan untuk pemantauan dan manajemen API perusahaan. Dengan menggunakan mekanisme notifikasi peringatan Webhook yang terintegrasi dengan sistem IM, informasi peringatan dapat disampaikan dengan cepat dan akurat kepada personel terkait, meningkatkan kecepatan dan kualitas respons terhadap gangguan. Ini membawa pengalaman pemantauan dan manajemen yang lebih efisien dan andal bagi perusahaan.