このガイドは、Dotcom-Monitor から Jira チケットにアラートを送信するための Webhook 統合を設定するのに役立ちます。Dotcom-Monitor は、HTTP Webhook アラート配信方法を利用して、Dotcom-Monitor アラート システムと Jira チケットを Webhook 要求経由で接続します。統合をセットアップするには、Jira プロジェクトで課題を作成するために必要な権限があることを確認します。

インテグレーションのセットアップ

Jira API トークンの生成:

  1. Jira で API トークンを生成して基本認証を設定する方法については、Atlassian 開発者ポータルの 「REST API の基本認証 」ページを参照してください。
  2. 生成された API トークンを Dotcom-Monitor の認証ヘッダーで使用するために保存します。

Dotcom-Monitor で Webhook を構成する

API リクエストを使用する場合、特に認証ヘッダーを使用する場合、JIRA は CSRF 保護をバイパスするために追加のヘッダーを必要とすることがあります。これに対処するには、 Webhook リクエストに X-Atlassian-Token ヘッダーと値 no-check を含めます。

  1. Dotcom-Monitor アカウントにログインし、配信アドレス グループ構成 (配信アドレス グループの管理 > ) に移動します。
  2. 新しいグループを作成するか、既存のグループを開いて編集します。 配信先住所として Webhook を追加します。Dotcom-Monitor アラート メッセージを専用の Webhook URL に送信する方法については、HTTP Webhook 統合の記事を参照してください。
  3. [Webhook URL] フィールドに次のように入力します https://your-domain.atlassian.net/rest/api/3/issue
  4. [Request Type] を [POST] に設定します。
  5. [認証] セクションは空のままにします。
  6. [ヘッダー] セクションで、次のヘッダーを追加します。useremail:api_token 文字列を BASE64 でエンコードしてください。
    • 認証: Basic [useremail:api_token]
    • コンテンツタイプ: application/json
    • X-Atlassian-Token: no-check
  7. [ペイロード] フィールドに、Jira に送信される JSON データ構造を入力します。ペイロードの例を次に示します。 
    @{
string _text = "";
foreach (var sessionResponse in Model.SessionResponses)
{
    foreach (var response in sessionResponse.Children)
    {
        _text += "Task Type: " + response.Task.TaskType_Name + ", " +
                 "Details Url: " + Model.DMUserLink + "/client/response-details/hit?id=" + response.ID + "&rootId=" + Model.RootResponse.ID + "&cuid=" + Model.OnlineReportCUID + ", " +
                 "View Task Url: " + Model.DMUserLink + "/v2/EditLegacyTask/" + response.Device.ID + "/" + response.Task.ID + ", " +
                 "Task Name: " + response.Name + ", " +
                 "Target: " + response.Target + ", ";

        if (response.AllErrors != null)
        {
            foreach (var error in response.AllErrors)
            {
                _text += error.ErrorType + " (" + error.ErrorCode + ") " + error.Reason;
            }
        }
    }
}
}
{
  "fields": {
    "project": {
      "key": "JIRA_PROJECT_KEY"
    },
    "summary": "Alert from Dotcom-Monitor",
    "description": {
      "type": "doc",
      "version": 1,
      "content": [
        {
          "type": "paragraph",
          "content": [
            {
              "text":"@_text",
              "type": "text"
            }
          ]
        }
      ]
    },
    "issuetype": {
      "name": "Task"
    },
    "components": [
      {
        "name": "Default Component"
      }
    ]
  }
}
  8. Jira プロジェクトのキーに置き換えます "PROJECT_KEY" 。

Webhook をテストする

Webhook統合を設定したら、テストアラートを送信して監視デバイスをテストすることをお勧めします。

  1. デバイスリストで、テストする監視デバイスにカーソルを合わせます。
  2. [オプション]メニュー（⋮)>[Send Test Alert > Down]をクリックします。
  3. Jira プロジェクトで、アラートによって新しいチケットが作成されているかどうかを確認します。

アラートテンプレートでの動的変数の使用

JSON ペイロードに動的 Dotcom-Monitor 変数を含める必要がある場合は、「 アラート テンプレートへの動的変数の追加 」の記事を確認してください。問題が発生した場合、または特定の要件がある場合は、Dotcom-Monitor サポートに連絡してサポートを受けてください。