flashduty-knowledge-base 1.2.4-beta.2 → 1.2.4-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/en.d.ts CHANGED
@@ -53,6 +53,5 @@ declare const docs: {
53
53
  CustomAction: string;
54
54
  Templates: string;
55
55
  HuaweiyunAPM: string;
56
- JiraSync: string;
57
56
  };
58
57
  export default docs;
package/dist/esm/en.js CHANGED
@@ -469,7 +469,7 @@ Nightingale/Flashcat to Flashduty alert severity mapping:
469
469
 
470
470
  </details>
471
471
 
472
- `,i=`---
472
+ `,o=`---
473
473
  title: "Prometheus Integration Guide"
474
474
  description: "Push Prometheus alert events to Flashduty through AlertManager using webhooks. When an alert is triggered, it sends a trigger event to Flashduty, and when the alert recovers, it sends a recovery event."
475
475
  date: "2024-05-11T10:00:00+08:00"
@@ -651,7 +651,7 @@ Prometheus to Flashduty severity mapping:
651
651
 
652
652
 
653
653
 
654
- `,o=`---
654
+ `,i=`---
655
655
  title: "Grafana Integration"
656
656
  description: "Sync Grafana alert events to Flashduty via webhook to achieve automated alert noise reduction."
657
657
  date: "2024-05-11T10:00:00+08:00"
@@ -3226,7 +3226,7 @@ Choose this option when you need to route alerts to different channels based on
3226
3226
 
3227
3227
  </div>
3228
3228
 
3229
- `,F=`---
3229
+ `,_=`---
3230
3230
  title: "Dynatrace Alert Events"
3231
3231
  description: "Sync Dynatrace alert events to Flashduty via webhook to achieve automated alert noise reduction."
3232
3232
  date: "2024-08-20T10:00:00+08:00"
@@ -3333,7 +3333,7 @@ Choose this option when you need to route alerts to different channels based on
3333
3333
  |CUSTOM_ALERT|Info|info|
3334
3334
 
3335
3335
  </div>
3336
- `,_=`---
3336
+ `,F=`---
3337
3337
  title: "Huawei Cloud LTS Alert Events"
3338
3338
  description: "Sync Huawei Cloud Log Tank Service (LTS) alert events to Flashduty via webhook for automated alert noise reduction."
3339
3339
  date: "2024-08-20T10:00:00+08:00"
@@ -4051,7 +4051,7 @@ Choose this method when you need to route alerts to different channels based on
4051
4051
  |Notice|Info|Info|
4052
4052
 
4053
4053
  </div>
4054
- `,P=`---
4054
+ `,N=`---
4055
4055
  title: "Volcengine Log Service (TLS) Alert Events"
4056
4056
  description: "Sync Volcengine Log Service (TLS) alert events to Flashduty via webhook for automated alert noise reduction"
4057
4057
  date: "2024-07-05T10:00:00+08:00"
@@ -4188,7 +4188,7 @@ Choose this method when you need to route alerts to different channels based on
4188
4188
  </div>
4189
4189
 
4190
4190
  </div>
4191
- `,N=`---
4191
+ `,P=`---
4192
4192
  title: "OpManager Alert Events"
4193
4193
  description: "Sync OpManager alert events to Flashduty via webhook for automated alert noise reduction"
4194
4194
  date: "2024-07-05T10:00:00+08:00"
