Application Real-Time Monitoring Service:Gunakan OAuth untuk mengintegrasikan Jira dengan ARMS

Langkah 1: Konfigurasikan Jira

1. Jalankan perintah OpenSSL berikut di command-line interface (CLI) untuk menghasilkan kunci publik Rivest–Shamir–Adleman (RSA) dan kunci privat RSA.

   Catatan

   Anda dapat menjalankan perintah ini di direktori apa pun. File yang dihasilkan disimpan ke direktori saat ini.

   1. Hasilkan kunci privat 1024-bit:

      openssl genrsa -out jira_privatekey.pem 1024

   2. Buat sertifikat X509:

      openssl req -newkey rsa:1024 -x509 -key jira_privatekey.pem -out jira_publickey.cer -days 365

   3. Ekstrak kunci privat dalam format PKCS#8 ke file jira_privatekey.pcks8.

      openssl pkcs8 -topk8 -nocrypt -in jira_privatekey.pem -out jira_privatekey.pcks8

   4. Ekstrak kunci publik dari sertifikat ke file jira_publickey.pem:

      openssl x509 -pubkey -noout -in jira_publickey.cer  > jira_publickey.pem

2. Buat application link.

   1. Masuk ke Jira, klik ikon Settings di pojok kanan atas halaman Jira, lalu klik Applications.

   2. Pada tab Applications, klik Application links.

   3. Di bagian Configure Application Links, masukkan URL dan klik Create new link.

      Catatan

      URL ini bersifat arbitrer dan tidak memengaruhi integrasi. Anda dapat memasukkan URL apa pun, misalnya http://alerts.console.aliyun.com/.

   4. Pada kotak dialog Configure Application URL yang muncul, abaikan peringatan tersebut dan klik Continue.

      Pada kotak dialog tersebut, Entered URL ditampilkan sebagai http://alerts.console.aliyun.com/, dan New URL secara otomatis diubah menjadi https://alerts.console.aliyun.com/.

   5. Pada kotak dialog Link applications yang muncul, atur Application Type menjadi Generic Application, masukkan AlertOauthKey untuk consumer key, centang kotak create incoming link, isi parameter lain sesuai kebutuhan, lalu klik Continue.

   6. Pada kotak dialog Link applications, konfigurasikan parameter berikut dan klik Continue.

      Parameter	Nilai
      Consumer Key	AlertOauthKey
      Consumer Name	alertmanager
      Public Key	Konten file jira_publickey.pem yang dihasilkan di Langkah 1.

      Pada bagian Target Application kotak dialog Link applications, atur Application URL menjadi https://alerts.console.aliyun.com/, konfigurasikan parameter di atas, lalu klik Continue.

      Setelah beberapa saat, application link baru muncul pada halaman Configure Application Links. Daftar aplikasi menunjukkan bahwa alertmanager telah berhasil ditambahkan sebagai tipe Generic Application dengan status NON-ATLASSIAN.

   7. Pada kolom Action untuk application link tersebut, klik ikon edit (). Pada kotak dialog Configure alertmanager, klik incoming authentication di panel kiri.

   8. Jika Status adalah Not Configured, masukkan ulang consumer key, Consumer Name, dan public key, lalu klik Save.

   9. Klik Close.

Langkah 2: Integrasikan Jira dengan ARMS

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

2. Pada halaman Integrations, klik tab Notification Integration, lalu klik Jira.

3. Pada wizard Add Integration, selesaikan langkah-langkah berikut.

   1. Pada halaman Basic Information, konfigurasikan parameter berikut dan klik Obtain Verification Code.

      Anda akan dialihkan ke halaman otorisasi Jira.

      Parameter	Nilai
      Name	Masukkan nama untuk integrasi Jira.
      Description	Masukkan deskripsi untuk integrasi Jira.
      URL	URL instans Jira Anda.
      Verification	Atur Authentication method menjadi OAuth.
      Consumer key	AlertOauthKey
      Private key	Konten file jira_privatekey.pcks8 yang dihasilkan di Langkah 1.

   2. Pada halaman Welcome to Jira, klik Allow.

   3. Pada halaman Access Approved, peroleh kode verifikasi.

   4. Kembali ke wizard Add Integration di Konsol ARMS. Tempel kode tersebut ke bidang Verification Code dan klik Obtain Access Token.

   5. Saat pesan Obtaining Access Token Succeeded ditampilkan, klik Next.

   6. Pada halaman Alert Source Configuration, konfigurasikan pengaturan sinkronisasi alert dan klik Save.

      Parameter	Deskripsi	Contoh
      Project	Proyek Jira tempat issue dibuat ketika alert dipicu.	Proyek pemantauan, manajemen, dan kontrol terintegrasi
      Type	Tipe issue Jira untuk alert tersebut. Task Subtask Improvement New feature Bug Epic Story	Bug
      Issue closed status	Status yang menandai issue Jira sebagai tertutup. Setelah issue mencapai status ini, operasi alert selanjutnya tidak lagi disinkronkan ke issue tersebut. Status yang tersedia: To Do In Progress In Review Done Catatan Kami menyarankan Anda memilih Done. Jika Anda memilih status lain, operasi alert tetap akan disinkronkan ke issue Jira yang sesuai meskipun statusnya telah berubah menjadi Done.	Done
      Priority	Memetakan tingkat keparahan alert ke prioritas issue Jira. Penting Jika Anda tidak mengonfigurasi pemetaan untuk tingkat keparahan alert tertentu, alert dengan tingkat tersebut tidak akan disinkronkan ke Jira. Tingkat keparahan alert disinkronkan berdasarkan pemetaan ini hanya saat pertama kali didorong ke Jira. Perubahan selanjutnya pada tingkat keparahan alert di ARMS Alert Management tidak disinkronkan ke issue Jira.	P1: Hightest P2: High P3: Medium P4: Low P5: Lowest

   Setelah Anda menyimpan konfigurasi, Anda dapat melihat integrasi Jira baru di tab Notification Integration. Daftar tersebut menampilkan informasi seperti Name, Integration key, Type, dan Creation time. Anda dapat mengelola integrasi tersebut dari kolom Actions.

