帮助手册

Jira 集成

Atlassian Jira 是一个专为跟踪漏洞和解决问题而设计的项目管理平台,被 DevOps、敏捷和支持团队广泛使用。Site24x7 与 Jira 的集成可为 Site24x7 告警在 Jira 中自动创建问题,帮助简化问题管理,提供一个统一平台来同时处理网站、服务器、网络等相关问题。 

注意

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

功能

  • 每当 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 问题添加。

  • 随告警发送的标签:选择与监视器关联的需要随告警发送的标签键。告警触发时,与监视器匹配的标签将包含在告警通知中。如果未选择任何标签,所有与监视器关联的标签都将出现在告警通知中。
  • 备用通知媒介:如果用于发送告警的主要第三方通知媒介出现问题,将激活备用通知媒介,确保告警不会遗漏。

6. 点击保存并测试按钮保存集成并接收测试告警。或者,点击保存 按钮完成集成。

暂停/激活/删除 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 集成提供名称。
    • Hook URL:提供带有正确主机名和端口号的 Jira API URL,用于在 Jira 中创建问题/工单。Jira URL 格式如下:
      • http://<<domain_name>>:<<port_number>>/rest/api/2/issue
      • HTTP 协议可能因本地 Jira 设置而异。
      • <<domain_name>> - 替换为本地 Jira 设置时使用的域名。
      • <<port_number>> - 替换为本地 Jira 设置时使用的端口号。
      • 例如:http://example: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 集成,请将可访问性设置为"内部"。
    • 本地轮询器:选择在您的环境中安装的适当本地轮询器。
    • HTTP 请求头:要自定义默认 HTTP 请求头信息,可在此处添加附加头名称和头值。
    • 用户代理:为发送请求和 HTTP 头设置自定义用户代理(Web 浏览器)。您可以从可用的用户代理中选择。
    • 身份验证:提供有效的身份验证详情以在 Jira 中创建问题/工单。提供具有在 Jira 中创建或更新问题权限的用户凭据。
    • 超时:输入时间(秒),确定 Site24x7 服务器在将 URL 视为无响应之前的等待时间。输入的时间不应为网站的正常响应时间。指定 1-45 秒之间的值。
    • 集成级别:根据所选资源类型,将触发本地 Jira 集成。
    • 随告警发送的标签:选择与监视器关联的需要随告警发送的标签键。告警触发时,与监视器匹配的标签将包含在告警通知中。如果未选择任何标签,所有与监视器关联的标签都将出现在告警通知中。
    • 当监视器处于严重状态时触发事件:根据监视器状态触发事件。
    • 当监视器处于故障状态时触发事件:根据监视器状态触发事件。

管理工单配置

此配置用于无需人工干预即可更新或关闭 Jira 中的问题。

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

点击保存后,集成即创建完成,您可以通过导航至 Site24x7 Web 客户端的管理 > 第三方集成来访问它。

本文档对您有帮助吗?

您愿意帮助我们改进文档吗?请告诉我们哪些方面可以做得更好。


很抱歉本文档未能让您满意。我们希望了解可以从哪些方面改进您的体验。


感谢您抽出时间分享反馈。我们将利用您的反馈来改进在线帮助资源。

短链接已复制!