flashduty-knowledge-base 1.2.4-beta.5 → 1.2.5-beta.1

package/dist/iife/zh.js

@@ -5144,13 +5144,33 @@ sidebarDepth: 3
     - 确保账户已经完成关联，前往 飞书 > 工作台 > 搜索应用名称 > 打开应用，完成一次登录并关联（飞书< - >Flashduty）账号。如果已经登录过，尝试点击右上角菜单，切换账户，重新登录来绑定账号
     - 确保已购买足够的 license，已使用 license 情况，可以在控制台 > 费用中心查看
 
-2. **分派策略飞书群聊列表为空**？
+3. **分派策略飞书群聊列表为空**？
 
     - 前往 飞书，选择群聊会话，添加已创建的Flashduty机器人，如下图所示：
     - 回到分派策略配置页面，刷新后重新选择群聊列表
 
 <img alt="drawing" width="800" src="https://download.flashcat.cloud/feishu-self-app-invite-to-chat.jpeg" />
 <img src="https://download.flashcat.cloud/feishu-self-app-notify-rule.png" alt="drawing" width="800"/>
+
+4. **飞书自建应用 API 限制：** [飞书文档说明](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/platform-updates-/custom-app-api-call-limit)
+
+    **调用量限制：**
+
+    |     飞书版本     | 调用总量/月 | 刷新时间  |                       
+    | :----------: | :--: | :----: |
+    |基础免费版|10,000 次|每个自然月的 1 号|
+    |其他版本|不限制|-|        
+
+    **频控限制：**
+
+    |    场景     | 限制 |                   
+    | :----------: | :--: | 
+    |所有接口|每个应用最高频率 50 次/秒|
+    |发消息接口|每个应用最高频率 1000 次/分钟|
+    |群机器人 Webhook|最高频率 100 次/分钟|
+    |给同一个用户或同一个群发消息|最高频率 5 次/秒|
+
+    **注意：** 超出限制后将无法正常推送消息，建议合理使用通知渠道
 `,Dingtalk:`---
 title: "钉钉集成"
 description: "通过集成钉钉自建应用，实现在钉钉端内接收和响应告警的能力"
@@ -5302,6 +5322,15 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide"
 
 <img src="https://download.flashcat.cloud/dingtalk-self-app-notify-rule.png" alt="drawing" width="800"/>
 
