帮助手册 管理 第三方集成 Jira 集成

Jira 集成

Atlassian Jira 是一个项目管理平台，旨在跟踪错误和解决 DevOps、敏捷和支持团队广泛使用的问题。Site24x7 与 Jira 的集成有助于在 Jira 中为 Site24x7 告警自动创建问题。这种集成通过提供一个通用平台来同时处理与您的网站、服务器、网络等相关的问题，从而帮助简化问题管理。 

我们支持与 Jira Software (Cloud) 和 Jira Service Management(Cloud) 产品的集成。

特点：

  • 对于 Site24x7 中的每个新告警，都会在 Jira 中自动创建一个问题。
  • 将为每个问题提供有关告警的详细说明。

目录

授权 Jira

Site24x7 支持通过 OAUTH 2.0（流行的行业标准授权协议）与 Jira 集成。要设置集成：

  1. 转到 Site24x7 管理> 第三方集成>  Jira。 
  2. 在打开的新页面中 单击授予对 Jira 帐户的访问权限。
  3. 登录到您的 Jira 帐户。在打开的同意弹出窗口中，单击接受 以将您的 Site24x7 帐户与您的 Jira 帐户集成。

  4. 单击接受后，您将被重定向到 Site24x7 Web 客户端。然后，您将被重定向到 Site24x7 中的 Jira Web 客户端。
  5. 在 Site24x7 Web 客户端中，通过填写以下字段来更新集成表单：
  • 集成名称：提供集成的名称。
  • 问题摘要：在 Jira 中为来自 Site24x7 的告警创建的问题的简要摘要。输入 $ 并从可用的事件参数中进行选择，以自定义 Site24x7 通知的消息标题。了解有关 事件参数的更多信息。您还可以使用 Site24x7全局参数来自定义您的消息标题。
  • 站点：从下拉列表中，选择您希望在 Jira 中提出问题的站点。
  • 项目：从下拉列表中，选择您希望在其中创建问题的项目。
    如果您想在另一个项目或其他问题类型中创建问题，您可以使用单个 Jira 帐户创建多个集成。
  • 问题类型：选择您喜欢的项目后，选择您要使用此选项创建的问题类型。
    完成添加集成后，在站点、项目和问题类型字段中选择的选项将无法更改。
  • 当我的监视器处于危急状态时触发事件：当您的监视器处于危急状态时，使用切换按钮在 Jira 中创建问题。
  • 当我的监视器处于故障的状态时触发事件：当您的监视器处于故障的状态时，使用切换按钮在 Jira 中创建问题。
  • 选择集成级别：使用单选按钮决定是否要在 Jira 中为您的特定监视器、与所选标签关联的所有监视器/监视器组或在触发告警时为您帐户中的所有监视器创建问题。
    对于与您的监视器组关联且在父级别具有监视器而在子组级别具有一些监视器的标签，仅来自父监视器的告警将作为 Jira 问题添加。
  • 与告警一起发送的标签：选择与需要与告警一起发送的监视器关联的标签键。触发告警时，与监视器匹配的标签将包含在告警通知中。如果未选择任何标签，则与监视器关联的所有标签都将出现在告警通知中。
  • 单击保存以保存集成。

暂停/激活/删除 Jira 集成

设置集成后，所有告警都将在 Jira 中作为问题提出。连续状态更改将添加为现有问题下的评论。如果您想暂时停止在 Jira 中创建问题，可以暂停 Jira 集成。要在您喜欢的时间段内暂停集成，请按照以下步骤操作：  

  • 导航到管理>  第三方集成，然后单击集成。
  • 单击要暂停的活动 Jira 集成。
  • 单击 集成窗口右上角的暂停。 
  • 如果要重新激活暂停的 Jira 集成，请单击激活。
  • 要永久停止在 Jira 中创建问题，请单击删除。 

触发测试告警
要在 Jira 中测试问题创建，请单击 Jira 集成页面中的触发测试告警按钮。

当监视器状态更改为正常时，Site24x7 不会关闭问题，但会在有关状态更改的问题下添加评论。

在 Jira 中查看问题

这就是 Site24x7 中引发的告警在 Jira 中显示为问题的方式。

与 Webhook 的本地 Jira 集成

Site24x7 不支持开箱即用的本地 Jira 集成。但是，您可以使用 Site24x7 中的自定义 Webhook 创建本地 Jira 集成以触发事件。
按照下面提到的步骤创建集成：

先决条件：
安装本地部署轮询器。