Kirim peringatan ke Jira

Setelah mengonfigurasi integrasi Jira, Anda dapat mendorong alert ke Jira dengan tiga cara:

Metode 1

Siapkan kebijakan notifikasi untuk secara otomatis membuat issue di Jira ketika alert dipicu.

1. Di panel navigasi kiri, pilih Alert Management > Notification Policies.

2. Pada halaman Notification Policies, klik Create Notification Policy atau edit kebijakan notifikasi yang sudah ada.

3. Di bagian When an alert is triggered, , tentukan Contacts. Anda harus memilih setidaknya satu kontak atau kelompok kontak.

   Penting

   • Jira menetapkan issue tersebut kepada pengguna yang alamat email atau username-nya sesuai dengan kontak pertama dalam kebijakan notifikasi.

   • Jika kontak pertama dalam kebijakan notifikasi tidak memiliki pengguna yang sesuai di Jira, alert tidak akan disinkronkan ke Jira.

4. Untuk Ticket system, pilih integrasi Jira yang telah Anda buat. Konfigurasikan parameter lain sesuai kebutuhan. Untuk informasi lebih lanjut, lihat Kebijakan notifikasi.

5. Klik Save.

   Setelah Anda menyelesaikan konfigurasi, alert yang sesuai dengan kebijakan notifikasi ini akan didorong ke Jira.

Metode 2

Dari halaman Alert Sending History, Anda dapat secara manual mendorong alert yang sudah ada ke Jira untuk membuat issue.

1. Di panel navigasi kiri, pilih Alert Management > Alert Sending History.

2. Pada halaman Alert Sending History, pilih operator di pojok kanan atas untuk bertindak sebagai penangan issue Jira, lalu klik nama alert yang dituju.

   Penting

   • Jira menetapkan issue tersebut kepada pengguna yang alamat email atau username-nya sesuai dengan operator yang dipilih.

   • Jika operator tidak memiliki pengguna yang sesuai di Jira, alert tidak dapat disinkronkan ke Jira.

3. Pada halaman detail alert, klik ikon di pojok kanan atas, lalu klik Push Alerts.

4. Pada kotak dialog yang muncul, untuk Ticket system, pilih integrasi Jira yang telah Anda buat dan klik Confirm.

   Setelah alert berhasil didorong, tautan ke issue Jira yang sesuai, seperti AL-6, muncul di halaman detail alert.

Metode 3

Saat Anda menerima kartu alert di grup DingTalk, Anda dapat langsung mendorong alert yang sesuai ke Jira dari kartu tersebut.

• Pada kartu alert yang Anda terima di grup DingTalk, klik Push Alerts dan pilih integrasi Jira yang telah Anda buat.

• Pada kartu alert, klik nama alert tersebut. Di panel detail alert, klik Settings, klik Push ticket, dan pilih integrasi Jira yang telah Anda buat.

Setelah alert berhasil didorong, tautan ke issue Jira yang sesuai muncul di halaman detail alert.

Supported alert operations for synchronization

Setelah dikonfigurasi, operasi alert berikut di ARMS Alert Management disinkronkan dengan sistem tiket Jira.

Operasi pada halaman Alert Sending History:

• Claim alert: Memperbarui penangan issue Jira.

  Catatan

  Pengguna yang mengklaim alert harus memiliki akun pengguna yang sesuai di Jira.

• Komentar pada alert: Menambahkan komentar ke issue Jira.

• Selesaikan alert: Menambahkan resolusi sebagai komentar ke issue Jira.

Operasi pada kartu alert di grup DingTalk:

Claim alert: Memperbarui penangan issue Jira.

Sinkronkan aksi Jira kembali ke ARMS

1. Di ARMS Alert Management, buka halaman Integrations, klik tab Notification Integration, lalu salin integration key untuk integrasi Jira Anda.

2. Masuk ke sistem tiket Jira Anda. Di pojok kanan atas halaman Jira, klik ikon pengaturan, lalu klik OsType.

3. Masukkan kata sandi administrator Anda dan klik Confirm untuk membuka halaman konfigurasi sistem.

4. Di panel navigasi kiri halaman OsType, pilih Alerts > Webhook.

5. Pada halaman Webhooks, klik + Create a webhook.

6. Pada halaman Create a webhook, atur URL menjadi http://alerts.aliyuncs.com/api/jira/receiver/{token}/${project.key}/${issue.key}. Ganti {token} dengan integration key Jira dari Langkah 1.

   Atur Name menjadi ARMS Alert Management dan ubah Status menjadi Enabled. Di bagian Issue related events, pilih All issues. Di kolom Issue, pilih created, updated, dan deleted. Di kolom Comment, pilih created, updated, dan deleted.

7. Konfigurasikan parameter lain sesuai kebutuhan. Untuk informasi lebih lanjut, lihat dokumentasi resmi Jira. Lalu, klik Create .

   Setelah menyelesaikan langkah-langkah ini, operasi issue Jira berikut disinkronkan dengan ARMS Alert Management.

   • Mengubah penangan issue: Penangan alert yang sesuai diperbarui.

   • Menambahkan komentar ke issue: Komentar ditambahkan ke alert yang sesuai.