跳转至

JIRA 集成

JIRA 是 Atlassian 公司出品的项目与事务跟踪工具,被广泛应用于缺陷跟踪、客户服务、需求收集、流程审批、任务跟踪、项目跟踪和敏捷管理等工作领域。JIRA 中配置灵活、功能全面、部署简单、扩展丰富,其超过 150 项特性得到了全球 115 个国家超过 19,000 家客户的认可。


JIRA 集成 CA 步骤

  1. 创建应用

进入 CA 中后,点击集成,创建【JIRA】应用,保存并获取 AppKey

  1. 在 JIRA 中配置告警第三方集成

JIRA 6.3.6

  1. 登录 JIRA 账号,点击右上角的管理图标->选择系统->网络钩子->创建 webhook

  1. 在下图位置中填写 名称 URL 中输入 wehhook 地址
    http://api.aiops.com/alert/api/event/jira/  获取的appKey 
    
    勾选 lssure Created lssure Deleted lssure Updated

JIRA 8.13.2

  1. 登录 JIRA 账号,点击右上角的管理图标->选择系统->webhook->创建网络钩子

  1. 在下图位置中填写 名称 状态开启 URL 中输入 wehhook 地址
    http://api.aiops.com/alert/api/event/jira/  获取的appKey 
    
    勾选 已创建 已更新 工作日志修改 后点击创建即可
  2. JIRA 云服务对接 CA 的 webhook 地址是 https 的格式,例如: https://caweb.aiops.com/alert/api/event/jira/{appKey}

测试 JIRA 告警

在 jira 中创建一个故障或是缺陷类型的问题,填写相关信息后,点击【创建】即可。登录 CA 平台查看告警-所有告警,是否有对应的告警信息。如果有则说明对接成功;如果没有请联系睿小象进行排查。

告警对应级别

睿象云 jira(fields.priority.id)
致命 --
严重 其余所有
警告 3
提醒 4
通知 5
睿象云 Jira
事件ID (eventId) issue.self

Cloud Alert 对接 JIRA

  1. 对接 jira software 和 jira service desk:

进入 CA 点击配置-JIRA 配置,输入 JIRA 地址 用户账号 密码 ,点击保存-同步项目

  1. 对接云 jira:

  2. 登录https://www.atlassian.com/ 申请账户

  3. 开通一个 jira software,在开通时保存你的 atlassian 站点地址

  4. 将这个地址填入:类似https://gaoyining.atlassian.net/

  5. 其中用户账号,为创建网站时的账户。

    密码需要经过https://id.atlassian.com/manage-profile/security/api-tokens网站获取api-token

    使用账户登录此网站,点击创建 API 令牌,输入 label,创建一个,点击复制,复制到密码栏

    到此配置完成。

    注意,jira cloud 中的项目想要同步,必须在 ca 中填写的用户信息是网站拥有者的账户,否则只能同步账户信息所有用项目权限的项目。

  6. 以上设置完毕后,CloudAlert 产生告警后,对应生成 jira 问题,本系统提供 2 种方式:

  7. 主告警发生时,自动触发生成一个对应的 jira 问题。【集成-创建某个应用时(非 JIRA 应用),可以选择开启自动创建 jira 问题开关】

  8. 在告警发生后,可针对未关闭的告警手动触发生成一个 jira 问题

注意事项

  1. 保证 jira 可以通过外网访问

  2. 用户需要在 jira 创建一个用户,并把此用户的账号密码,在 CA 中做个配置。一个团队共用一个 JIRA 账号

  3. 此 JIRA 用户,可以在 jira 中创建多个项目,此处可以做项目信息同步,用户在生成 JIRA 问题时,可以生成选择对应项目信息。

  4. CloudAlert 中的告警生成的 jira 问题都为故障|缺陷类型,优先级与告警级别对应。

  5. CloudAlert 中的告警状态变更,不会影响 jira 的状态变化,但是 jira 上问题的状态变化会同步更新 CloudAlert 中的告警状态

  6. 人员的同步信息以邮件地址为准,所以在使用此功能之前请保证 jira 中的相关处理与 CloudAlert 中用户邮件地址保持一致

  7. 同步项目时,如果提示"无法同步项目,JIRA 账号权限不足"则需要首先验证用户名密码是否正确。

Cloud Alert 与 JIRA 对应关系

  1. 告警标题:jira 的标题

  2. 告警内容:描述+影响版本:XX;附件:X 个;备注:XXXX

示例:XXXXXXXXXXXX。影响版本:202103;附件:无;备注:无。

示例:XXXXXXXXXXXX。影响版本:无;附件:3;备注:XXXXX。

ps:没有就写无

  1. 级别:优先级

  2. 告警对象:JIRA+项目名+类型

  3. 示例:JIRAaiops2020CA 缺陷

当 jira 有变更时,包含以上内容【标题,描述,备注,类型,级别,人】都需要对应更新告警的相关信息,同时更新一下 alarm 的更新时间和告警发生次数。

每一次更新都需要做通知【支持短信和电话通知】

通知内容为:告警编号:XXXX;告警标题:XXXXX 在 2020 年 11 月 21 日 16:05 发生变更,变更内容:名称变更为 XXXX,描述变更为 XXXX,备注变更为,附件发生变更。级别变更为 XXXX,类型变更为 XXX。

  1. jira -> CA

创建 JIRA 到 CA 生成告警的类型有:事件,问题,故障,新增功能,新功能,改进。

  1. CA->JIRA

CA 手动生成告警,主要类型有:

故障,缺陷,新增功能,新功能,改进,问题,事件,更改,Bug,Incident,Problem,Improvement,

Change,Submit a request or incident,[System] Incident,[System] Problem

  1. 兼容云 JIRA 类型

JIRA software 的模板类型:缺陷跟踪、看板、Scrum

JIRA Service-Management 的模板类型:IT 服务管理、外部服务项目、一般服务项目