コンテンツにスキップ

Jira


Jira 通知先は、Webhook(外部通知を受け取る HTTP エンドポイント)を介して、Guance のアラートを JSON 形式で Jira の受信フローに送信します。Jira でフィールドマッピングと処理アクションを設定し、アラートをプロジェクトチームに引き渡して処理できます。

本記事では Jira Cloud Automation の Incoming webhook を例に説明します。課題が属するプロジェクト、タイプ、作成または更新ルール、重複排除、およびステータス維持は、すべて Jira の自動化ルールによって制御されます。

Jira で受信ルールを設定する

対象プロジェクトの自動化ルールを編集する権限が必要です。

  1. 対象の Jira プロジェクトの Automation に移動し、自動化ルールを作成します。
  2. Incoming webhook トリガーを追加します。
  3. Create issue などの処理アクションを追加し、プロジェクトと課題タイプを選択します。初回の接続テストでは、まず固定の要約(例:「監視通知テスト」)を使用できます。受信を確認した後、実際のアラートに合わせて要約を {{webhookData.title}}、説明を {{webhookData.message}} にマッピングします。
  4. Save flow without enabling を選択し、ルール名を入力して保存します。
  5. Incoming webhook トリガーを再度開き、No issues from the webhook を選択して、Webhook URL と Secret をコピーします。トリガー設定を保存し、ルールを有効化します。

Jira は webhookData を使用してリクエスト内の JSON フィールドを読み取ります。1 回のアラート通知に複数のイベントを含めることができます。業務要件に応じて、通知全体で課題を作成するか、events を走査してイベントごとに処理し、イベントのコンテキスト、バックリンク、および monitor_checker_links 内のモニターリンクを課題フィールドにマッピングしてください。

受信エンドポイントと Secret の設定については、Jira Incoming webhook 公式ドキュメント を参照してください。フィールドマッピングについては、Jira 公式のアラート連携例 を参照してください。

Guance で通知先を作成

モニタリング > 通知先管理 > 通知先を作成 に移動し、Jira を選択します。

  1. 名前を入力します。これはリストおよびアラートポリシーで通知先を識別するために使用します。名前は現在のワークスペース内で一意であり、最大 200 文字です。
  2. Webhook アドレス に Jira が提供する完全な HTTPS URL を入力し、POST リクエストを実際に受信する最終アドレスを使用します。
  3. 認証方式 で Secret を選択し、Jira が生成した Secret を入力します。システムは X-Automation-Webhook-Token リクエストヘッダーを介してこの値を送信します。
  4. 受信側の要件に従って、その他の認証方式とカスタムリクエストヘッダーを設定します。
  5. テスト通知を送信 をクリックし、プレビューして送信を確認します。テストは実際に Jira ルールを呼び出し、後続のアクションはルールに従って実行されます。
  6. Jira の Audit log に移動し、今回のルール実行記録が存在することを確認して、アラートフィールドと課題の処理結果を照合します。
  7. 操作権限を設定し、保存を確認します。
  8. アラートポリシーでこの通知先を選択し、送信するイベントレベルと範囲を設定します。

その他の認証方式とカスタムリクエストヘッダー

Jira Cloud Automation のネイティブ Incoming webhook は Secret を使用します。ゲートウェイ、プラグイン、またはセルフホストの受信サービスに接続する場合は、そのエンドポイントが実際にサポートするプロトコルに応じて認証方式を選択してください。

認証方式 入力内容 使用上の注意
Secret Secret 上記の Jira Cloud Automation エンドポイントに適用されます。
Basic ユーザー名、パスワード 受信側の取り決めに従って認証情報を提供します。ユーザー名は空でなく、コロンを含まないようにしてください。
Bearer Token Token 既存の Access Token の元の値を入力します。システムが Bearer プレフィックスを追加します。トークンの有効期限切れまたは失効後に更新してください。
API Key リクエストヘッダー名、API Key 受信側の取り決めに従ってリクエストヘッダー名と完全な値を入力します。Content-Type は予約名です。
認証なし — 受信側の要件に従ってカスタムリクエストヘッダーを設定します。