@@ -5246,7 +5246,7 @@ Integrate WeCom third-party application to receive and respond to alerts within
5246
5246
  7. **Incident notification fails with \`WeCom License Not Activated\`?**
5247
5247
 
5248
5248
  - Contact Flashduty customer service or dedicated support for license purchase and activation
5249
- `,z=`---
5249
+ `,V=`---
5250
5250
  title: "Slack Integration"
5251
5251
  description: "Integrate with Slack to receive and respond to alerts within Slack"
5252
5252
  date: "2024-05-11T10:00:00+08:00"
@@ -5300,7 +5300,7 @@ Integrate with Slack to receive and respond to alerts within Slack.
5300
5300
 
5301
5301
  8. **Slack App shows Other questions error**
5302
5302
  - Try again, as this might be an unrecorded issue
5303
- - If the error persists, contact customer support`,V=`---
5303
+ - If the error persists, contact customer support`,z=`---
5304
5304
  title: "Microsoft Teams Integration"
5305
5305
  description: "Integrate Microsoft Teams as a third-party application to receive and respond to alerts within Microsoft Teams"
5306
5306
  date: "2024-05-11T10:00:00+08:00"
@@ -5395,7 +5395,7 @@ Please check in Integration Center => Instant Messaging => Microsoft Teams under
5395
5395
  Currently not supported
5396
5396
  </details>
5397
5397
 
5398
- `,J=`Configure alert webhooks to receive HTTP callbacks at your specified URL when alerts have specific actions (such as triggering or closing). The callback content includes the latest key information about the alert, allowing integration with your custom tools.
5398
+ `,K=`Configure alert webhooks to receive HTTP callbacks at your specified URL when alerts have specific actions (such as triggering or closing). The callback content includes the latest key information about the alert, allowing integration with your custom tools.
5399
5399
 
5400
5400
  <span id="EventTypes"></span>
5401
5401
 
@@ -5563,7 +5563,7 @@ curl -X POST 'https://example.com/alert/webhook?a=a' \\
5563
5563
  4. **Trusted IP whitelist for push sources?**
5564
5564
  - {ip_whitelist}
5565
5565
  - May be updated in the future, please check periodically
5566
- `,K=`Configure incident webhooks to receive HTTP callbacks at your specified URL when incidents have specific actions (such as triggering or closing). The callback content includes the latest key information about the incident, allowing integration with your custom tools.
5566
+ `,Z=`Configure incident webhooks to receive HTTP callbacks at your specified URL when incidents have specific actions (such as triggering or closing). The callback content includes the latest key information about the incident, allowing integration with your custom tools.
5567
5567
 
5568
5568
  <span id="EventTypes"></span>
5569
5569
 
@@ -5769,7 +5769,7 @@ curl -X POST 'https://example.com/incident/webhook?a=a' \\
5769
5769
 
5770
5770
  4. **Trusted IP whitelist for push sources?**
5771
5771
  - {ip_whitelist}
5772
- - May be updated in the future, please check periodically`,Z=`Custom incident actions allow you to quickly invoke external interfaces during incident troubleshooting for incident self-healing, information enrichment, and other custom operations.
5772
+ - May be updated in the future, please check periodically`,J=`Custom incident actions allow you to quickly invoke external interfaces during incident troubleshooting for incident self-healing, information enrichment, and other custom operations.
5773
5773
 
5774
5774
  ## I. Creating Actions
5775
5775
 
@@ -6017,88 +6017,6 @@ When an incident occurs and is confirmed to be caused by a change, directly trig
6017
6017
  ### Update Status Page
6018
6018
 
6019
6019
  When an incident is confirmed to affect online services, trigger external status page updates to prompt`,Q=`---
6020
- title: "Jira Sync"
6021
- description: "Sync incidents with Jira issues through Jira Sync Webhook."
6022
- date: "2024-05-11T10:00:00+08:00"
6023
- url: "https://docs.flashcat.cloud/en/flashduty/jira-sync"
6024
- ---
6025
-
6026
- Through Jira Sync Webhook, you can associate and synchronize Flashduty incidents with Jira Issues, enabling integration between Flashduty and Jira.
6027
-
6028
- ## Prerequisites
6029
- - This integration is compatible with Jira Cloud, as well as versions 7.x and 8.x of Jira Server and Jira Data Center.
6030
- - Currently, only one-way synchronization of incident information and status to Jira is supported. Information in Jira will not sync back to Flashduty.
6031
- - For Jira Cloud, use an API Token in the password field during authorization configuration; for Jira Server or Data Center, use your Jira account password.
6032
-
6033
- ## Getting API Token in Jira Cloud (Jira Server and Data Center please skip)
6034
-
6035
- - After logging into Jira Cloud, click your profile picture in the top right corner and select **Manage Account**.
6036
- - On the **Manage Account** page, select the **Security** tab.
6037
- - On the **Security** page, click **Create and manage API tokens**.
6038
- - In the **Create and manage API tokens** dialog, enter an API token name and select an expiration time.
6039
- - Click **Create** to generate the API token.
6040
- - Copy the API token value and paste it into the API token field in Flashduty's authorization configuration.
6041
-
6042
- ## Configuring Integration in Flashduty
6043
-
6044
- ### 1. Create and Authenticate Jira Integration
6045
- <div class="hide">
6046
-
6047
- In the Integration Center, select **Webhook**, choose **Jira Sync** integration, and fill in the following authentication information.
6048
-
6049
- </div>
6050
-
6051
- - **Jira Platform Type**: Choose based on your version. For Data Center version, select Self-hosted (Server).
6052
- - **Service URL**: For Cloud version, enter your actual access URL, e.g., https://your-domain.atlassian.net. For Server version, enter your service access URL, e.g., https://your-jira-server-url.com.
6053
- - **Username**: Your Jira account name. For Cloud version, enter your email; for Server version, enter your Jira username.
6054
- - **API Token/Password**: Your Jira account credentials. For Cloud version, enter API Token; for Server version, enter your Jira account password.
6055
- - After completion, click **Next** to proceed with configuration.
6056
-
6057
- **About Permissions**: Ensure your Jira account has permissions to access relevant projects, issue types, and create issues. Using an administrator account is recommended.
6058
-
6059
- ### 2. Jira Integration Configuration
6060
-
6061
- - **Integration Name**: Define a name for this integration.
6062
- - **Trigger Mode**:
6063
- - Automatic: Configure conditions for Flashduty to automatically sync qualifying incidents to Jira.
6064
- - Manual: Manually trigger Jira sync from the incident details page's more actions menu (integration name serves as trigger name).
6065
- - **Project ID**: Select the target Jira project for synchronization.
6066
- - **Issue Type**: Select the target Jira issue type.
6067
- - **Channel**: Select the channel where this integration will be active. Only incidents within this channel can sync to Jira.
6068
- - **Severity Mapping**: If the selected issue type doesn't support priority fields, this mapping cannot be configured.
6069
- - **Custom Field Mapping**: Choose to sync certain or all incident labels and custom field content to Jira fields (text type fields only).
6070
-
6071
- ### 3. About Updates
6072
-
6073
- - For incidents with existing Jira issues, updates to severity or status will automatically update in Jira, but Jira updates won't sync back to Flashduty.
6074
- - Comments sync to Jira, but Jira comments won't sync back to Flashduty.
6075
- - Updates to incident title, description, labels, or other fields won't update in Jira.
6076
-
6077
- ### 4. Flashduty to Jira Mapping
6078
-
6079
- #### Field Mapping
6080
-
6081
- | Jira | Flashduty |
6082
- | ---------- | -------- |
6083
- | Summary | Title |
6084
- | Description | Description |
6085
- | Priority | Severity |
6086
- | Reporter | Integration configured user |
6087
- | Comments | Comments |
6088
-
6089
- #### Status Mapping
6090
-
6091
- | Jira | Flashduty |
6092
- | ---------- | -------- |
6093
- | Todo | Pending |
6094
- | In Progress | In Progress |
6095
- | Done | Resolved |
6096
-
6097
- ### 5. Important Notes
6098
-
6099
- - Flashduty syncs information according to default field mappings and your custom field configurations. If your Jira issue type has required fields without mapping relationships, Jira issue creation may fail.
6100
- - Jira issue details are accessed using project KEY + number format. If you modify the project KEY, saved issue URLs in Flashduty may become inaccessible, so please modify project KEYs with caution.
6101
- `,X=`---
6102
6020
  title: "Configure Notification Templates"
6103
6021
  description: "Customize notification content through template configuration"
6104
6022
  date: "2024-05-10T10:00:00+08:00"
@@ -6701,4 +6619,4 @@ If custom content is not set, the system default template will be used for notif
6701
6619
  As shown below:
6702
6620
  <img src="https://download.flashcat.cloud/flashduty/doc/en/fd/template-mail-1.png" width="800">
6703
6621
 
6704
- `,ee={CustomAlert:n,Email:t,N9e:a,Prometheus:i,Grafana:o,Zabbix:s,UptimeKuma:r,AliyunARMS:l,AliyunCmEvent:d,AliyunCm:c,AliyunSLS:e,AWSCW:e,AzureMonitor:h,BaiDuBCM:u,HuaWeiCES:g,InfluxDB:p,OpenFalcon:m,PagerDuty:f,TencentBK:y,TencentCLS:v,TencentCm:b,TencentEb:w,OceanBase:C,Graylog:k,Skywalking:I,Sentry:S,Jiankongbao:A,AWSEventBridge:L,Dynatrace:F,HuaweiyunLTS:_,GoogleCM:x,Zilliz:Y,Splunk:R,AppDynamics:T,SolarWinds:U,VolcEngineMetric:E,VolcEngineEvent:D,VolcEngineTLS:P,OpManager:N,Meraki:M,StateCloud:W,Guance:G,CustomChange:O,Jira:j,Lark:$,Dingtalk:H,Wecom:B,Slack:z,MicrosoftTeams:V,AlertWebhook:J,IncidentWebhook:K,CustomAction:Z,Templates:X,HuaweiyunAPM:q,JiraSync:Q};module.exports=ee;
6622
+ `,X={CustomAlert:n,Email:t,N9e:a,Prometheus:o,Grafana:i,Zabbix:s,UptimeKuma:r,AliyunARMS:l,AliyunCmEvent:d,AliyunCm:c,AliyunSLS:e,AWSCW:e,AzureMonitor:h,BaiDuBCM:u,HuaWeiCES:g,InfluxDB:p,OpenFalcon:m,PagerDuty:f,TencentBK:y,TencentCLS:v,TencentCm:b,TencentEb:w,OceanBase:C,Graylog:k,Skywalking:I,Sentry:S,Jiankongbao:A,AWSEventBridge:L,Dynatrace:_,HuaweiyunLTS:F,GoogleCM:x,Zilliz:Y,Splunk:R,AppDynamics:T,SolarWinds:U,VolcEngineMetric:E,VolcEngineEvent:D,VolcEngineTLS:N,OpManager:P,Meraki:M,StateCloud:W,Guance:G,CustomChange:O,Jira:j,Lark:$,Dingtalk:H,Wecom:B,Slack:V,MicrosoftTeams:z,AlertWebhook:K,IncidentWebhook:Z,CustomAction:J,Templates:Q,HuaweiyunAPM:q};module.exports=X;
package/dist/esm/zh.js CHANGED
@@ -3251,7 +3251,7 @@ Sentry 提供了两类告警机制:Issue Alerts 和 Metric Alerts。Issue Aler
3251
3251
  |resolved|Ok|恢复|
3252
3252
 
3253
3253
  </div>
3254
- `,L=`---
3254
+ `,A=`---
3255
3255
  title: "监控宝告警事件"
3256
3256
  description: "通过 webhook 的方式同步监控宝告警事件到 Flashduty,实现告警事件自动化降噪处理"
3257
3257
  date: "2024-08-20T10:00:00+08:00"
@@ -3346,7 +3346,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/jiankongbao-integration-guide"
3346
3346
  |2|Info|提醒|
3347
3347
 
3348
3348
  </div>
3349
- `,A=`---
3349
+ `,S=`---
3350
3350
  title: "AWS EventBridge 告警事件"
3351
3351
  description: "通过 webhook 的方式同步 AWS EventBridge 告警事件到 Flashduty,实现告警事件自动化降噪处理"
3352
3352
  date: "2024-08-20T10:00:00+08:00"
@@ -3451,7 +3451,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/aws-eventbridge-integration-guide
3451
3451
 
3452
3452
  </div>
3453
3453
 
3454
- `,S=`---
3454
+ `,C=`---
3455
3455
  title: "Dynatrace 告警事件"
3456
3456
  description: "通过 webhook 的方式同步 Dynatrace 告警事件到 Flashduty,实现告警事件自动化降噪处理。"
3457
3457
  date: "2024-08-20T10:00:00+08:00"
@@ -3565,7 +3565,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dynatrace-integration-guide"
3565
3565
  |CUSTOM_ALERT|Info|提醒|
3566
3566
 
3567
3567
  </div>
3568
- `,C=`---
3568
+ `,L=`---
3569
3569
  title: "华为云日志服务 LTS 告警事件"
3570
3570
  description: "通过 webhook 的方式同步华为云日志服务 LTS 告警事件到 Flashduty,实现告警事件自动化降噪处理。"
3571
3571
  date: "2024-08-20T10:00:00+08:00"
@@ -4441,7 +4441,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/volcengine-tls-integration-guide"
4441
4441
  |通知|Info|提醒|
4442
4442
 
4443
4443
  </div>
4444
- `,W=`---
4444
+ `,R=`---
4445
4445
  title: "Opmanager 告警事件"
4446
4446
  description: "通过 webhook 的方式同步 Opmanager 告警事件到 Flashduty,实现告警事件自动化降噪处理"
4447
4447
  date: "2024-07-05T10:00:00+08:00"
@@ -4576,7 +4576,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/opmanager-integration-guide"
4576
4576
  | Attention | Info | 提醒 |
4577
4577
 
4578
4578
  </div>
4579
- `,R=`---
4579
+ `,W=`---
4580
4580
  title: "Meraki 告警事件"
4581
4581
  description: "通过 webhook 的方式同步 Meraki 告警事件到 Flashduty,实现告警事件自动化降噪处理"
4582
4582
  date: "2024-07-05T10:00:00+08:00"
@@ -4740,7 +4740,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/statecloud-integration-guide"
4740
4740
 
4741
4741
 
4742
4742
  </div>
4743
- `,j=`---
4743
+ `,U=`---
4744
4744
  title: "观测云告警事件"
4745
4745
  description: "通过 webhook 的方式同步观测云告警事件到 Flashduty,实现告警事件自动化降噪处理"
4746
4746
  date: "2024-07-05T10:00:00+08:00"
@@ -4828,7 +4828,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/guance-integration-guide"
4828
4828
  | 数据断档 | Info | 提醒 |
4829
4829
 
4830
4830
  </div>
4831
- `,U=`---
4831
+ `,j=`---
4832
4832
  title: "zilliz 告警事件"
4833
4833
  description: "通过 webhook 的方式同步 zilliz 告警事件到 Flashduty,实现告警事件自动化降噪处理"
4834
4834
  date: "2024-07-05T10:00:00+08:00"
@@ -5252,34 +5252,14 @@ sidebarDepth: 3
5252
5252
  - 确保账户已经完成关联,前往 飞书 > 工作台 > 搜索应用名称 > 打开应用,完成一次登录并关联(飞书< - >Flashduty)账号。如果已经登录过,尝试点击右上角菜单,切换账户,重新登录来绑定账号
5253
5253
  - 确保已购买足够的 license,已使用 license 情况,可以在控制台 > 费用中心查看
5254
5254
 
5255
- 3. **分派策略飞书群聊列表为空**?
5255
+ 2. **分派策略飞书群聊列表为空**?
5256
5256
 
5257
5257
  - 前往 飞书,选择群聊会话,添加已创建的Flashduty机器人,如下图所示:
5258
5258
  - 回到分派策略配置页面,刷新后重新选择群聊列表
5259
5259
 
5260
5260
  <img alt="drawing" width="800" src="https://download.flashcat.cloud/feishu-self-app-invite-to-chat.jpeg" />
5261
5261
  <img src="https://download.flashcat.cloud/feishu-self-app-notify-rule.png" alt="drawing" width="800"/>
5262
-
5263
- 4. **飞书自建应用 API 限制:** [飞书文档说明](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/platform-updates-/custom-app-api-call-limit)
5264
-
5265
- **调用量限制:**
5266
-
5267
- | 飞书版本 | 调用总量/月 | 刷新时间 |
5268
- | :----------: | :--: | :----: |
5269
- |基础免费版|10,000 次|每个自然月的 1 号|
5270
- |其他版本|不限制|-|
5271
-
5272
- **频控限制:**
5273
-
5274
- | 场景 | 限制 |
5275
- | :----------: | :--: |
5276
- |所有接口|每个应用最高频率 50 次/秒|
5277
- |发消息接口|每个应用最高频率 1000 次/分钟|
5278
- |群机器人 Webhook|最高频率 100 次/分钟|
5279
- |给同一个用户或同一个群发消息|最高频率 5 次/秒|
5280
-
5281
- **注意:** 超出限制后将无法正常推送消息,建议合理使用通知渠道
5282
- `,J=`---
5262
+ `,G=`---
5283
5263
  title: "钉钉集成"
5284
5264
  description: "通过集成钉钉自建应用,实现在钉钉端内接收和响应告警的能力"
5285
5265
  date: "2024-05-11T10:00:00+08:00"
@@ -5430,16 +5410,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide"
5430
5410
 
5431
5411
  <img src="https://download.flashcat.cloud/dingtalk-self-app-notify-rule.png" alt="drawing" width="800"/>
5432
5412
 
5433
- 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)
5434
-
5435
- | 钉钉版本 | 调用总量/月 | QPS| 刷新时间 |
5436
- | :----------: | :--: | :----: | :----:|
5437
- |标准版|10,000 次|20|每月1日|
5438
- |专业版|50万次|40| 每月1日 |
5439
- |专属版|550万次|60| 每月1日 |
5440
-
5441
- **注意:** 超出限制后将无法正常推送消息,建议合理使用通知渠道
5442
- `,G=`---
5413
+ `,V=`---
5443
5414
  title: "企业微信集成"
5444
5415
  description: "通过集成企业微信第三方应用,实现在企业微信端内接收和响应告警的能力"
5445
5416
  date: "2024-05-11T10:00:00+08:00"
@@ -5519,7 +5490,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/wecom-integration-guide"
5519
5490
  7. **故障通知失败,提示\`未开通企微许可\`?**
5520
5491
 
5521
5492
  - 联系 Flashduty 客服或专属支持,为您购买开通
5522
- `,V=`---
5493
+ `,Z=`---
5523
5494
  title: "Slack 集成"
5524
5495
  description: "通过集成Slack第三方应用,实现在Slack内接收和响应告警的能力"
5525
5496
  date: "2024-05-11T10:00:00+08:00"
@@ -5668,7 +5639,7 @@ Microsoft Teams 集成现处于 Beta 阶段,在关联前您需要先完成以
5668
5639
  暂不支持
5669
5640
  </details>
5670
5641
 
5671
- `,Z=`配置告警 Webhook,当告警发生特定操作(如触发、关闭)时,系统通过 HTTP 回调您配置的地址。回调内容将包含告警最新关键信息,您可以与自研工具进行集成。
5642
+ `,J=`配置告警 Webhook,当告警发生特定操作(如触发、关闭)时,系统通过 HTTP 回调您配置的地址。回调内容将包含告警最新关键信息,您可以与自研工具进行集成。
5672
5643
 
5673
5644
  <span id="EventTypes"></span>
5674
5645
 
@@ -6043,7 +6014,7 @@ curl -X POST 'https://example.com/incident/webhook?a=a' \\
6043
6014
 
6044
6015
  4. **推送来源可信 IP 白名单?**
6045
6016
  - {ip_whitelist}
6046
- - 未来可能会更新,请定期查验`,Y=`配置故障 自定义操作,允许您在故障排查期间,快速调用外部接口,实现故障自愈、信息丰富等任何自定义操作。
6017
+ - 未来可能会更新,请定期查验`,Q=`配置故障 自定义操作,允许您在故障排查期间,快速调用外部接口,实现故障自愈、信息丰富等任何自定义操作。
6047
6018
 
6048
6019
  ## 一、创建操作
6049
6020
 
@@ -6302,92 +6273,7 @@ curl -X POST 'https://example.com/incident/action?a=a' \\
6302
6273
 
6303
6274
  2. **推送来源可信 IP 白名单?**
6304
6275
  - {ip_whitelist}
6305
- - 未来可能会更新,请定期查验`,Q=`---
6306
- title: "Jira 同步"
6307
- description: "通过 Jira 同步 Webhook,实现故障与 Jira Issue 的关联。"
6308
- date: "2024-05-11T10:00:00+08:00"
6309
- url: "https://docs.flashcat.cloud/zh/flashduty/jira-sync"
6310
- ---
6311
-
6312
- 通过 Jira 同步 Webhook,将 Flashduty 的故障与 Jira Issue 进行关联同步,实现 Flashduty 与 Jira 的联动。
6313
-
6314
- ## 前提说明
6315
- - 该集成兼容 Jira Cloud 以及 Jira Server 和 Jira Data Center 的 7.x 和 8.x 版本。
6316
- - 目前仅支持将故障相关信息或状态单向同步到 Jira 中,Jira 中的信息不会同步到 Flashduty 中。
6317
- - 对于 Jira Cloud,请在授权配置的密码处填写 API Token;而对于Jira Server 或 Data Center,则使用您的 Jira 账户登录密码即可。
6318
-
6319
- ## 在 Jira Cloud 中获取 API Token (Jira Server 和 Data Center 请跳过)
6320
-
6321
- - 登录 Jira Cloud 后,点击右上角头像,选择 **管理账户**。
6322
- - 在 **管理账户** 页面中,选择 **安全性** 选项卡。
6323
- - 在 **安全性** 页面中,点击 **创建并管理 API 令牌** 按钮。
6324
- - 在 **创建并管理 API 令牌** 弹窗中,填写 API token 名称,并选择过期时间。
6325
- - 点击 **创建** 按钮,创建 API token。
6326
- - 创建完成后,复制 API token 值,并粘贴到 Flashduty 授权配置中的 API 令牌处。
6327
-
6328
- ## 在 Flashduty 中配置集成
6329
-
6330
- ### 1. 创建并认证 Jira 集成
6331
- <div class="hide">
6332
-
6333
- 在集成中心,选择 **Webhook** ,选择 **Jira 同步** 集成,并填写以下认证信息。
6334
-
6335
- </div>
6336
-
6337
- - **Jira 平台类型**:根据您使用的版本进行选择,如果是 Data Center 版本的请选择私有化(Server) 即可。
6338
- - **服务地址**:Cloud 版本请填写您的实际访问地址,例如: https://your-domain.atlassian.net,Server 版本请填写您的服务访问地址,例如: https://your-jira-server-url.com。
6339
- - **用户名**:您的 Jira 账户名,Cloud 版本请填写您的邮箱,Server 版本请填写您的 Jira 账户名。
6340
- - **API令牌/密码**:您的 Jira 账户密码,Cloud 版本请填写 API Token,Server 版本请填写您的 Jira 账户密码。
6341
- - 填写完成后,点击 **下一步** 按钮,进行相关配置。
6342
-
6343
- **关于权限**:请确保您的 Jira 账户拥有获取相关项目、事务类型以及创建 Issue 等权限,建议使用管理员账户。
6344
-
6345
- ### 2. Jira 集成配置
6346
-
6347
- - **集成名称**:为当前集成定义一个名称。
6348
- - **触发模式**:
6349
- - 自动触发:需要配置相应的条件,Flashduty 会自动将符合条件的故障同步到 Jira 中。
6350
- - 手动触发:需要在故障详情页的更多操作中手动触发 Jira 同步(该集成配置的名称为触发器名称)。
6351
- - **项目 ID**:选择需要同步至 Jira 的项目。
6352
- - **事务类型**:选择需要同步至 Jira 的事务类型。
6353
- - **协作空间**:选择该集成生效的协作空间,只有该协作空间内的故障才可以同步至 Jira 中。
6354
- - **严重程度映射**:如果选择的事务类型不支持优先级字段,则无法配置该映射关系。
6355
- - **自定义字段映射**:可以选择将故障的某些标签或所有标签以及自定义字段内容同步至 Jira 的字段中(仅支持文本类型的字段)。
6356
-
6357
- ### 3. 关于更新
6358
-
6359
- - 已经创建 Issue 的故障,如果您更新了故障的严重程度、状态,Jira 中会自动更新,但 Jira 中的更新不会同步到 Flashduty 中。
6360
- - 评论信息会同步到 Jira 中,但 Jira 中更新的内容不会同步到 Flashduty 中。
6361
- - 更新故障中的标题、描述、标签等字段的信息,Jira 中不会更新。
6362
-
6363
-
6364
- ### 4. Flashduty 与 Jira 的映射关系
6365
-
6366
- #### 字段映射
6367
-
6368
- | Jira | Flashduty |
6369
- | ---------- | -------- |
6370
- | 摘要 | 标题 |
6371
- | 描述 | 描述 |
6372
- | 优先级 | 严重程度 |
6373
- | 报告人 | 集成配置的用户 |
6374
- | 评论 | 评论 |
6375
-
6376
-
6377
- #### 状态映射
6378
-
6379
- | Jira | Flashduty |
6380
- | ---------- | -------- |
6381
- | Todo | 待处理 |
6382
- | In Progress | 处理中 |
6383
- | Done | 已解决 |
6384
-
6385
-
6386
- ### 5. 注意事项
6387
-
6388
- - Flashduty 会按照默认的字段映射以及您配置的自定义字段映射进行同步信息,如果您的 Jira 事务类型中有必选的字段且没有配置映射关系,则会遇到创建 Jira Issue 失败的情况。
6389
- - Jira 的 Issue 详情是基于项目 KEY + 编号的格式进行访问的,如果您修改了项目 KEY,可能无法通过 Flashduty 中保存的 Issue 地址进行访问,请谨慎修改项目 KEY。
6390
- `,nn=`---
6276
+ - 未来可能会更新,请定期查验`,Y=`---
6391
6277
  title: "配置通知模版"
6392
6278
  description: "通过自定义配置模版,可以实现个性化通知内容的需求"
6393
6279
  date: "2024-05-10T10:00:00+08:00"
@@ -6628,6 +6514,8 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6628
6514
  以下为各通知渠道具体说明。
6629
6515
 
6630
6516
 
6517
+ <div class="feishu_app hide">
6518
+
6631
6519
  ## 飞书应用
6632
6520
  ---
6633
6521
  您需要预先配置 \`集成中心-即时消息-飞书\` 集成,才能发送消息卡片。如果不设置自定义内容,将采用系统默认模板,渲染全部标签信息:
@@ -6670,8 +6558,9 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6670
6558
  {{if (index .Labels "mode")}}mode:{{index .Labels "mode"}}{{end}}
6671
6559
  {{if (index .Labels "runbook_url")}}runbook_url:{{toHtml (index .Labels "runbook_url")}}{{end}}
6672
6560
  \`\`\`
6561
+ </div>
6673
6562
 
6674
-
6563
+ <div class="dingtalk_app hide">
6675
6564
 
6676
6565
  ## 钉钉应用
6677
6566
  ---
@@ -6714,7 +6603,9 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6714
6603
  {{if (index .Labels "mode")}}**mode**:{{index .Labels "mode"}}{{end}}
6715
6604
  {{if (index .Labels "runbook_url")}}**runbook_url**:{{index .Labels "runbook_url"}}{{end}}
6716
6605
  \`\`\`
6606
+ </div>
6717
6607
 
6608
+ <div class="wecom_app hide">
6718
6609
 
6719
6610
  ## 企业微信应用
6720
6611
  ---
@@ -6752,7 +6643,9 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6752
6643
 
6753
6644
  **注意,企业微信限制了卡片长度,在模板渲染区域,您最多可以渲染不超过 8 行内容,超过 8 行的部分将被隐藏**
6754
6645
 
6646
+ </div>
6755
6647
 
6648
+ <div class="slack_app hide">
6756
6649
 
6757
6650
  ## Slack 应用
6758
6651
  ---
@@ -6797,56 +6690,9 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6797
6690
  {{if (index .Labels "mode")}}*mode*:{{index .Labels "mode"}}{{end}}
6798
6691
  {{if (index .Labels "runbook_url")}}*runbook_url*:{{index .Labels "runbook_url"}}{{end}}
6799
6692
  \`\`\`
6693
+ </div>
6800
6694
 
6801
-
6802
-
6803
- ## Microsoft Teams 应用
6804
- ---
6805
- 您需要预先配置 \`集成中心-即时消息- Microsoft Teams\` 集成,才能发送消息卡片。如果不设置自定义内容,将采用系统默认模板,仅渲染常见标签信息:
6806
-
6807
- \`\`\`
6808
- {{if .Description}}**description** :{{toHtml .Labels.body_text .Description}}{{end}}
6809
- {{if .Labels.resource}}**resource** : {{toHtml (joinAlertLabels . "resource" ", ")}}{{end}}
6810
- {{range $k, $v := .Labels}}
6811
- {{if not (in $k "resource" "body_text" "body_text_with_table")}}**{{$k}}** : {{toHtml $v}}{{end}}{{end}}
6812
- \`\`\`
6813
-
6814
-
6815
- 如下图所示:
6816
-
6817
- <img src="https://download.flashcat.cloud/flashduty/integration/microsoft-teams/teams_app_message.png" alt="drawing" style="display: block; margin: 0 auto;" width="300"/>
6818
-
6819
- 如果您期望仅展示关键标签信息,可以参照下边的代码段:
6820
-
6821
- - 我们列出了一些常见标签,您可自行删减;
6822
- - 消息可以发送长度为 28KB 左右字节,超出后报错;
6823
- - 在 Microsoft Teams 应用中,系统会自动帮您删除(因标签不存在导致的)渲染空行,您可放心配置
6824
-
6825
- \`\`\`
6826
- {{if (index .Labels "resource")}}**resource**:{{toHtml (joinAlertLabels . "resource" ", ")}}{{end}}
6827
- {{if (index .Labels "metric")}}**metric**:{{index .Labels "metric"}}{{end}}
6828
- {{if (index .Labels "prom_ql")}}**prom_ql**:{{toHtml (index .Labels "prom_ql")}}{{end}}
6829
- {{if (index .Labels "trigger_value")}}**trigger_value**:{{index .Labels "trigger_value"}}{{end}}
6830
- {{if (index .Labels "host_ql")}}**host_ql**:{{index .Labels "host_ql"}}{{end}}
6831
- {{if (index .Labels "region")}}**region**:{{index .Labels "region"}}{{end}}
6832
- {{if (index .Labels "cluster")}}**cluster**:{{index .Labels "cluster"}}{{end}}
6833
- {{if (index .Labels "business")}}**business**:{{index .Labels "business"}}{{end}}
6834
- {{if (index .Labels "service")}}**service**:{{index .Labels "service"}}{{end}}
6835
- {{if (index .Labels "env")}}**env**:{{index .Labels "env"}}{{end}}
6836
- {{if (index .Labels "type")}}**type**:{{index .Labels "type"}}{{end}}
6837
- {{if (index .Labels "topic")}}**topic**:{{index .Labels "topic"}}{{end}}
6838
- {{if (index .Labels "cpu")}}**cpu**:{{index .Labels "cpu"}}{{end}}
6839
- {{if (index .Labels "device")}}**device**:{{index .Labels "device"}}{{end}}
6840
- {{if (index .Labels "path")}}**path**:{{index .Labels "path"}}{{end}}
6841
- {{if (index .Labels "fstype")}}**fstype**:{{index .Labels "fstype"}}{{end}}
6842
- {{if (index .Labels "name")}}**name**:{{index .Labels "name"}}{{end}}
6843
- {{if (index .Labels "mode")}}**mode**:{{index .Labels "mode"}}{{end}}
6844
- {{if (index .Labels "runbook_url")}}**runbook_url**:{{index .Labels "runbook_url"}}{{end}}
6845
- \`\`\`
6846
-
6847
-
6848
-
6849
-
6695
+ <div class="teams_app hide">
6850
6696
 
6851
6697
  ## Microsoft Teams 应用
6852
6698
  ---
@@ -6891,8 +6737,9 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6891
6737
  {{if (index .Labels "mode")}}**mode**:{{index .Labels "mode"}}{{end}}
6892
6738
  {{if (index .Labels "runbook_url")}}**runbook_url**:{{index .Labels "runbook_url"}}{{end}}
6893
6739
  \`\`\`
6740
+ </div>
6894
6741
 
6895
-
6742
+ <div class="feishu hide">
6896
6743
 
6897
6744
  ## 飞书机器人
6898
6745
  ---
@@ -6915,8 +6762,10 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6915
6762
  分派人员:{{range .Responders}}@{{.PersonName}} {{end}}{{end}}
6916
6763
  <br>详情:{{.DetailUrl}}
6917
6764
  \`\`\`
6765
+ </div>
6918
6766
 
6919
6767
 
6768
+ <div class="dingtalk hide">
6920
6769
 
6921
6770
  ## 钉钉机器人
6922
6771
  ---
@@ -6941,8 +6790,9 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6941
6790
  ---
6942
6791
  <br>[详情]({{.DetailUrl}})|[认领]({{.DetailUrl}}?ack=1)
6943
6792
  \`\`\`
6793
+ </div>
6944
6794
 
6945
-
6795
+ <div class="wecom hide">
6946
6796
 
6947
6797
  ## 企业微信机器人
6948
6798
  ---
@@ -6964,11 +6814,13 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6964
6814
  > 分派人员:{{range .Responders}}@{{.PersonName}} {{end}}{{end}}
6965
6815
  <br>[详情]({{.DetailUrl}})|[认领]({{.DetailUrl}}?ack=1)
6966
6816
  \`\`\`
6817
+ </div>
6967
6818
 
6968
-
6819
+ <div class="telegram hide">
6969
6820
 
6970
6821
  ## Telegram 机器人
6971
6822
  ---
6823
+
6972
6824
  - 配置国内能访问的Telegram服务地址;
6973
6825
  - 消息\`最大长度为4096字符,超出后不发送\`;
6974
6826
  - 如果文本中包含\`<br>\`,渲染时会\`先删除空行,再将<br>替换为换行符\`;
@@ -6988,8 +6840,9 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6988
6840
 
6989
6841
  <br>[详情]({{.DetailUrl}})|[认领]({{.DetailUrl}}?ack=1)
6990
6842
  \`\`\`
6843
+ </div>
6991
6844
 
6992
-
6845
+ <div class="slack hide">
6993
6846
 
6994
6847
  ## Slack 机器人
6995
6848
  ---
@@ -7011,6 +6864,9 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
7011
6864
  -----
7012
6865
  <br><{{.DetailUrl}}|详情>|<{{.DetailUrl}}?ack=1|认领>
7013
6866
  \`\`\`
6867
+ </div>
6868
+
6869
+ <div class="zoom hide">
7014
6870
 
7015
6871
  ## Zoom 机器人
7016
6872
  ---
@@ -7110,8 +6966,10 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
7110
6966
  ]
7111
6967
  }
7112
6968
  \`\`\`
6969
+ </div>
7113
6970
 
7114
6971
 
6972
+ <div class="sms hide">
7115
6973
 
7116
6974
  ## 短信
7117
6975
  ---
@@ -7120,8 +6978,9 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
7120
6978
  \`\`\`
7121
6979
  您有故障待处理:{{toHtml .Title}},协作空间:{{.ChannelName}},等级:{{.IncidentSeverity}}{{if gt .AlertCnt 1}},共聚合{{.AlertCnt}}条告警{{end}}
7122
6980
  \`\`\`
6981
+ </div>
7123
6982
 
7124
-
6983
+ <div class="email hide">
7125
6984
 
7126
6985
  ## 邮件
7127
6986
  ---
@@ -7216,5 +7075,5 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
7216
7075
 
7217
7076
  <img src="https://download.flashcat.cloud/flashduty/changelog/20230720/email_render.png" alt="drawing" style="display: block; margin: 0 auto;" width="500"/>
7218
7077
 
7219
-
7220
- `,tn={CustomAlert:n,Email:t,N9e:e,Prometheus:a,Grafana:i,Zabbix:s,UptimeKuma:l,AliyunARMS:d,AliyunCmEvent:o,AliyunCm:r,AliyunSLS:c,AWSCW:u,AzureMonitor:h,BaiDuBCM:m,HuaWeiCES:p,InfluxDB:g,OpenFalcon:y,PagerDuty:f,TencentBK:b,TencentCLS:v,TencentCm:w,TencentEb:_,OceanBase:k,Graylog:F,Skywalking:x,Sentry:T,Jiankongbao:L,AWSEventBridge:A,Dynatrace:S,HuaweiyunLTS:C,GoogleCM:I,Splunk:D,AppDynamics:P,SolarWinds:M,VolcEngineMetric:N,VolcEngineEvent:E,VolcEngineTLS:$,OpManager:W,Meraki:R,Zilliz:U,StateCloud:z,Guance:j,CustomChange:O,Jira:q,Lark:B,Dingtalk:J,Wecom:G,Slack:V,MicrosoftTeams:K,AlertWebhook:Z,IncidentWebhook:X,CustomAction:Y,Templates:nn,HuaweiyunAPM:H,JiraSync:Q};module.exports=tn;
7078
+ </div>
7079
+ `,nn={CustomAlert:n,Email:t,N9e:e,Prometheus:a,Grafana:i,Zabbix:s,UptimeKuma:l,AliyunARMS:d,AliyunCmEvent:o,AliyunCm:r,AliyunSLS:c,AWSCW:u,AzureMonitor:h,BaiDuBCM:m,HuaWeiCES:p,InfluxDB:g,OpenFalcon:y,PagerDuty:f,TencentBK:b,TencentCLS:v,TencentCm:w,TencentEb:_,OceanBase:k,Graylog:F,Skywalking:x,Sentry:T,Jiankongbao:A,AWSEventBridge:S,Dynatrace:C,HuaweiyunLTS:L,GoogleCM:I,Splunk:D,AppDynamics:P,SolarWinds:M,VolcEngineMetric:N,VolcEngineEvent:E,VolcEngineTLS:$,OpManager:R,Meraki:W,Zilliz:j,StateCloud:z,Guance:U,CustomChange:O,Jira:q,Lark:B,Dingtalk:G,Wecom:V,Slack:Z,MicrosoftTeams:K,AlertWebhook:J,IncidentWebhook:X,CustomAction:Q,Templates:Y,HuaweiyunAPM:H};module.exports=nn;
package/dist/iife/en.js CHANGED
@@ -311,7 +311,7 @@ attachment_stripped = true
311
311
 
312
312
  Currently, all alerts pushed to Flashduty through email integration are set to Warning severity.
313
313
 
314
- `,i=`---
314
+ `,o=`---
315
315
  title: "Nightingale/FlashCat Integration"
316
316
  description: "Push alert events from Nightingale (n9e) or Flashcat to Flashduty via webhook. When an alert is triggered, send a trigger event to Flashduty; when an alert recovers, send a recovery event to Flashduty"
317
317
  date: "2024-05-11T10:00:00+08:00"
@@ -469,7 +469,7 @@ Nightingale/Flashcat to Flashduty alert severity mapping:
469
469
 
470
470
  </details>
471
471
 
472
- `,o=`---
472
+ `,i=`---
473
473
  title: "Prometheus Integration Guide"
474
474
  description: "Push Prometheus alert events to Flashduty through AlertManager using webhooks. When an alert is triggered, it sends a trigger event to Flashduty, and when the alert recovers, it sends a recovery event."
475
475
  date: "2024-05-11T10:00:00+08:00"
@@ -1554,7 +1554,7 @@ Alibaba Cloud SLS monitoring to Flashduty alert severity mapping:
1554
1554
  | 2 | Info | Info |
1555
1555
 
1556
1556
  </div>
1557
- `,u={CustomAlert:t,Email:a,N9e:i,Prometheus:o,Grafana:s,Zabbix:r,UptimeKuma:l,AliyunARMS:d,AliyunCmEvent:c,AliyunCm:h,AliyunSLS:e,AWSCW:e,AzureMonitor:`---
1557
+ `,u={CustomAlert:t,Email:a,N9e:o,Prometheus:i,Grafana:s,Zabbix:r,UptimeKuma:l,AliyunARMS:d,AliyunCmEvent:c,AliyunCm:h,AliyunSLS:e,AWSCW:e,AzureMonitor:`---
1558
1558
  title: "AWS CloudWatch Integration"
1559
1559
  description: "Sync AWS CloudWatch alert events to Flashduty via webhook to achieve automated alert noise reduction"
1560
1560
  date: "2024-05-11T10:00:00+08:00"
@@ -6619,86 +6619,4 @@ When you need to route alerts to different channels based on alert payload infor
6619
6619
 
6620
6620
  </div>
6621
6621
 
6622
- `,JiraSync:`---
6623
- title: "Jira Sync"
6624
- description: "Sync incidents with Jira issues through Jira Sync Webhook."
6625
- date: "2024-05-11T10:00:00+08:00"
6626
- url: "https://docs.flashcat.cloud/en/flashduty/jira-sync"
6627
- ---
6628
-
6629
- Through Jira Sync Webhook, you can associate and synchronize Flashduty incidents with Jira Issues, enabling integration between Flashduty and Jira.
6630
-
6631
- ## Prerequisites
6632
- - This integration is compatible with Jira Cloud, as well as versions 7.x and 8.x of Jira Server and Jira Data Center.
6633
- - Currently, only one-way synchronization of incident information and status to Jira is supported. Information in Jira will not sync back to Flashduty.
6634
- - For Jira Cloud, use an API Token in the password field during authorization configuration; for Jira Server or Data Center, use your Jira account password.
6635
-
6636
- ## Getting API Token in Jira Cloud (Jira Server and Data Center please skip)
6637
-
6638
- - After logging into Jira Cloud, click your profile picture in the top right corner and select **Manage Account**.
6639
- - On the **Manage Account** page, select the **Security** tab.
6640
- - On the **Security** page, click **Create and manage API tokens**.
6641
- - In the **Create and manage API tokens** dialog, enter an API token name and select an expiration time.
6642
- - Click **Create** to generate the API token.
6643
- - Copy the API token value and paste it into the API token field in Flashduty's authorization configuration.
6644
-
6645
- ## Configuring Integration in Flashduty
6646
-
6647
- ### 1. Create and Authenticate Jira Integration
6648
- <div class="hide">
6649
-
6650
- In the Integration Center, select **Webhook**, choose **Jira Sync** integration, and fill in the following authentication information.
6651
-
6652
- </div>
6653
-
6654
- - **Jira Platform Type**: Choose based on your version. For Data Center version, select Self-hosted (Server).
6655
- - **Service URL**: For Cloud version, enter your actual access URL, e.g., https://your-domain.atlassian.net. For Server version, enter your service access URL, e.g., https://your-jira-server-url.com.
6656
- - **Username**: Your Jira account name. For Cloud version, enter your email; for Server version, enter your Jira username.
6657
- - **API Token/Password**: Your Jira account credentials. For Cloud version, enter API Token; for Server version, enter your Jira account password.
6658
- - After completion, click **Next** to proceed with configuration.
6659
-
6660
- **About Permissions**: Ensure your Jira account has permissions to access relevant projects, issue types, and create issues. Using an administrator account is recommended.
6661
-
6662
- ### 2. Jira Integration Configuration
6663
-
6664
- - **Integration Name**: Define a name for this integration.
6665
- - **Trigger Mode**:
6666
- - Automatic: Configure conditions for Flashduty to automatically sync qualifying incidents to Jira.
6667
- - Manual: Manually trigger Jira sync from the incident details page's more actions menu (integration name serves as trigger name).
6668
- - **Project ID**: Select the target Jira project for synchronization.
6669
- - **Issue Type**: Select the target Jira issue type.
6670
- - **Channel**: Select the channel where this integration will be active. Only incidents within this channel can sync to Jira.
6671
- - **Severity Mapping**: If the selected issue type doesn't support priority fields, this mapping cannot be configured.
6672
- - **Custom Field Mapping**: Choose to sync certain or all incident labels and custom field content to Jira fields (text type fields only).
6673
-
6674
- ### 3. About Updates
6675
-
6676
- - For incidents with existing Jira issues, updates to severity or status will automatically update in Jira, but Jira updates won't sync back to Flashduty.
6677
- - Comments sync to Jira, but Jira comments won't sync back to Flashduty.
6678
- - Updates to incident title, description, labels, or other fields won't update in Jira.
6679
-
6680
- ### 4. Flashduty to Jira Mapping
6681
-
6682
- #### Field Mapping
6683
-
6684
- | Jira | Flashduty |
6685
- | ---------- | -------- |
6686
- | Summary | Title |
6687
- | Description | Description |
6688
- | Priority | Severity |
6689
- | Reporter | Integration configured user |
6690
- | Comments | Comments |
6691
-
6692
- #### Status Mapping
6693
-
6694
- | Jira | Flashduty |
6695
- | ---------- | -------- |
6696
- | Todo | Pending |
6697
- | In Progress | In Progress |
6698
- | Done | Resolved |
6699
-
6700
- ### 5. Important Notes
6701
-
6702
- - Flashduty syncs information according to default field mappings and your custom field configurations. If your Jira issue type has required fields without mapping relationships, Jira issue creation may fail.
6703
- - Jira issue details are accessed using project KEY + number format. If you modify the project KEY, saved issue URLs in Flashduty may become inaccessible, so please modify project KEYs with caution.
6704
6622
  `};n.FlashDocsEn=u})(window);