配置 Webhook

  1. 登录到 Site24x7。
  2. 导航到管理>第三方集成。
  3. 选择Webhook。
  4. 在打开的新页面中，在以下字段中提供必要的信息：
    • 集成名称：提供本地 Jira 集成的名称。
    • Webhook URL：为 Jira API URL 提供正确的主机名和端口号，以在 Jira 中创建问题/工单。Jira URL 将采用以下格式：
      • http://<<域名>>:<<端口号>>/rest/api/2/issue
      • HTTP 协议可能因 Jira 本地设置而异。
      • <<domain_name>> - 替换为 Jira 本地设置期间使用的域名。
      • <<port_number>> - 替换为 Jira 本地设置期间使用的端口号。
      • 例如 http://示例:8080/rest/api/2/issue
    • HTTP 方法：选择适当的方法与 Jira 集成。根据方法类型，创建要与来自 Site24x7 的请求一起传递的有效负载 JSON。事件参数和自定义参数都可以在负载中配置。例如，在 Jira 中创建问题的 JSON 有效负载格式： 
  • {
      "fields": {
        "project": {
          "key": "SIT"
         },
        "summary": "Monitor Name is $MONITORNAME",
        "description": "$MONITORNAME - Ticket Created - $MONITORTYPE - $MONITORURL",
        "issuetype": {
          "name": "Bug"
         }
       }
    }
    • 可访问性：对于本地 Jira 集成，选择可访问性作为“内部”。
    • 本地轮询：选择安装在您的环境中的合适的 On-Premise Poller。
    • HTTP 请求标头：要自定义默认的 HTTP 请求标头信息，您可以在此处添加额外的标头名称和标头值。
    • 用户代理：设置自定义用户代理（Web 浏览器）以发送您的请求和 HTTP 标头。您可以从可用的用户代理中进行选择。
    • 身份验证：提供有效的身份验证详细信息以在 Jira 中创建问题/工单。提供具有在 Jira 中创建或更新问题的权限的用户凭证。
    • 超时：以秒为单位输入时间以确定 Site24x7 服务器在将 URL 视为无响应之前应等待多长时间。以秒为单位输入一个时间，该时间不是您网站的通常响应时间。指定一个介于 1-45 秒之间的值。
    • 集成级别：根据选择的资源类型，将触发本地 Jira 集成。
    • 与告警一起发送的标签：选择与需要与告警一起发送的监视器关联的标签键。触发告警时，与监视器匹配的标签将包含在告警通知中。如果未选择任何标签，则与监视器关联的所有标签都将出现在告警通知中。
    • 当我的监视器处于危急状态时触发事件：根据监视器的状态，将触发事件。
    • 当我的监视器处于故障的状态时触发事件：根据监视器的状态，将触发事件。

管理工单配置

当您需要在 Jira 中更新或关闭问题而无需任何手动干预时，可以使用此配置。

  • 管理工单：使用切换按钮选择是或否，让您的工单由 Site24x7 自动管理。
  • 响应格式：从提供的下拉选项中选择 JSON 作为响应格式。
  • JSONPath 表达式：提供 JSONPath 表达式以更新 Jira 中的问题。例如，$.id
  • 更新请求：
    • Hook URL：为 Jira API URL 提供正确的主机名和端口号，以在 Jira 中创建问题或工单。例如：http://示例:8080/rest/api/2/issue/$TICKET_ID
      • 此 URL 可用于更新 Jira 中的现有问题
    • HTTP 方法：选择适当的方法与 Jira 集成。根据方法类型，创建要与来自 Site24x7 的请求一起传递的有效负载 JSON。事件参数和自定义参数都可以在负载中配置。例如，在 Jira 中创建问题的 JSON 有效负载： 
      {
        "update":{
          "comment":[{
            "add":{
              "body":"Monitor Status Changed to - $STATUS"
            }
          }]
        }
      }
  • 关闭请求：这将在监视器变为 UP 时调用。
    • Hook URL：为 Jira API URL 提供正确的主机名和端口号，以在 Jira 中创建问题或工单。例如：http://示例:8080/rest/api/2/issue/$TICKET_ID/transitions。此 URL 可用于更新 Jira 中的现有问题
    • HTTP 方法：选择适当的方法与 Jira 集成。根据方法类型，创建要与来自 Site24x7 的请求一起传递的有效负载 JSON。事件参数和自定义参数都可以在负载中配置。例如，在 Jira 中创建问题的 JSON 有效负载： 
      {
       "transition":{
       "id":"41"
         }
      }
  • 单击保存。

单击保存后，将创建集成，您可以通过导航到管理> 第三方集成在 Site24x7 Web 客户端中访问它。

帮助手册 管理 第三方集成 Jira 集成