+4. **钉钉自建应用 API 调用量：** [钉钉文档说明](https://open.dingtalk.com/document/orgapp/descriptions-about-adjusting-limit-and-frequency-of-api-calls?spm=ding_open_doc.document.0.0.6f6b21d9WtkxJI)
+
+|     钉钉版本     | 调用总量/月 | QPS| 刷新时间  |                       
+| :----------: | :--: | :----: | :----:|
+|标准版|10,000 次|20|每月1日|
+|专业版|50万次|40|     每月1日          |
+|专属版|550万次|60|     每月1日          |
+
+**注意：** 超出限制后将无法正常推送消息，建议合理使用通知渠道
 `,Wecom:`---
 title: "企业微信集成"
 description: "通过集成企业微信第三方应用，实现在企业微信端内接收和响应告警的能力"
@@ -5722,6 +5751,7 @@ curl -X POST 'https://example.com/alert/webhook?a=a' \\
 |    i_rslv    | 关闭故障（自动或手动关闭） |
 |   i_reopen   | 重新打开故障     |
 |   i_merge    | 手动合并故障     |
+|   i_comm     | 添加评论     |
 |  i_r_title   | 更新故障标题     |
 |   i_r_desc   | 更新故障描述     |
 |  i_r_impact  | 更新故障影响     |
@@ -6198,7 +6228,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/template-settings"
 ---
 **引用变量示例**：
 
-\`\`\`
+\`\`\`go
 // 引用标题
 {{.Title}}
 
@@ -6302,7 +6332,7 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
    - 渲染失败后，系统将使用默认模板兜底，来保证消息可达；
    - 推荐您在不确定引用变量是否存在时，使用逻辑判断来避免渲染异常，如\`resource\`标签：
 
-   \`\`\`
+   \`\`\`go
    // 错误做法：直接读取标签
    {{.Labels.resource}}
 
@@ -6312,7 +6342,7 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
 
 3. **故障标题含有“>”之类的\`字符转义\`？**
 
-   \`\`\`
+   \`\`\`go
    // 使用toHtml函数
    {{toHtml .Title}}
 
@@ -6322,7 +6352,7 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
 
 4. **时间变量都是时间戳类型，如何\`转换时间格式\`？**
 
-   \`\`\`
+   \`\`\`go
    // date函数，将时间戳转换可读格式
    // "2006-01-02 15:04:05"是一种常见格式，更多格式请检索网络
    {{date "2006-01-02 15:04:05" .StartTime}}
@@ -6332,7 +6362,7 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
    \`\`\`
 
 5. **如何在 for 循环内部引用外部变量？**
-   \`\`\`
+   \`\`\`go
    // 在外部变量前增加”$“
    {{range .Responders}}
    	{{if eq $.Progress "Triggered"}}
@@ -6342,14 +6372,14 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
    \`\`\`
 6. **如何提取命名中带”.“的字段值，如标签中的“obj.instance”的信息？**
 
-   \`\`\`
+   \`\`\`go
    // 使用index函数
    {{index .Labels "obj.instance"}}
    \`\`\`
 
 7. **如何提取故障关联告警中某个label的信息并去重？**
 
-   \`\`\`
+   \`\`\`go
    // 使用alertLabels函数，得到去重后的数组
    {{alertLabels . "resource"}}
 
@@ -6359,7 +6389,7 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
 
 8. **如何遍历并打印labels？**
 
-   \`\`\`
+   \`\`\`go
    // 完整遍历
    {{range $k, $v := .Labels}}
      {{$k}} : {{toHtml $v}}
@@ -6412,7 +6442,7 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
 ---
 您需要预先配置 \`集成中心-即时消息-飞书\` 集成，才能发送消息卡片。如果不设置自定义内容，将采用系统默认模板，渲染全部标签信息：
 
-\`\`\`
+\`\`\`go
 {{if .Description}}**description** :{{toHtml .Labels.body_text .Description}}{{end}}
 {{if .Labels.resource}}**resource** : {{toHtml (joinAlertLabels . "resource" ", ")}}{{end}}
 {{range $k, $v := .Labels}}
@@ -6428,7 +6458,7 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
 - 我们列出了一些常见标签，您可自行删减；
 - 在飞书应用中，系统会自动帮您删除（因标签不存在导致的）渲染空行，您可放心配置
 
-\`\`\`
+\`\`\`go
 {{if (index .Labels "resource")}}resource：{{toHtml (joinAlertLabels . "resource" ", ")}}{{end}}
 {{if (index .Labels "check")}}check：{{toHtml (index .Labels "check")}}{{end}}
 {{if (index .Labels "metric")}}metric：{{index .Labels "metric"}}{{end}}
@@ -6458,7 +6488,7 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
 ---
 您需要预先配置 \`集成中心-即时消息-钉钉\` 集成，才能发送消息卡片。如果不设置自定义内容，将采用系统默认模板，渲染全部标签信息：
 
-\`\`\`
+\`\`\`go
 {{if .Description}}**description** :{{toHtml .Labels.body_text .Description}}{{end}}
 {{if .Labels.resource}}**resource** : {{toHtml (joinAlertLabels . "resource" ", ")}}{{end}}
 {{range $k, $v := .Labels}}
@@ -6474,7 +6504,7 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
 - 我们列出了一些常见标签，您可自行删减；
 - 在钉钉应用中，系统会自动帮您删除（因标签不存在导致的）渲染空行，您可放心配置
 
-\`\`\`
+\`\`\`go
 {{if (index .Labels "resource")}}**resource**：{{toHtml (joinAlertLabels . "resource" ", ")}}{{end}}
 {{if (index .Labels "metric")}}**metric**：{{index .Labels "metric"}}{{end}}
 {{if (index .Labels "prom_ql")}}**prom_ql**：{{toHtml (index .Labels "prom_ql")}}{{end}}
@@ -6507,7 +6537,7 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
 - 我们列出了一些常见标签，您可自行删减；
 - 在企业微信应用中，系统会自动帮您删除（因标签不存在导致的）渲染空行，您可放心配置
 
-\`\`\`
+\`\`\`go
 {{if (index .Labels "resource")}}resource：{{toHtml (joinAlertLabels . "resource" ", ")}}{{end}}
 {{if (index .Labels "metric")}}metric：{{index .Labels "metric"}}{{end}}
 {{if (index .Labels "prom_ql")}}prom_ql：{{toHtml (index .Labels "prom_ql")}}{{end}}
@@ -6543,7 +6573,7 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
 ---
 您需要预先配置 \`集成中心-即时消息- Slack\` 集成，才能发送消息卡片。如果不设置自定义内容，将采用系统默认模板，仅渲染常见标签信息：
 
-\`\`\`
+\`\`\`go
 {{if .Description}}*description* :{{toHtml .Labels.body_text .Description}}{{end}}
 {{if .Labels.resource}}*resource* : {{toHtml (joinAlertLabels . "resource" ", ")}}{{end}}
 {{range $k, $v := .Labels}}
@@ -6561,7 +6591,7 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
 - 消息可以发送长度为15000左右字符，超出后截断发送；
 - 在 Slack 应用中，系统会自动帮您删除（因标签不存在导致的）渲染空行，您可放心配置
 
-\`\`\`
+\`\`\`go
 {{if (index .Labels "resource")}}*resource*：{{toHtml (joinAlertLabels . "resource" ", ")}}{{end}}
 {{if (index .Labels "metric")}}*metric*：{{index .Labels "metric"}}{{end}}
 {{if (index .Labels "prom_ql")}}*prom_ql*：{{toHtml (index .Labels "prom_ql")}}{{end}}
@@ -6590,7 +6620,7 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
 ---
 您需要预先配置 \`集成中心-即时消息- Microsoft Teams\` 集成，才能发送消息卡片。如果不设置自定义内容，将采用系统默认模板，仅渲染常见标签信息：
 
-\`\`\`
+\`\`\`go
 {{if .Description}}**description** :{{toHtml .Labels.body_text .Description}}{{end}}
 {{if .Labels.resource}}**resource** : {{toHtml (joinAlertLabels . "resource" ", ")}}{{end}}
 {{range $k, $v := .Labels}}
@@ -6608,7 +6638,7 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
 - 消息可以发送长度为 28KB 左右字节，超出后报错；
 - 在 Microsoft Teams 应用中，系统会自动帮您删除（因标签不存在导致的）渲染空行，您可放心配置
 
-\`\`\`
+\`\`\`go
 {{if (index .Labels "resource")}}**resource**：{{toHtml (joinAlertLabels . "resource" ", ")}}{{end}}
 {{if (index .Labels "metric")}}**metric**：{{index .Labels "metric"}}{{end}}
 {{if (index .Labels "prom_ql")}}**prom_ql**：{{toHtml (index .Labels "prom_ql")}}{{end}}
@@ -6635,13 +6665,214 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
 
 ## 飞书机器人
 ---
-飞书机器人仅支持发送纯文本消息。
+飞书机器人支持消息卡片，富文本和普通文本三种格式，默认模版是消息卡片格式。
 
+- msg_type 字段在消息卡片和富文本中必填，否则当成普通文本格式发送
 - 消息\`最大长度为4000字节，超出后截断发送\`；
-- 如果文本中包含\`<br>\`，渲染时会\`先删除空行，再将<br>替换为换行符\`；
 - 如果不设置自定义内容，将采用系统默认模板，仅展示关键信息：
 
+1. 消息卡片
+msg_type 必填，值为 interactive
+\`\`\`json
+{
+  "msg_type": "interactive",
+  "card": {
+    "config": {
+      "wide_screen_mode": true,
+      "enable_forward": true
+    },
+    "header": {
+      "template": "{{if eq .IncidentSeverity "Critical"}}red{{else if eq .IncidentSeverity "Warning"}}orange{{else}}yellow{{end}}",
+      "title": {
+        "content": "{{fireReason .}}INC #{{.Num}} {{toHtml .Title}}",
+        "tag": "plain_text"
+      }
+    },
+    "elements": [{
+      "tag": "div",
+      "fields": [{
+          "text": {
+            "tag": "lark_md",
+            "content": "**🏢 协作空间:**{{if .ChannelName}}{{.ChannelName}}{{else}}无{{end}}"
+          }
+        },
+        {
+          "text": {
+            "tag": "lark_md",
+            "content": "**{{if eq .IncidentSeverity "Critical"}}🔴{{else if eq .IncidentSeverity "Warning"}}⚠️{{else}}ℹ️{{end}} 严重程度:**{{.IncidentSeverity}}"
+          }
+        },
+        {
+          "text": {
+            "tag": "lark_md",
+            "content": "**⏰ 触发时间:**{{date "2006-01-02 15:04:05" .StartTime}}{{if gt .AlertCnt 1}}"
+          }
+        },
+        {
+          "text": {
+            "tag": "lark_md",
+            "content": "**🔔 聚合告警:**{{.AlertCnt}}条 {{end}}{{if .Labels.resource}}"
+          }
+        },
+        {
+          "tag": "div",
+          "text": {
+            "tag": "lark_md",
+            "content": "**📌 告警对象:**{{toHtml (joinAlertLabels . "resource" ",")}} {{end}}{{if .Description}}"
+          }
+        },
+        {
+          "tag": "div",
+          "text": {
+            "tag": "lark_md",
+            "content": "**🔍 故障描述:**{{.Description}}{{end}}{{if gt (len .Responders) 0}}"
+          }
+        },
+        {
+          "tag": "div",
+          "text": {
+            "tag": "lark_md",
+            "content": "**👨‍💻 处理人员:**{{range .Responders}}@{{.PersonName}} {{end}}{{end}}"
+          }
+        }
+      ]
+    },
+    {
+      "tag": "hr"
+    },
+    {
+      "tag": "action",
+      "actions": [{
+          "tag": "button",
+          "text": {
+            "tag": "plain_text",
+            "content": "故障详情"
+          },
+          "type": "primary",
+          "url": "{{.DetailUrl}}"
+        },
+        {
+          "tag": "button",
+          "text": {
+            "tag": "plain_text",
+            "content": "认领"
+          },
+          "type": "primary",
+          "url": "{{.DetailUrl}}?ack=1"
+        }
+      ]
+    }]
+  }
+}
+\`\`\`
+
+2. 富文本
+msg_type 必填，值为 post
+\`\`\`json
+{
+    "msg_type": "post",
+    "post": {
+        "zh_cn": {
+            "title": "{{if eq .IncidentSeverity "Critical"}}🔴{{else if eq .IncidentSeverity "Warning"}}⚠️{{else}}ℹ️{{end}} {{fireReason .}}INC #{{.Num}} {{toHtml .Title}}",
+            "content": [
+                [{
+                    "tag": "text",
+                    "text": "🏢 "
+                }, {
+                    "tag": "text",
+                    "text": "协作空间：",
+                    "text_type": "bold"
+                }, {
+                    "tag": "text",
+                    "text": "{{if .ChannelName}}{{.ChannelName}}{{else}}无{{end}}\\n"
+                }],
+                [{
+                    "tag": "text",
+                    "text": "{{if eq .IncidentSeverity "Critical"}}🔴{{else if eq .IncidentSeverity "Warning"}}⚠️{{else}}ℹ️{{end}} "
+                }, {
+                    "tag": "text",
+                    "text": "严重程度：",
+                    "text_type": "bold"
+                }, {
+                    "tag": "text",
+                    "text": "{{.IncidentSeverity}}\\n",
+                    "text_type": "{{if eq .IncidentSeverity "Critical"}}bold{{end}}"
+                }],
+                [{
+                    "tag": "text",
+                    "text": "⏰ "
+                }, {
+                    "tag": "text",
+                    "text": "触发时间：",
+                    "text_type": "bold"
+                }, {
+                    "tag": "text",
+                    "text": "{{date "2006-01-02 15:04:05" .StartTime}}\\n"
+                }],
+                {{if gt .AlertCnt 1}}[{
+                    "tag": "text",
+                    "text": "🔔 "
+                }, {
+                    "tag": "text",
+                    "text": "聚合告警：",
+                    "text_type": "bold"
+                }, {
+                    "tag": "text",
+                    "text": "{{.AlertCnt}}条\\n"
+                }],{{end}}
+                {{if .Labels.resource}}[{
+                    "tag": "text",
+                    "text": "📋 "
+                }, {
+                    "tag": "text",
+                    "text": "告警对象：",
+                    "text_type": "bold"
+                }, {
+                    "tag": "text",
+                    "text": "{{toHtml (joinAlertLabels . "resource" ", ")}}\\n"
+                }],{{end}}
+                {{if .Description}}[{
+                    "tag": "text",
+                    "text": "📝 "
+                }, {
+                    "tag": "text",
+                    "text": "描述：",
+                    "text_type": "bold"
+                }, {
+                    "tag": "text",
+                    "text": "{{toHtml .Description}}\\n"
+                }],{{end}}
+                {{if gt (len .Responders) 0}}[{
+                    "tag": "text",
+                    "text": "👨‍💻 "
+                }, {
+                    "tag": "text",
+                    "text": "处理人员：",
+                    "text_type": "bold"
+                }, {
+                    "tag": "text",
+                    "text": "{{range .Responders}}@{{.PersonName}} {{end}}\\n"
+                }],{{end}}
+                [{
+                    "tag": "a",
+                    "href": "{{.DetailUrl}}",
+                    "text": "故障详情"
+                },{
+                    "tag": "text",
+                    "text": "  "
+                },{
+                    "tag": "a",
+                    "href": "{{.DetailUrl}}?ack=1",
+                    "text": "认领"
+                }]
+            ]
+        }
+    }
+}
 \`\`\`
+
+3. 普通文本
+\`\`\`go
 {{fireReason .}}INC #{{.Num}} {{toHtml .Title}}
 -----
 协作空间：{{if .ChannelName}}{{.ChannelName}}{{else}}无{{end}}
@@ -6667,7 +6898,7 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
 - 如果文本中包含\`<br>\`，渲染时会\`先删除空行，再将<br>替换为换行符\`；
 - 如果不设置自定义内容，将采用系统默认模板，仅展示关键信息：
 
-\`\`\`
+\`\`\`go
 {{fireReason .}}INC [#{{.Num}}]({{.DetailUrl}}) {{toHtml .Title}}
 
 ---
@@ -6694,7 +6925,7 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
 - 如果文本中包含\`<br>\`，渲染时会\`先删除空行，再将<br>替换为换行符\`；
 - 如果不设置自定义内容，将采用系统默认模板，仅展示关键信息：
 
-\`\`\`
+\`\`\`go
 {{fireReason .}}**INC [#{{.Num}}]({{.DetailUrl}}) {{toHtml .Title}}**
 > 协作空间：<font color="warning">{{if .ChannelName}}{{.ChannelName}}{{else}}无{{end}}</font>
 > 严重程度：<font color="warning">{{.IncidentSeverity}}</font>
@@ -6718,7 +6949,7 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
 - 如果文本中包含\`<br>\`，渲染时会\`先删除空行，再将<br>替换为换行符\`；
 - 如果不设置自定义内容，将采用系统默认模板，仅展示关键信息：
 
-\`\`\`
+\`\`\`go
 {{fireReason .}}INC [#{{.Num}}]({{.DetailUrl}}) {{toHtml .Title}}
 -----
 协作空间：{{if .ChannelName}}{{.ChannelName}}{{else}}无{{end}}
@@ -6742,7 +6973,7 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
 - 如果文本中包含\`<br>\`，渲染时会\`先删除空行，再将<br>替换为换行符\`；
 - 如果不设置自定义内容，将采用系统默认模板，仅展示关键信息：
 
-\`\`\`
+\`\`\`go
 {{fireReason .}}INC <{{.DetailUrl}}|#{{.Num}}> {{toHtml .Title}}
 -----
 协作空间：{{if .ChannelName}}{{.ChannelName}}{{else}}无{{end}}
@@ -6767,7 +6998,7 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
 - 消息格式 \`遵循Zoom消息格式\`，当前机器人应用不支持Markdown，其他格式可以参考官网: https://developers.zoom.us/docs/team-chat-apps/customizing-messages/
 - 如果不设置自定义内容，将采用系统默认模板，仅展示关键信息：
 
-\`\`\`
+\`\`\`json
 {"head": {
     "text": "{{fireReason .}}INC [#{{.Num}}] {{toHtml .Title}}",
     "style": {
@@ -6878,7 +7109,7 @@ CloseTime | int64 | 否 | 关闭时间，EndTime 为告警恢复时间，CloseTi
 ---
 如果不设置自定义内容，将采用系统默认模板渲染通知：
 
-\`\`\`
+\`\`\`html
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
 <title>{{.Title}}</title>
@@ -7076,4 +7307,89 @@ url: "https://docs.flashcat.cloud/zh/flashduty/huawei-apm-integration-guide"
 
 </div>
 
+`,JiraSync:`---
+title: "Jira 同步"
+description: "通过 Jira 同步 Webhook，实现故障与 Jira Issue 的关联。"
+date: "2024-05-11T10:00:00+08:00"
+url: "https://docs.flashcat.cloud/zh/flashduty/jira-sync"
+---
+
+通过 Jira 同步 Webhook，将 Flashduty 的故障与 Jira Issue 进行关联同步，实现 Flashduty 与 Jira 的联动。
+
+## 前提说明
+- 该集成兼容 Jira Cloud 以及 Jira Server 和 Jira Data Center 的 7.x 和 8.x 版本。
+- 目前仅支持将故障相关信息或状态单向同步到 Jira 中，Jira 中的信息不会同步到 Flashduty 中。
+- 对于 Jira Cloud，请在授权配置的密码处填写 API Token；而对于Jira Server 或 Data Center，则使用您的 Jira 账户登录密码即可。
+
+## 在 Jira Cloud 中获取 API Token （Jira Server 和 Data Center 请跳过）
+
+- 登录 Jira Cloud 后，点击右上角头像，选择 **管理账户**。
+- 在 **管理账户** 页面中，选择 **安全性** 选项卡。
+- 在 **安全性** 页面中，点击 **创建并管理 API 令牌** 按钮。
+- 在 **创建并管理 API 令牌** 弹窗中，填写 API token 名称，并选择过期时间。
+- 点击 **创建** 按钮，创建 API token。
+- 创建完成后，复制 API token 值，并粘贴到 Flashduty 授权配置中的 API 令牌处。
+
+## 在 Flashduty 中配置集成
+
+### 1. 创建并认证 Jira 集成
+<div class="hide">
+
+在集成中心，选择 **Webhook** ，选择 **Jira 同步** 集成，并填写以下认证信息。
+
+</div>
+
+- **Jira 平台类型**：根据您使用的版本进行选择，如果是 Data Center 版本的请选择私有化（Server） 即可。
+- **服务地址**：Cloud 版本请填写您的实际访问地址，例如： https://your-domain.atlassian.net，Server 版本请填写您的服务访问地址，例如： https://your-jira-server-url.com。
+- **用户名**：您的 Jira 账户名，Cloud 版本请填写您的邮箱，Server 版本请填写您的 Jira 账户名。
+- **API令牌/密码**：您的 Jira 账户密码，Cloud 版本请填写 API Token，Server 版本请填写您的 Jira 账户密码。
+- 填写完成后，点击 **下一步** 按钮，进行相关配置。
+
+**关于权限**：请确保您的 Jira 账户拥有获取相关项目、事务类型以及创建 Issue 等权限，建议使用管理员账户。
+
+### 2. Jira 集成配置
+
+- **集成名称**：为当前集成定义一个名称。
+- **触发模式**：
+    - 自动触发：需要配置相应的条件，Flashduty 会自动将符合条件的故障同步到 Jira 中。
+    - 手动触发：需要在故障详情页的更多操作中手动触发 Jira 同步（该集成配置的名称为触发器名称）。
+- **项目 ID**：选择需要同步至 Jira 的项目。
+- **事务类型**：选择需要同步至 Jira 的事务类型。
+- **协作空间**：选择该集成生效的协作空间，只有该协作空间内的故障才可以同步至 Jira 中。
+- **严重程度映射**：如果选择的事务类型不支持优先级字段，则无法配置该映射关系。
+- **自定义字段映射**：可以选择将故障的某些标签或所有标签以及自定义字段内容同步至 Jira 的字段中（仅支持文本类型的字段）。
+
+### 3. 关于更新
+
+- 已经创建 Issue 的故障，如果您更新了故障的严重程度、状态，Jira 中会自动更新，但 Jira 中的更新不会同步到 Flashduty 中。
+- 评论信息会同步到 Jira 中，但 Jira 中更新的内容不会同步到 Flashduty 中。
+- 更新故障中的标题、描述、标签等字段的信息，Jira 中不会更新。
+
+
+### 4. Flashduty 与 Jira 的映射关系
+
+#### 字段映射
+
+| Jira |  Flashduty | 
+| ---------- | -------- | 
+|  摘要  | 标题 | 
+| 描述   | 描述  | 
+| 优先级 | 严重程度 | 
+| 报告人 | 集成配置的用户 | 
+| 评论 | 评论 | 
+
+
+#### 状态映射
+
+| Jira |  Flashduty | 
+| ---------- | -------- | 
+|  Todo  | 待处理 | 
+|  In Progress  | 处理中 | 
+|  Done  | 已解决 | 
+
+
+### 5. 注意事项
+
+- Flashduty 会按照默认的字段映射以及您配置的自定义字段映射进行同步信息，如果您的 Jira 事务类型中有必选的字段且没有配置映射关系，则会遇到创建 Jira Issue 失败的情况。
+- Jira 的 Issue 详情是基于项目 KEY + 编号的格式进行访问的，如果您修改了项目 KEY，可能无法通过 Flashduty 中保存的 Issue 地址进行访问，请谨慎修改项目 KEY。
 `};n.FlashDocsZh=t})(window);

package/dist/zh.d.ts

@@ -53,5 +53,6 @@ declare const docs: {
     CustomAction: string;
     Templates: string;
     HuaweiyunAPM: string;
+    JiraSync: string;
 };
 export default docs;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flashduty-knowledge-base",
-  "version": "1.2.4-beta.5",
+  "version": "1.2.5-beta.1",
   "description": "flashduty knowledge base",
   "type": "module",
   "scripts": {