Application Real-Time Monitoring Service：Integrasikan sumber peringatan kustom dengan ARMS

Langkah 1: Buat integrasi kustom

1. Masuk ke Konsol ARMS. Di panel navigasi di sebelah kiri, pilih Alert Management > Integrations.

2. Pada tab Alert Integration, klik Custom Integration.

3. Di kotak dialog Create Custom Event Integration, masukkan nama untuk integrasi, tentukan periode waktu setelah peringatan dihapus, masukkan deskripsi berdasarkan kebutuhan bisnis Anda, lalu klik Save and Configure.

   Catatan

   Waktu pemulihan otomatis setelah batas waktu: Jika peristiwa peringatan tidak dipicu lagi dalam periode waktu tertentu, peristiwa peringatan akan secara otomatis dihapus.

Langkah 2: Konfigurasikan titik akhir API

Anda dapat mengonfigurasi titik akhir API untuk memungkinkan sumber peringatan pihak ketiga melaporkan peristiwa peringatan ke ARMS.

1. Di bagian Span Configuration pada halaman Integration Details, salin titik akhir API dan Kunci API.

   

2. Akses titik akhir API dari sumber peringatan pihak ketiga untuk melaporkan peristiwa peringatan.

   Berikut adalah contoh peristiwa peringatan yang dilaporkan:

   curl -k -H "Content-Type: application/json" -d '{
     "trigger-type": "network",
     "trigger-location": "cn-hangzhou",
     "trigger-severity": "MAX",
     "trigger-policy": "package errors > 5%",
     "trigger-event": "inbound tcp package errors is 20%",
     "trigger-check": "tcp package error percentage",
     "trigger-value": "20",
     "trigger-time": "1629702922000",
     "metadata": [
       {
         "agent": "SERVER",
         "ip": "141.219.XX.XX",
         "fqdn": "websrv1.damenport.org",
         "microServiceId": "ms-login-2251",
         "accountId": "1504000433993",
         "service": "login-0"
       },
       {
         "agent": "CONTAINER",
         "ip": "172.1.XX.XX",
         "fqdn": "websrv2.damenport.org",
         "microServiceId": "ms-login-2252",
         "accountId": "129930302939",
         "service": "login-1"
       }
     ],
     "equipments": [
       {
         "equipmentId": "112"
       },
       {
         "equipmentId": "113"
       }
     ]
   }' "https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN******"

   Jika Anda menjalankan perintah curl untuk melaporkan peristiwa peringatan untuk pertama kalinya, pesan kesalahan berikut akan dikembalikan:

   { "requestId":null,"traceId":"0bc3b4a********71e4aa7","code":601,"data":{},"success":false,"errorCode":"Invalidincident,labels.alertnameisrequired","message":"Invalidincident,labels.alertnameisrequired","httpStatusCode":601,"errorCodeParams":null,"dynamicMessage":null

   Anda harus mengonfigurasi pemetaan bidang peringatan terlebih dahulu. Kemudian, data akan dikembalikan sesuai harapan. Untuk informasi lebih lanjut, lihat Langkah 3.

   Anda juga dapat menggunakan data uji untuk melaporkan peristiwa peringatan. Pertama kali Anda menggunakan data uji untuk melaporkan peristiwa peringatan, pesan berikut muncul. Anda perlu mengonfigurasi pemetaan bidang peringatan seperti yang diminta. Untuk informasi lebih lanjut, lihat Langkah 3.

Langkah 3: Konfigurasikan pemetaan bidang peringatan

Di bagian Event Mapping, konfigurasikan pemetaan bidang antara sumber peringatan pihak ketiga dan ARMS.

Skenario berikut digunakan sebagai contoh:

Skenario: Kesalahan paket TCP terjadi pada server.

Berikut ini adalah deskripsi peristiwa peringatan yang dilaporkan oleh sumber peringatan pihak ketiga:

{
  "trigger-type": "network",    //Jenis peristiwa: jaringan.
  "trigger-location": "cn-hangzhou",    //Wilayah tempat peristiwa terjadi.
  "trigger-severity": "MAX",    //Tingkat keparahan peristiwa, seperti MAX, MID, dan LOW.
  "trigger-policy": "package errors > 5%",     //Kebijakan pemicu.
  "trigger-event": "inbound tcp package errors is 20%",    //Isi peristiwa: Tingkat kesalahan paket TCP arah masuk adalah 20%.
  "trigger-check": "tcp package error percentage",    //Item pemeriksaan peristiwa: tingkat kesalahan paket TCP.
  "trigger-value": "20",    //Nilai sampel peristiwa peringatan.
  "trigger-time": "1629702922000",    //Waktu mulai peristiwa peringatan.
  "metadata": [
    {
      "agent": "SERVER",    //Jenis agen: SERVER.
      "ip": "141.219.XX.XX",   //Alamat IP.
      "fqdn": "websrv1.damenport.org",    //Nama domain.
      "microServiceId": "ms-login-2251",    //ID layanan mikro. Jika nilai bidang agen adalah CONTAINER, bidang ini dipetakan ke bidang layanan.
      "accountId": "1504000433993",    //ID pengguna. ID pengguna tidak termasuk dalam notifikasi peringatan.
      "service": "login-0" //ID layanan. Jika nilai bidang agen adalah SERVER, bidang ini dipetakan ke bidang layanan.
    },
    {
      "agent": "CONTAINER",   //Jenis agen: CONTAINER.
      "ip": "172.1.XX.XX",  //Alamat IP.
      "fqdn": "websrv2.damenport.org",    //Nama domain.
      "microServiceId": "ms-login-2252",   //ID layanan mikro. Jika nilai bidang agen adalah CONTAINER, bidang ini dipetakan ke bidang layanan.
      "accountId": "129930302939",  //ID pengguna. ID pengguna tidak termasuk dalam notifikasi peringatan.
      "service": "login-1"    //ID layanan. Jika nilai bidang agen adalah SERVER, bidang ini dipetakan ke bidang layanan.
    }
  ],
  "equipments": [  //Node array lainnya.
    {
      "equipmentId": "112"
    },
    {
      "equipmentId": "113"
    }
  ]
}

1. Di bagian Event Mapping, klik Send Test Data.

2. Di kotak dialog Send Test Data, masukkan konten peringatan dari sumber peringatan pihak ketiga dalam format JSON dan klik Send.

   Catatan

   • Jika pesan Uploaded. No events are generated. Configure mappings based on the original data. muncul, bidang sumber peringatan belum dipetakan ke bidang peristiwa peringatan ARMS. Data yang dikirim ditampilkan di kotak di sebelah kiri. Ini memungkinkan Anda memilih bidang sumber saat mengonfigurasi pemetaan.

   • Jika pesan Uploaded. muncul, konten peringatan dilaporkan ke halaman Riwayat Peristiwa Peringatan. Untuk informasi lebih lanjut, lihat Lihat Peristiwa Peringatan Historis.

   

3. Di kotak dialog Send Test Data, klik Disable.

4. Di bagian kiri Event Mapping, klik catatan data yang ingin Anda konfigurasikan pemetaannya untuk melihat detailnya.

5. Di bagian kanan Event Mapping, konfigurasikan pemetaan bidang antara sumber peringatan dan ARMS.

   1. Opsional:Di bagian Select Root Node, tentukan apakah akan mengaktifkan pemrosesan batch.

      Jika node array ada dalam data peringatan, Anda dapat menentukan node array sebagai node root. Data yang termasuk dalam node root diproses secara batch.

      Setelah Anda memilih Gunakan Pemrosesan Batch, pilih node array yang akan diproses sebagai node root.

      Catatan

      Jika beberapa node array ada dalam data peringatan, Anda hanya dapat memilih salah satu node array untuk pemrosesan batch.

      Dalam contoh sebelumnya, node array metadata berisi dua bidang layanan. Jika Anda memilih metadata sebagai node root, nilai-nilai bidang layanan dipetakan ke bidang peringatan ARMS yang ditentukan.

      • Jika Anda memilih node array sebagai node root, nilai semua bidang $.metadata[*].service dalam node array diiterasi dan dipetakan ke bidang layanan ARMS.

      • Jika Anda tidak memilih node array sebagai node root, Anda dapat memilih untuk memetakan nilai $.metadata[0].service atau $.metadata[1].service dalam node array ke bidang layanan ARMS.

   2. Opsional:Pilih Configure Alert Recovery Events dan konfigurasikan kondisi bidang untuk menghapus peringatan.

      Setelah ARMS menerima peristiwa, ia mencari peringatan yang berisi nilai bidang tertentu dan menghapus peringatan tersebut. Bidang yang Anda tentukan untuk menghapus peringatan harus merupakan bidang yang setara dengan tingkat keparahan peringatan dalam peristiwa. Anda tidak dapat menggunakan bidang $.severity untuk menghapus peringatan. Misalnya, jika bidang yang Anda tentukan untuk menghapus peringatan adalah {$.eventType ="resolved"}, sistem secara otomatis menghapus semua peringatan yang nilainya eventType adalah resolved dalam integrasi.

   3. Pada bagian Map Source Fields to Target Fields, petakan bidang sumber peringatan ke bidang peringatan ARMS.

      Klik ikon Peta untuk mengubah metode pemetaan bidang.

      • Langsung: Bidang tertentu dari sumber peringatan dipetakan ke bidang peringatan ARMS yang ditentukan.

      • Seri: Anda dapat menggunakan pemisah untuk menggabungkan beberapa bidang sumber peringatan menjadi satu bidang, lalu memetakan bidang ini ke bidang peringatan ARMS yang ditentukan. Hanya karakter khusus yang dapat digunakan sebagai pemisah.

        Misalnya, Anda dapat menggunakan garis bawah (_) untuk menggabungkan bidang $.trigger-type dan $.trigger-policy ke bidang $.trigger-type_$.trigger-policy dan kemudian memetakan bidang tersebut ke bidang alertname ARMS.

      • Kondisi: Jika nilai bidang tertentu dari sumber peringatan memenuhi kondisi tertentu, bidang tersebut dipetakan ke bidang peringatan ARMS yang ditentukan.

        Misalnya, Anda dapat mengonfigurasi pemetaan bersyarat berikut: Jika nilai bidang agen dalam node array metadata adalah CONTAINER, petakan nilai bidang microServiceId ke bidang layanan ARMS. Jika nilai bidang agen adalah SERVER, petakan nilai bidang layanan dalam node array metadata ke bidang layanan ARMS.

        

      • Tabel pemetaan: Anda harus mengonfigurasi tabel pemetaan yang memetakan tingkat keparahan sumber peringatan ke tingkat keparahan peringatan ARMS. Anda hanya perlu mengonfigurasi tabel pemetaan untuk bidang keparahan.

      Tabel berikut menjelaskan bidang peringatan ARMS.

      Bidang peringatan	Deskripsi	Contoh metode pemetaan	Contoh bidang sumber peringatan
      alertname	Nama peringatan kustom.	Seri	$.trigger-type dan $.trigger-policy
      severity	Tingkat peringatan. Anda harus mengonfigurasi pemetaan untuk bidang ini. Metode pemetaan harus diatur ke Langsung.	Metode pemetaan: Langsung (wajib) Tabel pemetaan: MAX: P1 MID: P2 MIN: P3	$.trigger-severity
      message	Deskripsi peringatan. Deskripsi digunakan sebagai isi pesan peringatan. Deskripsi tidak boleh melebihi 15.000 karakter.	Langsung	$.trigger-event
      value	Nilai sampel dari data deret waktu.	Langsung	$.trigger-value
      imageUrl	URL grafik garis yang berisi metrik Grafana. URL digunakan untuk memetakan grafik garis.	Tidak ada	Tidak ada
      check	Item pemeriksaan peringatan. Contoh: CPU, JVM, Crash Aplikasi, dan Penyebaran.	Langsung	$.trigger-check
      source	Sumber peringatan.	Langsung	$.metadata[*].ip
      class	Jenis objek yang memicu peristiwa peringatan, misalnya host.	Langsung	$.trigger-type
      service	Layanan sumber peringatan. Contoh: Layanan Login.	Kondisi	Jika nilai bidang $.metadata[*].agen adalah CONTAINER, nilai bidang $.metadata[*].microServiceId dipetakan ke bidang layanan ARMS. Jika nilai bidang $.metadata[*].agen adalah SERVER, nilai bidang $.metadata[*].layanan dipetakan ke bidang layanan ARMS.
      startat	Timestamp yang mewakili waktu mulai peristiwa.	Langsung	$.trigger-time
      endat	Timestamp yang mewakili waktu akhir peristiwa.	Tidak ada	Tidak ada
      URL Peristiwa (generatorUrl)	URL detail peristiwa.	Tidak ada	Tidak ada

      

Langkah 4: Konfigurasikan penghapusan duplikat

Untuk mengurangi data duplikat, sistem menggunakan bidang terkait sebagai dasar untuk penghapusan duplikat. Manajemen Peringatan ARMS memungkinkan Anda melihat hasil pengelompokan penghapusan duplikat dari data peristiwa historis yang ditampilkan di bagian Event Mapping. Anda dapat mengubah bidang yang nilainya ingin dihapus duplikatnya.

1. Di bagian Event Deduplication, pilih bidang yang nilainya ingin dihapus duplikatnya.

   Jika beberapa peristiwa memiliki nilai yang sama untuk bidang tertentu, peristiwa tersebut digabungkan menjadi satu notifikasi peringatan.

   Dalam contoh ini, bidang $.metadata[*].ip dipetakan ke bidang source, dan bidang $.trigger-check dipetakan ke bidang check. Anda dapat menentukan source dan check sebagai bidang yang digunakan untuk menghapus duplikat peristiwa. Dengan cara ini, peristiwa yang memiliki alamat IP dan item pemeriksaan yang sama digabungkan menjadi satu peristiwa. Peristiwa yang memiliki alamat IP atau item pemeriksaan berbeda tidak digabungkan.

2. Klik Deduplication Test untuk melihat kelompok peringatan setelah penghapusan duplikat.

   Catatan

   Uji penghapusan duplikat hanya berlaku untuk 10 catatan data terbaru yang diunggah di bagian kiri Event Mapping.

   

3. Klik Save.

Verifikasi hasil

Setelah Anda menyelesaikan operasi sebelumnya, Anda dapat melihat integrasi yang Anda buat di halaman Integrations.

Kelola integrasi kustom

Di panel navigasi di sebelah kiri, pilih Alert Management > Integrations. Pada tab Alert Integration, Anda dapat melakukan operasi berikut pada integrasi yang Anda buat:

• Lihat detail integrasi: Temukan integrasi lalu klik baris tersebut. Di halaman Integration Details, lihat detail integrasi.

• Perbarui kunci: Temukan integrasi lalu pilih More > Update Key di kolom Actions. Di pesan yang muncul, klik OK.

  Penting

  Setelah Anda memperbarui kunci, modifikasi titik akhir di sumber peringatan yang ditentukan dalam Langkah 2.

• Ubah integrasi: Temukan integrasi lalu klik Edit di kolom Actions. Di halaman Integration Details, ubah informasi integrasi lalu klik Save.

• Aktifkan atau nonaktifkan integrasi: Temukan integrasi lalu klik Disable atau Enable di kolom Actions.

• Hapus integrasi: Temukan integrasi lalu klik Delete di kolom Actions. Di pesan yang muncul, klik OK.

• Tambahkan alur pemrosesan peristiwa ke integrasi: Temukan integrasi dan klik Add Event Processing Flow di kolom Actions. Untuk informasi lebih lanjut, lihat Bekerja dengan Alur Pemrosesan Peristiwa.

• Buat kebijakan notifikasi: Temukan integrasi untuk mana Anda ingin membuat kebijakan notifikasi, dan klik Lainnya di kolom Actions. Di daftar yang muncul, klik Create Notification Policy. Untuk informasi lebih lanjut, lihat Buat dan Kelola Kebijakan Notifikasi.