package/dist/iife/zh.js CHANGED
@@ -5144,33 +5144,13 @@ sidebarDepth: 3
5144
5144
  - 确保账户已经完成关联,前往 飞书 > 工作台 > 搜索应用名称 > 打开应用,完成一次登录并关联(飞书< - >Flashduty)账号。如果已经登录过,尝试点击右上角菜单,切换账户,重新登录来绑定账号
5145
5145
  - 确保已购买足够的 license,已使用 license 情况,可以在控制台 > 费用中心查看
5146
5146
 
5147
- 3. **分派策略飞书群聊列表为空**?
5147
+ 2. **分派策略飞书群聊列表为空**?
5148
5148
 
5149
5149
  - 前往 飞书,选择群聊会话,添加已创建的Flashduty机器人,如下图所示:
5150
5150
  - 回到分派策略配置页面,刷新后重新选择群聊列表
5151
5151
 
5152
5152
  <img alt="drawing" width="800" src="https://download.flashcat.cloud/feishu-self-app-invite-to-chat.jpeg" />
5153
5153
  <img src="https://download.flashcat.cloud/feishu-self-app-notify-rule.png" alt="drawing" width="800"/>
5154
-
5155
- 4. **飞书自建应用 API 限制:** [飞书文档说明](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/platform-updates-/custom-app-api-call-limit)
5156
-
5157
- **调用量限制:**
5158
-
5159
- | 飞书版本 | 调用总量/月 | 刷新时间 |
5160
- | :----------: | :--: | :----: |
5161
- |基础免费版|10,000 次|每个自然月的 1 号|
5162
- |其他版本|不限制|-|
5163
-
5164
- **频控限制:**
5165
-
5166
- | 场景 | 限制 |
5167
- | :----------: | :--: |
5168
- |所有接口|每个应用最高频率 50 次/秒|
5169
- |发消息接口|每个应用最高频率 1000 次/分钟|
5170
- |群机器人 Webhook|最高频率 100 次/分钟|
5171
- |给同一个用户或同一个群发消息|最高频率 5 次/秒|
5172
-
5173
- **注意:** 超出限制后将无法正常推送消息,建议合理使用通知渠道
5174
5154
  `,Dingtalk:`---