必要に応じて カスタムリクエストヘッダー を有効にし、受信側が要求するキーと値を追加します。ヘッダー名は大文字と小文字を区別せずに重複排除されます。選択した認証方式で生成されるリクエストヘッダーは、同名のカスタムヘッダーより優先されます。Content-Type は application/json に固定され、Accept のデフォルトは application/json です。

認証情報を編集

保存済みのオブジェクトを編集する場合、同一のアドレス、認証方式、および識別情報の下では、Secret、パスワード、Token、または API Key を空欄にすると元の値が保持され、新しい値を入力すると置き換えられます。アドレス、認証方式、ユーザー名、または API Key のリクエストヘッダー名を変更した後は、対応する認証情報を入力する必要があります。

カスタムリクエストヘッダーの値は暗号化して保存されます。上記の設定が同じままである場合、保存済みの同名リクエストヘッダーの値を空欄にすると保持され、新しい値を入力すると置き換えられます。行を削除すると、そのヘッダーは削除されます。リクエストヘッダーを新規追加または名前変更した場合、および上記の設定を変更した後は、完全なリクエストヘッダー値を入力してください。

テストでは現在のフォーム内の有効な設定が使用されます。保存後は、以降のアラートで新しい設定が使用されます。Jira の Secret を再生成した後は、通知先の Secret も同期して更新してください。

通知内容とアラート集約

Jira 通知先は シンプル HTTP リクエスト のアラート集約形式を踏襲し、通常通知、ルール集約通知、およびインテリジェント集約通知をサポートします。受信側は以下のフィールドに従ってアラートを解析します:

フィールド 意味
title、message、status 現在の通知のタイトル、本文、およびステータス。
events イベントリスト。通常アラートには 1 つのイベントが含まれます。集約アラートには対応する一連のイベントが含まれ、イベントのコンテキストとバックリンクが保持されます。
workspace_uuid、workspace_name イベントが属するワークスペースの ID と名前。
monitor_checker_links ルール集約通知およびインテリジェント集約通知におけるモニター名とイベントリストへのリンク。

アラートポリシーによって、どのイベントが同じ通知を構成するかが決まります。通知内容の構築が完了すると送信が開始されます。明示的な遅延が設定された通知は、引き続き指定された時刻に送信されます。

テストとトラブルシューティング

テスト通知のフィールドは、受信側が実際に受信した JSON に基づきます。エンドポイントと認証のテストを完了した後、実際の通常アラートおよび集約アラートを使用して、title、events などのフィールドのマッピングを検証してください。初回テストで固定の要約を使用すると、テストサンプルに title がない場合の課題作成失敗を回避できます。

受信エンドポイントが HTTP 2xx を返すことは、リクエストが完了したことのみを示します。Jira の新しい Incoming webhook では、Secret が誤っている場合やルールが存在しない場合でも HTTP 200 を返すことがあります。連携が成功したかどうかは、Audit log の今回の実行記録、フィールド解析、および後続アクションの結果で判断してください。

現象 確認方法
リクエストは完了したが、Audit log に今回の記録がない ルールが有効になっていること、URL と Secret が同じトリガーに由来することを確認します。Secret を再生成した後は、通知先も同期して更新してください。
ルールは実行されたが、課題フィールドが空 webhookData のフィールドパスを確認し、実際の通常アラートと集約アラートでそれぞれ解析を検証します。
課題数が想定と異なる ルールが通知全体で実行されるか、events 内のイベントごとに実行されるか、および Jira 側の重複排除ルールを確認します。
送信失敗 最終的な HTTPS アドレス、証明書、ネットワーク接続性、受信側の権限を確認します。HTTP 3xx リダイレクトは送信失敗として扱われます。

その他のトラブルシューティング方法については、Jira Incoming webhook 公式テストガイド を参照してください。

フィードバック

このページは役に立ちましたか?