flashduty-knowledge-base 1.3.0 → 1.3.2

package/dist/iife/zh.js

@@ -3445,7 +3445,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/aws-eventbridge-integration-guide
 ### 步骤1：在 API destinations 中创建 Connerction
 1. 登录您的 AWS 控制台，检索 \`Amazon Eventbridge\` 产品，并进入对应产品控制台。
 2. 在左侧导航栏选择 \`Integration=>API destinations\`。
-3. 点击 \`Connerctions\`，并点击 \`Create connerction\` 创建链接。
+3. 点击 \`connection\`，并点击 \`Create connection\` 创建链接。
 
 <img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/aws-eb-3.png" />
 
@@ -5905,7 +5905,7 @@ acknowledged_at | int64| 否 | 认领时间
 |      fields       |  map[string]interface{}  |  否  | 自定义字段 KV，Key 为字符串，Value 可能为任意类型，取决于字段类型|
 |      creator      |  [Person](#Person)  |  否  | 创建人员信息，仅手动创建故障时存在 |
 |       closer      |  [Person](#Person)  |  否  | 关闭人员信息，仅手动关闭故障时存在 |
-|    responders     | [][Responder](#Responder) |  否  | 处理人员信息列表 |
+|    responders     | [][Responder](#Responder) |  否  | 处理人员信息列表，仅故障被分派后存在。对于i_new事件，此值可能为空 |
 |     alert_cnt     |        int64        |  否  | 关联告警个数 |
 |     channel_id     |        int64        |  否  | 协作空间ID，为0代表不属于任何空间 |
 |     channel_name   |        string        |  否  | 协作空间名称 |
@@ -8049,6 +8049,93 @@ url: "https://docs.flashcat.cloud/zh/flashduty/feishu-alert-integration-guide"
 
 当前飞书告警集成推送到 Flashduty 的严重程度均为 Warning。
 
+`,VolcEngineDetect:`---
+title: "火山引擎云拨测告警事件"
+description: "通过 webhook 的方式同步 火山引擎云拨测的告警事件到 Flashduty，实现告警事件自动化降噪处理"
+date: "2024-07-05T10:00:00+08:00"
+url: "https://docs.flashcat.cloud/zh/flashduty/volcengine-detect-integration-guide"
+---
+
+通过 webhook 的方式同步 火山引擎云拨测的告警事件到 Flashduty，实现告警事件自动化降噪处理。
+
+<div class="hide">
+
+## 在 Flashduty
+---
+您可通过以下2种方式，获取一个集成推送地址，任选其一即可。
+
+### 使用专属集成
+
+当您不需要将告警事件路由到不同的协作空间，优先选择此方式，更简单。
+
+<details>
+  <summary>展开</summary>
+  
+  1. 进入 Flashduty 控制台，选择 **协作空间**，进入某个空间的详情页面
+  2. 选择 **集成数据** tab，点击 **添加一个集成**，进入添加集成页面
+  3. 选择 **火山引擎云拨测** 集成，点击 **保存**，生成卡片。
+  4. 点击生成的卡片，可以查看到 **推送地址**，复制备用，完成。
+
+    
+</details>
+
+### 使用共享集成
+
+当您需要根据告警事件的 Payload 信息，将告警路由到不同的协作空间，优先选择此方式。
+
+<details>
+  <summary>展开</summary>
+  
+  1. 进入 Flashduty 控制台，选择 **集成中心=>告警事件**，进入集成选择页面。
+  2. 选择 **火山引擎云拨测** 集成： 
+        - **集成名称**：为当前集成定义一个名称。
+  3. 配置默认路由，并选择对应的协作空间（集成创建后可以前往 \`路由\` 进行更多路由规则的配置）。
+  4. 点击 **保存** 后，复制当前页面的新生成的 **推送地址** 备用。
+  5. 完成。
+    
+</details>
+</div>
+
+## 在 火山引擎
+---
+
+<div class="md-block">
+
+## 一、告警推送配置
+
+### 步骤1：创建通知对象
+
+1. 登录您的 \`火山引擎\` 控制台，在 \`告警管理\` 菜单中，找到 \`通知对象管理\`。
+2. 点击 \`系统集成\`，点击\`创建系统集成\`或编辑已有的通知对象。
+3. 在编辑页面中，名称填写 \`Flashduty\` ，\`回调 URL\` 处填写告警集成的<span class='integration_url'>推送地址</span>。
+4. 点击 \`确定\` 完成配置。
+
+<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/zh/fd/volcengine-1.png" />
+
+### 步骤2：在告警策略中使用通知对象
+
+1. 登录您的 \`火山引擎\` 控制台，在 \`告警管理\` 菜单中，找到 \`告警策略\`。
+2. 点击\`创建告警策略\`或编辑已有的报警器。
+3. 在编辑页面中，\`通知对象\` 处选择创建的 \`Flashduty\` 通知对象。
+4. 其他按需配置即可，点击 \`确定\` 完成配置。
+
+<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/zh/fd/volcengine-2.png" />
+
+
+
+</dev>
+
+## 二、状态对照
+
+<div class="md-block">
+
+| 火山引擎 |  Flashduty | 状态 |
+| ---------- | -------- | ---- |
+| 严重告警  | Critical | 严重 |
+| 普通告警   | Warning  | 警告 |
+
+</div>
+
 `,Link:`---
 title: "Link 集成"
 description: "通过 Link 集成，可直接从故障属性、标签等信息中获取访问外部链接所需的关键参数，实现快速访问"
@@ -8106,4 +8193,324 @@ https://cmdb.com/vm?sn=VM123456
 1. 当引用的内容不存在时，Link 集成会正常生成对应的链接，但无法获取到值
 2. 同一个协作空间至多绑定三个 Link 集成
 3. 注意引用语法，如未按照要求进行书写引用变量，会导致无法正常获取对应值
-`};n.FlashDocsZh=t})(window);
+`,ServiceNowSync:`---
+title: "ServiceNow 同步"
+description: "通过 ServiceNow 同步 Webhook，实现故障与 ServiceNow Incident 的关联。"
+date: "2025-05-19T10:00:00+08:00"
+url: "https://docs.flashcat.cloud/zh/flashduty/service-now-sync"
+---
+
+通过 ServiceNow 同步 Webhook，将 Flashduty 的故障与 ServiceNow Incident 进行关联同步，实现 Flashduty 与 ServiceNow 的联动。
+
+## 在 ServiceNow
+
+### 创建用户
+
+1. 登录 ServiceNow 实例控制台，通过选择 \`ALL\` ，输入 \`USERS\` 选择\`Organization\`-\`Users\` 。
+2. 点击 \`New\` 新建用户。
+3. 在编辑页面中，\`User ID\` 输入：flashduty 。
+4. \`Password needs reset\` 和 \`Web service access only\` 以及 \`Internal Integration User\` 保持取消勾选状态。
+5. 提交保存。
+
+<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/snow/snow-1.png" />
+
+### 配置用户
+
+用于访问 ServiceNow 的用户需要是管理员角色。
+
+1. 在用户列表页面，找到新创建的 \`flashduty\` 用户并进到配置页面。
+2. 在编辑页面中，点击 \`Set Password\` 设置一个密码。
+3. 点击 \`Roles\` 添加 **admin 和 itil** 角色。
+4. 点击 \`Update\` 更新配置。
+
+<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/snow/snow-2.png" />
+
+## 在 Flashduty
+
+### 配置集成
+
+将以上配置的用户名/密码以及实例名称输入到左侧集成信息中并点击下一步进行配置。
+
+- **集成名称：** 为当前集成定义一个名称。
+- **管理团队：** 当选择管理团队后，只有该团队成员以及租户管理员可以编辑此集成。
+- **协作空间**：选择该集成生效的协作空间，。
+- **同步方向：**
+  - To_ServiceNow：将 Flashduty 的故障同步至 ServiceNow。
+  - From_ServiceNow：将 ServiceNow 的 Incident 同步至 Flashduty。
+  - Two-way：Flashduty 和 ServiceNow 互相同步。
+- **触发模式**：
+  - 自动触发：需要配置相应的条件，Flashduty 会自动将符合条件的故障同步到 ServiceNow 中。
+  - 手动触发：需要在故障详情页的更多操作中手动触发 ServiceNow 同步（该集成配置的名称为触发器名称）。
+- **严重程度映射**：ServiceNow 的 Priority 是由 Impact 和 Urgency 的值共同决定的，所以可以参考 ServiceNow 的 \`Priority Lookup Rules\` 进行配置。另外需要注意的是，只有当 ServiceNow Incident 的 Urgency 发生变化时，才会触发 Flashduty 故障严重程度的更新。
+- **自定义字段映射**：可以选择将故障的某些标签或所有标签以及自定义字段内容同步至 ServiceNow 的字段中（仅支持文本类型的字段）。
+
+## 在 ServiceNow
+
+当同步方向选择 From_ServiceNow 或 Two-way 时，还需要在 ServiceNow 中做相应的配置，以便将 ServiceNow Incident 同步至 Flashduty， 在同步至 Flashduty 时，有以下两种方式，可根据实际需求选择即可。
+
+### 手动同步
+
+该方式依赖 ServiceNow 提供的 UI Action 和 Script Include 的配置，根据以下步骤配置完成的效果：当新建 Incident 或更新 Incident 时，可以在功能区看到发送同步请求的按钮，触发该按钮，可以将当前 Incident 的内容同步至 Flashduty。需要注意的是，如果触发请求时遇到失败的情况，请重试（重试时间间隔需大于 10 秒）。
+
+#### 配置 UI Action
+
+1. 登录 ServiceNow 实例控制台，通过选择 \`ALL\` ，输入 \`UI Actions\` 选择\`System Definition\`-\`UI Actions\` 。
+2. 点击 \`New\` 新建 Action。
+3. \`Name\` 输入： **Send To Flashduty**， \`Table\` 选择 **Incident** 。
+4. \`Form button\` ，\`Active\` ，\`Show insert\` ，\`Show update\` ，\`Client\`， \`List v2/3 Compatible\` 保持勾选状态。
+5. \`Onclick\` 输入：**onClick();**。
+6. \`Script\` 输入：
+
+   \`\`\`js
+   function onClick() {
+     g_form.save();
+
+     var ga = new GlideAjax("IncidentWebhookHelperAjax");
+     ga.addParam("sysparm_name", "sendWebhook");
+     ga.addParam("sysparm_sys_id", g_form.getUniqueValue());
+
+     ga.getXMLAnswer(function (response) {
+       alert("Webhook Triggered: " + response);
+     });
+   }
+   \`\`\`
+
+7. 提交保存。
+
+#### 配置 Script Include
+
+1. 登录 ServiceNow 实例控制台，通过选择 \`ALL\` ，输入 \`Script Includes\` 选择\`System Definition\`-\`Script Includes\` 。
+2. 点击 \`New\` 新建 Script Include。
+3. \`Name\` 输入：**IncidentWebhookHelper** ， \`Accessible from\` 选择 **All application scopes**。
+4. \`Client callable\` 和 \`Active\` 保持勾选状态。
+5. \`Script\` 输入以下内容，其中 **request.setEndpoint** 中需要补充集成的推送地址：
+
+<div class="hide">
+
+注意： body 中配置的是默认接收字段，如果有自定义字段需要同步至 Flashduty ，需要额外手动补充内容到 body 中，比如希望添加一个字段名为：test_001 的字段（该字段名可以在配置集成中添加自定义字段的时候获取，不要使用 ServiceNow Inident 表单中显示的字段名），那么需要在 body 中补充：test_001: current.getDisplayValue("test_001")。
+
+</div>
+
+\`\`\`js
+var IncidentWebhookHelper = Class.create();
+IncidentWebhookHelper.prototype = {
+  initialize: function() {},
+
+  sendIncidentWebhook: function(current) {
+      function getLastComment(sysId) {
+          var journalGR = new GlideRecord('sys_journal_field');
+          journalGR.addQuery('element_id', sysId);
+          journalGR.addQuery('element', 'comments');
+          journalGR.orderByDesc('sys_created_on');
+          journalGR.setLimit(1);
+          journalGR.query();
+          if (journalGR.next()) {
+              return journalGR.getValue('value');
+          }
+          return '';
+      }
+
+      var body = {
+          action_type: current.isNewRecord() ? 'insert' : 'update',
+          number: current.getValue("number"),
+          sys_id: current.getUniqueValue(),
+          short_description: current.getValue("short_description"),
+          description: current.getValue("description"),
+          impact: current.getDisplayValue("impact"),
+          urgency: current.getDisplayValue("urgency"),
+          comments: getLastComment(current.getUniqueValue()),
+<label name='field_mapping' tab='10'>{original.key}: current.getDisplayValue("{original.key}")</label>
+      };
+
+      try {
+          var request = new sn_ws.RESTMessageV2();
+          request.setHttpMethod("POST");
+          request.setEndpoint("PUSH URL");
+          request.setRequestHeader("Content-Type", "application/json");
+          request.setRequestBody(JSON.stringify(body));
+          request.executeAsync();
+          } catch (ex) {
+          gs.error("Webhook Call failed: " + ex.message);
+      }
+  },
+  type: 'IncidentWebhookHelper'
+};
+
+\`\`\`
+
+6. 提交保存。
+7. 回到 Script Includes 列表，继续创建。
+8. 点击 \`New\` 新建 Script Include。
+9. \`Name\` 输入：**IncidentWebhookHelperAjax** ， \`Accessible from\` 选择 **All application scopes**。
+10. \`Client callable\` 和 \`Active\` 保持勾选状态。
+11. \`Script\` 输入以下内容：
+
+    \`\`\`js
+    var IncidentWebhookHelperAjax = Class.create();
+    IncidentWebhookHelperAjax.prototype = Object.extendsObject(
+      global.AbstractAjaxProcessor,
+      {
+        sendWebhook: function () {
+          var sysId = this.getParameter("sysparm_sys_id");
+          var gr = new GlideRecord("incident");
+          if (gr.get(sysId)) {
+            var helper = new IncidentWebhookHelper();
+            helper.sendIncidentWebhook(gr);
+            return "Success";
+          }
+          return "Request failed";
+        },
+      }
+    );
+    \`\`\`
+
+12. 提交保存。
+
+### 自动同步
+
+该方式依赖 ServiceNow 提供的 Business Rules 的配置，使用该方式可以实现当有新建或更新事件时，自动将 Incident 同步至 Flashduty。
+
+#### 配置 Business Rules
+
+1. 登录 ServiceNow 实例控制台，通过选择 \`ALL\` ，输入 \`Business Rules\` 选择\`System Definition\`-\`Business Rules\` 。
+2. 点击 \`New\` 新建 Business Rule。
+3. \`Name\` 输入：**Send To Flashduty** ， \`Table\` 选择 **Incident**。
+4. \`Advanced\` 和 \`Active\` 保持勾选状态。
+5. 在 \`When to run\` 区域中，\`When\` 选择 **async**，\`Insert\` 和 \`Upsert\` 保持勾选状态，其他按需配置。
+6. 在 \`Advanced\` 区域中，\`Script\` 填写以下内容，其中 **endpoint** 中需要补充集成的推送地址：
+
+<div class="hide">
+
+注意： body 中配置的是默认接收字段，如果有自定义字段需要同步至 Flashduty ，需要额外手动补充内容到 body 中，比如希望添加一个字段名为：test_001 的字段（该字段名可以在配置集成中添加自定义字段的时候获取，不要使用 ServiceNow Inident 表单中显示的字段名），那么需要在 body 中补充：test_001: current.getDisplayValue("test_001")。
+
+</div>
+
+\`\`\`js
+(function executeRule(current, previous) {
+  function getLastComment(recordSysId) {
+    var journalGR = new GlideRecord("sys_journal_field");
+    journalGR.addQuery("element_id", recordSysId);
+    journalGR.addQuery("element", "comments");
+    journalGR.orderByDesc("sys_created_on");
+    journalGR.setLimit(1);
+    journalGR.query();
+    if (journalGR.next()) {
+      var comment = journalGR.getValue("value");
+      return comment;
+    }
+    return "";
+  }
+
+  var operation = current.operation() || "unknown";
+  var isPreviousNull = previous === null;
+  var createdOn = current.getValue("sys_created_on");
+  var updatedOn = current.getValue("sys_updated_on");
+  var isNewRecord = createdOn === updatedOn;
+
+  var action = "update";
+  if (isPreviousNull && isNewRecord) {
+    action = "insert";
+  }
+
+  var body = {
+    action_type: action,
+    number: current.getValue("number"),
+    sys_id: current.getUniqueValue(),
+    short_description: current.getValue("short_description"),
+    description: current.getValue("description"),
+    state: current.getDisplayValue("state"),
+    impact: current.getDisplayValue("impact"),
+    urgency: current.getDisplayValue("urgency"),
+    comments: getLastComment(current.getUniqueValue()),
+<label name='field_mapping' tab='4'>{original.key}: current.getDisplayValue("{original.key}")</label>
+
+  };
+
+  try {
+    var endpoint = "";
+    var request = new sn_ws.RESTMessageV2();
+    request.setHttpMethod("POST");
+    request.setEndpoint(endpoint);
+    request.setRequestHeader("Content-Type", "application/json");
+    request.setRequestBody(JSON.stringify(body));
+    request.executeAsync();
+  } catch (ex) {
+    gs.error("Error sending webhook: " + ex.message);
+  }
+})(current, previous);
+\`\`\`
+
+7. 提交保存。
+
+## 同步信息
+
+### 表单字段
+
+| ServiceNow          | Flashduty     | 备注 |
+| ------------------- | ------------- | ---- |
+| Short_description   | Title         |      |
+| Description         | Description   |      |
+| Additional comments | Comments      |      |
+| State               | Progress      |      |
+| Urgency             | Severity      |      |
+| Others              | Custom Fields |      |
+
+### 状态映射
+
+| ServiceNow  | Flashduty  | 备注            |
+| ----------- | ---------- | --------------- |
+| New         | Trigger    |                 |
+| In Progress | Processing |                 |
+| On Hold     | Snoozed    | 默认暂缓 2 小时 |
+| Resolved    | CLosed     |                 |
+| Closed      | CLosed     |                 |
+| Canceled    | CLosed     |                 |
+
+### 优先级映射
+
+只有 ServiceNow 的 Urgency 值变化时，才会影响 Flashduty 的 Severity
+
+| ServiceNow | Flashduty | 备注 |
+| ---------- | --------- | ---- |
+| Low        | Info      |      |
+| Medium     | Warning   |      |
+| High       | Critical  |      |
+`,Monit:`---
+title: "Monit 告警集成"
+description: "Flashduty Monit 告警集成，Monit 服务通过此集成上报告警"
+date: "2025-05-19T10:00:00+08:00"
+url: "https://docs.flashcat.cloud/zh/flashduty/monit-alert-integration-guide"
+---
+
+当您开通 Monit 服务时，系统会自动为您创建此集成。此集成用于收集 Monit 服务产生的告警事件。
+
+:::tips
+您无法修改或删除此集成。但您可以管理集成下的标签增强、告警处理以及路由等规则。
+:::
+
+## 如何开启 Monit 告警
+
+前往\`Monit\`-\`告警规则\`-\`规则详情\`页面，配置监控指标和阈值等条件，并开启告警。您可以选择将告警投递至多个协作空间。告警的通知规则遵循协作空间下的分派策略，您可以为团队设定值班人员，在告警发生时分派给值班人。
+
+![2025-08-19-20-35-45](https://docs-cdn.flashcat.cloud/images/png/59c9d2566db9a0482fb2eabb729ea739.png)
+
+某些情况下，您可能希望将同一个告警规则产生的告警，按条件路由到不同的协作空间，这个时候您可以选择将告警直接投递到集成，而非协作空间列表。并在当前集成下，设置路由规则。`,Rum:`---
+title: "RUM 告警集成"
+description: "Flashduty RUM 告警集成，RUM 服务通过此集成上报告警"
+date: "2025-05-19T10:00:00+08:00"
+url: "https://docs.flashcat.cloud/zh/flashduty/rum-alert-integration-guide"
+---
+
+当您开通 RUM 服务时，系统会自动为您创建此集成。此集成用于收集 RUM 服务产生的告警事件。
+
+:::tips
+您无法修改或删除此集成。但您可以管理集成下的标签增强、告警处理以及路由等规则。
+:::
+
+## 如何开启 RUM 告警
+
+前往\`RUM\`-\`应用详情\`-\`告警设置\`页面，开启告警。您可以选择将告警投递至多个协作空间。告警的通知规则遵循协作空间下的分派策略，您可以为团队设定值班人员，在告警发生时分派给值班人。
+
+![2025-05-20-10-53-57](https://docs-cdn.flashcat.cloud/images/png/2bbd455a2ac702246e8399b6628f9158.png)
+
+更多内容，请您参考 [RUM Issue 告警](https://docs.flashcat.cloud/zh/flashduty/rum/issue-alerting)。`};n.FlashDocsZh=t})(window);

package/dist/zh.d.ts

@@ -60,6 +60,10 @@ declare const docs: {
     ElastAlert2: string;
     DingtalkAlert: string;
     FeishuAlert: string;
+    VolcEngineDetect: string;
     Link: string;
+    ServiceNowSync: string;
+    Monit: string;
+    Rum: string;
 };
 export default docs;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flashduty-knowledge-base",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "flashduty knowledge base",
   "type": "module",
   "engines": {