5175
5155
  title: "钉钉集成"
5176
5156
  description: "通过集成钉钉自建应用,实现在钉钉端内接收和响应告警的能力"
@@ -5322,15 +5302,6 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide"
5322
5302
 
5323
5303
  <img src="https://download.flashcat.cloud/dingtalk-self-app-notify-rule.png" alt="drawing" width="800"/>
5324
5304
 
5325
- 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)
5326
-
5327
- | 钉钉版本 | 调用总量/月 | QPS| 刷新时间 |
5328
- | :----------: | :--: | :----: | :----:|
5329
- |标准版|10,000 次|20|每月1日|
5330
- |专业版|50万次|40| 每月1日 |
5331
- |专属版|550万次|60| 每月1日 |
5332
-
5333
- **注意:** 超出限制后将无法正常推送消息,建议合理使用通知渠道
5334
5305
  `,Wecom:`---
5335
5306
  title: "企业微信集成"
5336
5307
  description: "通过集成企业微信第三方应用,实现在企业微信端内接收和响应告警的能力"
@@ -6435,6 +6406,8 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6435
6406
  以下为各通知渠道具体说明。
6436
6407
 
6437
6408
 
6409
+ <div class="feishu_app hide">
6410
+
6438
6411
  ## 飞书应用
6439
6412
  ---
