Jira アカウントまたは Open Authorization (OAuth) を使用して、Jira を Application Real-Time Monitoring Service (ARMS) のアラート管理機能と統合できます。このトピックでは、OAuth を使用して Jira を ARMS のアラート管理と統合する方法について説明します。これにより、ARMS でアラートが生成されると Jira で課題が作成され、アラートステータスと課題ステータスを同期できます。
ステップ 1:Jira の設定
コマンドラインインターフェイス (CLI) で次の OpenSSL コマンドを実行して、Rivest–Shamir–Adleman (RSA) 公開鍵と RSA 秘密鍵を生成します。
説明これらのコマンドはどのディレクトリでも実行できます。生成されたファイルは現在のディレクトリに保存されます。
1024 ビットの秘密鍵を生成します。
openssl genrsa -out jira_privatekey.pem 1024X509 証明書を作成します。
openssl req -newkey rsa:1024 -x509 -key jira_privatekey.pem -out jira_publickey.cer -days 365PKCS#8 形式の秘密鍵を jira_privatekey.pcks8 ファイルに抽出します。
openssl pkcs8 -topk8 -nocrypt -in jira_privatekey.pem -out jira_privatekey.pcks8証明書から公開鍵を jira_publickey.pem ファイルに抽出します。
openssl x509 -pubkey -noout -in jira_publickey.cer > jira_publickey.pem
アプリケーションリンクを作成します。
Jira にログインし、Jira ページの右上隅にある設定アイコンをクリックしてから、 [アプリケーション] をクリックします。
[アプリケーション] タブで、 [アプリケーションリンク] をクリックします。
[アプリケーションリンクの設定] セクションで、URL を入力し、 [新しいリンクを作成] をクリックします。
説明この URL は任意であり、統合には影響しません。
http://alerts.console.aliyun.com/などの任意の URL を入力できます。表示される [アプリケーション URL の設定] ダイアログボックスで、警告を無視して Continue をクリックします。
ダイアログボックスでは、 [入力された URL] は
http://alerts.console.aliyun.com/と表示され、 [新しい URL] は自動的にhttps://alerts.console.aliyun.com/に変更されます。表示される[アプリケーションのリンク] ダイアログボックスで、[アプリケーションタイプ]を[汎用アプリケーション]に設定し、[コンシューマーキー]に AlertOauthKey を入力し、[着信リンクを作成] チェックボックスを選択し、必要に応じてその他のパラメーターを入力してから、Continueをクリックします。
[アプリケーションのリンク] ダイアログボックスで、次のパラメーターを設定し、Continue をクリックします。
パラメーター
値
コンシューマーキー
AlertOauthKey
コンシューマー名
alertmanager
公開鍵
ステップ 1 で生成された jira_publickey.pem ファイルの内容。
[アプリケーションのリンク] ダイアログボックスの [ターゲットアプリケーション] セクションで、 [アプリケーション URL] を
https://alerts.console.aliyun.com/に設定し、上記のパラメーターを設定してから、 [続行] をクリックします。しばらくすると、新しいアプリケーションリンクが [アプリケーションリンクの設定] ページに表示されます。アプリケーション一覧には、alertmanager が [汎用アプリケーション] タイプとして、ステータス NON-ATLASSIAN で正常に追加されたことが示されます。
アプリケーションリンクの 動作 列で、編集アイコン (
) をクリックします。 [alertmanager の設定] ダイアログボックスで、左側のパネルの [受信認証] をクリックします。[ステータス] が [未設定] の場合は、 [コンシューマーキー] 、 [コンシューマー名] 、 [公開鍵] を再入力し、保存 をクリックします。
閉じる をクリックします。
ステップ 2:Jira と ARMS の統合
-
ARMS コンソールにログインします。左側のナビゲーションウィンドウで、 を選択します。
統合 ページで、統合の通知 タブをクリックし、次に Jira をクリックします。
統合の追加 ウィザードで、次の手順を実行します。
基本情報 ページで、次のパラメーターを設定し、検証コードの取得 をクリックします。
Jira の認証ページにリダイレクトされます。
パラメーター
値
名前
Jira 統合の名前を入力します。
説明
Jira 統合の説明を入力します。
URL
ご利用の Jira インスタンスの URL。
検証
[認証方式] を [OAuth] に設定します。
コンシューマーキー
AlertOauthKey
秘密鍵
ステップ 1 で生成された jira_privatekey.pcks8 ファイルの内容。
[Jira へようこそ] ページで、Allow をクリックします。
[アクセス承認済み] ページで、検証コードを取得します。
ARMS コンソールの 統合の追加 ウィザードに戻ります。コードを [検証コード] フィールドに貼り付け、アクセストークンの取得 をクリックします。
「アクセストークンの取得に成功しました」と表示されたら、次へ をクリックします。
アラートソースの設定 ページで、アラート同期設定を行い、保存 をクリックします。
パラメーター
説明
例
プロジェクト
アラートがトリガーされたときに課題が作成される Jira プロジェクト。
統合監視、管理、制御プロジェクト
タイプ
アラートの Jira 課題タイプ。
タスク
サブタスク
改善
新機能
バグ
エピック
ストーリー
バグ
課題のクローズ済みステータス
Jira 課題がクローズ済みであることを示すステータス。課題がこのステータスに達すると、それ以降のアラート操作はその課題に同期されなくなります。利用可能なステータス:
To Do
進行中
レビュー中
完了
説明[完了] を選択することを推奨します。別のステータスを選択した場合、Jira 課題のステータスが [完了] に変更された後も、アラート操作はその課題に同期され続けます。
完了
優先度
アラートの重大度レベルを Jira 課題の優先度にマッピングします。
重要アラートの重大度レベルのマッピングを設定しない場合、そのレベルのアラートは Jira に同期されません。
アラートの重大度レベルは、最初に Jira にプッシュされるときにのみ、このマッピングに基づいて同期されます。ARMS アラート管理でアラートの重大度レベルを後から変更しても、Jira 課題には同期されません。
P1:最高
P2:高
P3:中
P4:低
P5:最低
設定を保存すると、統合の通知 タブで新しい Jira 統合を表示できます。リストには、 [名前] 、 [統合キー] 、 [タイプ] 、 [作成時刻] などの情報が表示されます。 [アクション] 列から統合を管理できます。
Jira へのアラートのプッシュ
Jira 統合を設定した後、3 つの方法で Jira にアラートをプッシュできます。
方法 1
通知ポリシーを設定して、アラートがトリガーされたときに Jira で課題を自動的に作成します。
左側のナビゲーションウィンドウで、 を選択します。
通知ポリシー ページで、通知ポリシーの作成 をクリックするか、既存の通知ポリシーを編集します。
アラートが生成されたとき セクションで、 [連絡先] を指定します。少なくとも 1 つの連絡先または連絡先グループを選択する必要があります。
重要Jira は、通知ポリシーの最初の連絡先とメールアドレスまたはユーザー名が一致するユーザーに課題を割り当てます。
通知ポリシーの最初の連絡先に対応するユーザーが Jira に存在しない場合、アラートは Jira に同期されません。
[チケットシステム] で、作成した Jira 統合を選択します。必要に応じて他のパラメーターを設定します。詳細については、「通知ポリシー」をご参照ください。
保存 をクリックします。
設定を完了すると、この通知ポリシーに一致するアラートが Jira にプッシュされます。
方法 2
アラート送信履歴 ページから、既存のアラートを手動で Jira にプッシュして課題を作成できます。
左側のナビゲーションウィンドウで、 を選択します。
アラート送信履歴 ページで、右上隅のオペレーターを Jira 課題ハンドラーとして選択し、ターゲットアラートの名前をクリックします。
重要Jira は、選択したオペレーターとメールアドレスまたはユーザー名が一致するユーザーに課題を割り当てます。
オペレーターに対応するユーザーが Jira に存在しない場合、アラートは Jira に同期できません。
アラート詳細ページで、右上隅の
アイコンをクリックし、アラートのプッシュ をクリックします。表示されるダイアログボックスで、 [チケットシステム] で作成した Jira 統合を選択し、確認 をクリックします。
アラートが正常にプッシュされると、対応する Jira 課題へのリンク (例:AL-6) がアラート詳細ページに表示されます。
方法 3
DingTalk グループでアラートカードを受信したときに、カードから直接対応するアラートを Jira にプッシュできます。
DingTalk グループからアラートをプッシュしたユーザーが、Jira の課題ハンドラーになります。
オペレーターは、DingTalk グループのアラートカードで携帯電話番号をバインドした連絡先である必要があります。詳細については、「アラートの処理」をご参照ください。
Jira ユーザーのメールアドレスまたはユーザー名が ARMS の連絡先のメールアドレスまたは名前と一致する場合、その連絡先はその Jira ユーザーにマッピングされます。
オペレーターに対応するユーザーが Jira に存在しない場合、アラートは Jira に同期できません。
DingTalk グループで受信するアラートカードで、アラートのプッシュ をクリックし、作成した Jira 連携を選択します。
アラートカードで、アラート名をクリックします。アラート詳細パネルで、設定 をクリックし、 [チケットをプッシュ] をクリックして、作成した Jira 統合を選択します。
アラートが正常にプッシュされると、対応する Jira 課題へのリンクがアラート詳細ページに表示されます。
同期でサポートされるアラート操作
設定後、ARMS アラート管理の次のアラート操作が Jira チケットシステムと同期されます。
アラート送信履歴 ページでの操作:
アラートの要求:Jira 課題ハンドラーを更新します。
説明アラートを要求するユーザーは、Jira に対応するユーザーアカウントを持っている必要があります。
アラートへのコメント:Jira 課題にコメントを追加します。
アラートの解決:解決策をコメントとして Jira 課題に追加します。
DingTalk グループのアラートカードでの操作:
アラートの要求:Jira 課題ハンドラーを更新します。
アラートを要求するユーザーは、Jira に対応するユーザーアカウントを持っている必要があります。
Jira アクションの ARMS への同期
ARMS のアラート管理で、統合 ページに移動し、統合の通知 タブをクリックして、Jira 統合の統合キーをコピーします。
ご利用の Jira チケットシステムにログインします。Jira ページの右上隅にある設定アイコンをクリックし、OsType をクリックします。
管理者パスワードを入力し、確認 をクリックしてシステム設定ページに移動します。
OsType ページの左側のナビゲーションウィンドウで、 を選択します。
Webhook ページで、 [+ Webhook の作成] をクリックします。
Webhook の作成ページで、 [URL] を
http://alerts.aliyuncs.com/api/jira/receiver/{token}/${project.key}/${issue.key}に設定します。「{token}」を ステップ 1 の Jira 統合キーに置き換えます。[名前] を
ARMS Alert Managementに設定し、 [ステータス] を [有効] に変更します。 [課題関連のイベント] セクションで、 [すべての課題] を選択します。 [課題] 列で、 [作成] 、 [更新] 、 [削除] を選択します。 [コメント] 列で、 [作成] 、 [更新] 、 [削除] を選択します。必要に応じて他のパラメーターを設定します。詳細については、Jira の公式ドキュメントをご参照ください。その後、新規作成 をクリックします。
これらの手順を完了すると、次の Jira 課題操作が ARMS のアラート管理と同期されます。
課題ハンドラーの変更:対応するアラートのハンドラーが更新されます。
課題へのコメントの追加:対応するアラートにコメントが追加されます。