6440
6413
  您需要预先配置 \`集成中心-即时消息-飞书\` 集成,才能发送消息卡片。如果不设置自定义内容,将采用系统默认模板,渲染全部标签信息:
@@ -6477,8 +6450,9 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6477
6450
  {{if (index .Labels "mode")}}mode:{{index .Labels "mode"}}{{end}}
6478
6451
  {{if (index .Labels "runbook_url")}}runbook_url:{{toHtml (index .Labels "runbook_url")}}{{end}}
6479
6452
  \`\`\`
6453
+ </div>
6480
6454
 
6481
-
6455
+ <div class="dingtalk_app hide">
6482
6456
 
6483
6457
  ## 钉钉应用
6484
6458
  ---
@@ -6521,7 +6495,9 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6521
6495
  {{if (index .Labels "mode")}}**mode**:{{index .Labels "mode"}}{{end}}
6522
6496
  {{if (index .Labels "runbook_url")}}**runbook_url**:{{index .Labels "runbook_url"}}{{end}}
6523
6497
  \`\`\`
6498
+ </div>
6524
6499
 
6500
+ <div class="wecom_app hide">
6525
6501
 
6526
6502
  ## 企业微信应用
6527
6503
  ---
@@ -6559,7 +6535,9 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6559
6535
 
6560
6536
  **注意,企业微信限制了卡片长度,在模板渲染区域,您最多可以渲染不超过 8 行内容,超过 8 行的部分将被隐藏**
6561
6537
 
6538
+ </div>
6562
6539
 
6540
+ <div class="slack_app hide">
6563
6541
 
6564
6542
  ## Slack 应用
6565
6543
  ---
@@ -6604,56 +6582,9 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6604
6582
  {{if (index .Labels "mode")}}*mode*:{{index .Labels "mode"}}{{end}}
6605
6583
  {{if (index .Labels "runbook_url")}}*runbook_url*:{{index .Labels "runbook_url"}}{{end}}
6606
6584
  \`\`\`
6585
+ </div>
6607
6586
 
6608
-
6609
-
6610
- ## Microsoft Teams 应用
6611
- ---
6612
- 您需要预先配置 \`集成中心-即时消息- Microsoft Teams\` 集成,才能发送消息卡片。如果不设置自定义内容,将采用系统默认模板,仅渲染常见标签信息:
6613
-
6614
- \`\`\`
6615
- {{if .Description}}**description** :{{toHtml .Labels.body_text .Description}}{{end}}
6616
- {{if .Labels.resource}}**resource** : {{toHtml (joinAlertLabels . "resource" ", ")}}{{end}}
6617
- {{range $k, $v := .Labels}}
6618
- {{if not (in $k "resource" "body_text" "body_text_with_table")}}**{{$k}}** : {{toHtml $v}}{{end}}{{end}}
6619
- \`\`\`
6620
-
6621
-
6622
- 如下图所示:
6623
-
6624
- <img src="https://download.flashcat.cloud/flashduty/integration/microsoft-teams/teams_app_message.png" alt="drawing" style="display: block; margin: 0 auto;" width="300"/>
6625
-
6626
- 如果您期望仅展示关键标签信息,可以参照下边的代码段:
6627
-
6628
- - 我们列出了一些常见标签,您可自行删减;
6629
- - 消息可以发送长度为 28KB 左右字节,超出后报错;
6630
- - 在 Microsoft Teams 应用中,系统会自动帮您删除(因标签不存在导致的)渲染空行,您可放心配置
6631
-
6632
- \`\`\`
6633
- {{if (index .Labels "resource")}}**resource**:{{toHtml (joinAlertLabels . "resource" ", ")}}{{end}}
6634
- {{if (index .Labels "metric")}}**metric**:{{index .Labels "metric"}}{{end}}
6635
- {{if (index .Labels "prom_ql")}}**prom_ql**:{{toHtml (index .Labels "prom_ql")}}{{end}}
6636
- {{if (index .Labels "trigger_value")}}**trigger_value**:{{index .Labels "trigger_value"}}{{end}}
6637
- {{if (index .Labels "host_ql")}}**host_ql**:{{index .Labels "host_ql"}}{{end}}
6638
- {{if (index .Labels "region")}}**region**:{{index .Labels "region"}}{{end}}
6639
- {{if (index .Labels "cluster")}}**cluster**:{{index .Labels "cluster"}}{{end}}
6640
- {{if (index .Labels "business")}}**business**:{{index .Labels "business"}}{{end}}
6641
- {{if (index .Labels "service")}}**service**:{{index .Labels "service"}}{{end}}
6642
- {{if (index .Labels "env")}}**env**:{{index .Labels "env"}}{{end}}
6643
- {{if (index .Labels "type")}}**type**:{{index .Labels "type"}}{{end}}
6644
- {{if (index .Labels "topic")}}**topic**:{{index .Labels "topic"}}{{end}}
6645
- {{if (index .Labels "cpu")}}**cpu**:{{index .Labels "cpu"}}{{end}}
6646
- {{if (index .Labels "device")}}**device**:{{index .Labels "device"}}{{end}}
6647
- {{if (index .Labels "path")}}**path**:{{index .Labels "path"}}{{end}}
6648
- {{if (index .Labels "fstype")}}**fstype**:{{index .Labels "fstype"}}{{end}}
6649
- {{if (index .Labels "name")}}**name**:{{index .Labels "name"}}{{end}}
6650
- {{if (index .Labels "mode")}}**mode**:{{index .Labels "mode"}}{{end}}
6651
- {{if (index .Labels "runbook_url")}}**runbook_url**:{{index .Labels "runbook_url"}}{{end}}
6652
- \`\`\`
6653
-
6654
-
6655
-
6656
-
6587
+ <div class="teams_app hide">
6657
6588
 
6658
6589
  ## Microsoft Teams 应用
6659
6590
  ---
@@ -6698,8 +6629,9 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6698
6629
  {{if (index .Labels "mode")}}**mode**:{{index .Labels "mode"}}{{end}}
6699
6630
  {{if (index .Labels "runbook_url")}}**runbook_url**:{{index .Labels "runbook_url"}}{{end}}
6700
6631
  \`\`\`
6632
+ </div>
6701
6633
 
6702
-
6634
+ <div class="feishu hide">
6703
6635
 
6704
6636
  ## 飞书机器人
6705
6637
  ---
@@ -6722,8 +6654,10 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6722
6654
  分派人员:{{range .Responders}}@{{.PersonName}} {{end}}{{end}}
6723
6655
  <br>详情:{{.DetailUrl}}
6724
6656
  \`\`\`
6657
+ </div>
6725
6658
 
6726
6659
 
6660
+ <div class="dingtalk hide">
6727
6661
 
6728
6662
  ## 钉钉机器人
6729
6663
  ---
@@ -6748,8 +6682,9 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6748
6682
  ---
6749
6683
  <br>[详情]({{.DetailUrl}})|[认领]({{.DetailUrl}}?ack=1)
6750
6684
  \`\`\`
6685
+ </div>
6751
6686
 
6752
-
6687
+ <div class="wecom hide">
6753
6688
 
6754
6689
  ## 企业微信机器人
6755
6690
  ---
@@ -6771,11 +6706,13 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6771
6706
  > 分派人员:{{range .Responders}}@{{.PersonName}} {{end}}{{end}}
6772
6707
  <br>[详情]({{.DetailUrl}})|[认领]({{.DetailUrl}}?ack=1)
6773
6708
  \`\`\`
6709
+ </div>
6774
6710
 
6775
-
6711
+ <div class="telegram hide">
6776
6712
 
6777
6713
  ## Telegram 机器人
6778
6714
  ---
6715
+
6779
6716
  - 配置国内能访问的Telegram服务地址;
6780
6717
  - 消息\`最大长度为4096字符,超出后不发送\`;
6781
6718
  - 如果文本中包含\`<br>\`,渲染时会\`先删除空行,再将<br>替换为换行符\`;
@@ -6795,8 +6732,9 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6795
6732
 
6796
6733
  <br>[详情]({{.DetailUrl}})|[认领]({{.DetailUrl}}?ack=1)
6797
6734
  \`\`\`
6735
+ </div>
6798
6736
 
6799
-
6737
+ <div class="slack hide">
6800
6738
 
6801
6739
  ## Slack 机器人
6802
6740
  ---
@@ -6818,6 +6756,9 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6818
6756
  -----
6819
6757
  <br><{{.DetailUrl}}|详情>|<{{.DetailUrl}}?ack=1|认领>
6820
6758
  \`\`\`
6759
+ </div>
6760
+
6761
+ <div class="zoom hide">
6821
6762
 
6822
6763
  ## Zoom 机器人
6823
6764
  ---
@@ -6917,8 +6858,10 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6917
6858
  ]
6918
6859
  }
6919
6860
  \`\`\`
6861
+ </div>
6920
6862
 
6921
6863
 
6864
+ <div class="sms hide">
6922
6865
 
6923
6866
  ## 短信
6924
6867
  ---
@@ -6927,8 +6870,9 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
6927
6870
  \`\`\`
6928
6871
  您有故障待处理:{{toHtml .Title}},协作空间:{{.ChannelName}},等级:{{.IncidentSeverity}}{{if gt .AlertCnt 1}},共聚合{{.AlertCnt}}条告警{{end}}
6929
6872
  \`\`\`
6873
+ </div>
6930
6874
 
6931
-
6875
+ <div class="email hide">
6932
6876
 
6933
6877
  ## 邮件
6934
6878
  ---
@@ -7023,7 +6967,7 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
7023
6967
 
7024
6968
  <img src="https://download.flashcat.cloud/flashduty/changelog/20230720/email_render.png" alt="drawing" style="display: block; margin: 0 auto;" width="500"/>
7025
6969
 
7026
-
6970
+ </div>
7027
6971
  `,HuaweiyunAPM:`---
7028
6972
  title: "华为云 APM 告警事件"
7029
6973
  description: "通过 webhook 的方式同步华为云 APM 告警事件到 Flashduty,实现告警事件自动化降噪处理"
@@ -7132,89 +7076,4 @@ url: "https://docs.flashcat.cloud/zh/flashduty/huawei-apm-integration-guide"
7132
7076
 
7133
7077
  </div>
7134
7078
 
7135
- `,JiraSync:`---
7136
- title: "Jira 同步"
7137
- description: "通过 Jira 同步 Webhook,实现故障与 Jira Issue 的关联。"
7138
- date: "2024-05-11T10:00:00+08:00"
7139
- url: "https://docs.flashcat.cloud/zh/flashduty/jira-sync"
7140
- ---
7141
-
7142
- 通过 Jira 同步 Webhook,将 Flashduty 的故障与 Jira Issue 进行关联同步,实现 Flashduty 与 Jira 的联动。
7143
-
7144
- ## 前提说明
7145
- - 该集成兼容 Jira Cloud 以及 Jira Server 和 Jira Data Center 的 7.x 和 8.x 版本。
7146
- - 目前仅支持将故障相关信息或状态单向同步到 Jira 中,Jira 中的信息不会同步到 Flashduty 中。
7147
- - 对于 Jira Cloud,请在授权配置的密码处填写 API Token;而对于Jira Server 或 Data Center,则使用您的 Jira 账户登录密码即可。
7148
-
7149
- ## 在 Jira Cloud 中获取 API Token (Jira Server 和 Data Center 请跳过)
7150
-
7151
- - 登录 Jira Cloud 后,点击右上角头像,选择 **管理账户**。
7152
- - 在 **管理账户** 页面中,选择 **安全性** 选项卡。
7153
- - 在 **安全性** 页面中,点击 **创建并管理 API 令牌** 按钮。
7154
- - 在 **创建并管理 API 令牌** 弹窗中,填写 API token 名称,并选择过期时间。
7155
- - 点击 **创建** 按钮,创建 API token。
7156
- - 创建完成后,复制 API token 值,并粘贴到 Flashduty 授权配置中的 API 令牌处。
7157
-
7158
- ## 在 Flashduty 中配置集成
7159
-
7160
- ### 1. 创建并认证 Jira 集成
7161
- <div class="hide">
7162
-
7163
- 在集成中心,选择 **Webhook** ,选择 **Jira 同步** 集成,并填写以下认证信息。
7164
-
7165
- </div>
7166
-
7167
- - **Jira 平台类型**:根据您使用的版本进行选择,如果是 Data Center 版本的请选择私有化(Server) 即可。
7168
- - **服务地址**:Cloud 版本请填写您的实际访问地址,例如: https://your-domain.atlassian.net,Server 版本请填写您的服务访问地址,例如: https://your-jira-server-url.com。
7169
- - **用户名**:您的 Jira 账户名,Cloud 版本请填写您的邮箱,Server 版本请填写您的 Jira 账户名。
7170
- - **API令牌/密码**:您的 Jira 账户密码,Cloud 版本请填写 API Token,Server 版本请填写您的 Jira 账户密码。
7171
- - 填写完成后,点击 **下一步** 按钮,进行相关配置。
7172
-
7173
- **关于权限**:请确保您的 Jira 账户拥有获取相关项目、事务类型以及创建 Issue 等权限,建议使用管理员账户。
7174
-
7175
- ### 2. Jira 集成配置
7176
-
7177
- - **集成名称**:为当前集成定义一个名称。
7178
- - **触发模式**:
7179
- - 自动触发:需要配置相应的条件,Flashduty 会自动将符合条件的故障同步到 Jira 中。
7180
- - 手动触发:需要在故障详情页的更多操作中手动触发 Jira 同步(该集成配置的名称为触发器名称)。
7181
- - **项目 ID**:选择需要同步至 Jira 的项目。
7182
- - **事务类型**:选择需要同步至 Jira 的事务类型。
7183
- - **协作空间**:选择该集成生效的协作空间,只有该协作空间内的故障才可以同步至 Jira 中。
7184
- - **严重程度映射**:如果选择的事务类型不支持优先级字段,则无法配置该映射关系。
7185
- - **自定义字段映射**:可以选择将故障的某些标签或所有标签以及自定义字段内容同步至 Jira 的字段中(仅支持文本类型的字段)。
7186
-
7187
- ### 3. 关于更新
7188
-
7189
- - 已经创建 Issue 的故障,如果您更新了故障的严重程度、状态,Jira 中会自动更新,但 Jira 中的更新不会同步到 Flashduty 中。
7190
- - 评论信息会同步到 Jira 中,但 Jira 中更新的内容不会同步到 Flashduty 中。
7191
- - 更新故障中的标题、描述、标签等字段的信息,Jira 中不会更新。
7192
-
7193
-
7194
- ### 4. Flashduty 与 Jira 的映射关系
7195
-
7196
- #### 字段映射
7197
-
7198
- | Jira | Flashduty |
7199
- | ---------- | -------- |
7200
- | 摘要 | 标题 |
7201
- | 描述 | 描述 |
7202
- | 优先级 | 严重程度 |
7203
- | 报告人 | 集成配置的用户 |
7204
- | 评论 | 评论 |
7205
-
7206
-
7207
- #### 状态映射
7208
-
7209
- | Jira | Flashduty |
7210
- | ---------- | -------- |
7211
- | Todo | 待处理 |
7212
- | In Progress | 处理中 |
7213
- | Done | 已解决 |
7214
-
7215
-
7216
- ### 5. 注意事项
7217
-
7218
- - Flashduty 会按照默认的字段映射以及您配置的自定义字段映射进行同步信息,如果您的 Jira 事务类型中有必选的字段且没有配置映射关系,则会遇到创建 Jira Issue 失败的情况。
7219
- - Jira 的 Issue 详情是基于项目 KEY + 编号的格式进行访问的,如果您修改了项目 KEY,可能无法通过 Flashduty 中保存的 Issue 地址进行访问,请谨慎修改项目 KEY。
7220
7079
  `};n.FlashDocsZh=t})(window);
package/dist/zh.d.ts CHANGED
@@ -53,6 +53,5 @@ declare const docs: {
53
53
  CustomAction: string;
54
54
  Templates: string;
55
55
  HuaweiyunAPM: string;
56
- JiraSync: string;
57
56
  };
58
57
  export default docs;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "flashduty-knowledge-base",
3
- "version": "1.2.4-beta.2",
3
+ "version": "1.2.4-beta.3",
4
4
  "description": "flashduty knowledge base",
5
5
  "type": "module",
6
6
  "scripts": {