flashduty-knowledge-base 1.3.0 → 1.3.2

package/dist/iife/en.js

@@ -1370,7 +1370,7 @@ Alibaba Cloud Monitor event alert to Flashduty severity level mapping:
 | WARNING              | Warning   | Warning |
 | INFO                 | Info      | Info |
 
-</div>`,h=`---
+</div>`,u=`---
 title: "Alibaba Cloud Monitor CM Metrics Integration"
 description: "Sync Alibaba Cloud Monitor alert events to Flashduty via webhook for automated alert noise reduction"
 date: "2025-05-19T10:00:00+08:00"
@@ -1595,7 +1595,7 @@ Alibaba Cloud SLS monitoring to Flashduty alert severity mapping:
 | 2                | Info      | Info |
 
 </div>
-`,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:`---
+`,h={CustomAlert:t,Email:a,N9e:i,Prometheus:o,Grafana:s,Zabbix:r,UptimeKuma:l,AliyunARMS:d,AliyunCmEvent:c,AliyunCm:u,AliyunSLS:e,AWSCW:e,AzureMonitor:`---
 title: "AWS CloudWatch Integration"
 description: "Sync AWS CloudWatch alert events to Flashduty via webhook to achieve automated alert noise reduction"
 date: "2025-05-19T10:00:00+08:00"
@@ -5631,7 +5631,7 @@ acknowledged_at | int64| No | Acknowledgment time
 |      fields       |  map[string]interface{}  |  No   | Custom field key-value pairs, Key is string, Value can be any type depending on field type |
 |      creator      |  [Person](#Person)  |  No   | Creator information, exists only for manually created incidents |
 |       closer      |  [Person](#Person)  |  No   | Closer information, exists only for manually closed incidents |
-|    responders     | [][Responder](#Responder) |  No   | List of responder information |
+|    responders     | [][Responder](#Responder) |  No   | List of responder information, only exists after the incident is assigned. For i_new events, this value may be empty |
 |     alert_cnt     |        int64        |  No   | Number of associated alerts |
 |     channel_id     |        int64        |  No   | Channel ID, 0 means not belonging to any channel |
 |     channel_name   |        string        |  No   | Channel name |
@@ -7749,6 +7749,88 @@ By default, the system always creates new alerts for each message, but you can s
 
 Currently, all alerts pushed to Flashduty through Feishu Alert integration are set to Warning severity.
 
+`,VolcEngineDetect:`---
+title: "Volcengine Cloud-Detect Alert Events"
+description: "Sync Volcengine Cloud-Detect alert events to Flashduty via webhook for automated alert noise reduction"
+date: "2024-07-05T10:00:00+08:00"
+url: "https://docs.flashcat.cloud/en/flashduty/volcengine-tls-integration-guide"
+---
+
+Sync Volcengine Cloud-Detect alert events to Flashduty via webhook for automated alert noise reduction.
+
+<div class="hide">
+
+## In Flashduty
+---
+You can obtain an integration push URL through either of these two methods:
+
+### Using Private Integration
+
+Choose this method when you don't need to route alert events to different channels - it's simpler.
+
+<details>
+  <summary>Expand</summary>
+  
+  1. Go to the Flashduty console, select **Channel**, and enter a channel's details page
+  2. Select the **Integrations** tab, click **Add Integration** to enter the integration page
+  3. Choose **Volcengine Detect** integration and click **Save** to generate a card
+  4. Click the generated card to view the **Push URL**, copy it for later use, and you're done
+  
+</details>
+
+### Using Shared Integration
+
+Choose this method when you need to route alerts to different channels based on the alert event payload.
+
+<details>
+  <summary>Expand</summary>
+  
+  1. Go to the Flashduty console, select **Integration Center=>Alert Events** to enter the integration selection page
+  2. Select **Volcengine Detect** integration:
+        - **Integration Name**: Define a name for this integration
+  3. Configure the default route and select the corresponding channel (after the integration is created, you can go to \`Route\` to configure more routing rules)
+  4. Click **Save** and copy the newly generated **push URL** for later use
+  5. Done
+    
+</details>
+</div>
+
+## In Volcengine
+---
+
+<div class="md-block">
+
+## 一、Create Notification Object
+
+### Step 1: Create Notification Object
+1. Login to your \`Volcengine\` console, find \`Alert Manager\` in the \`Notify Object\` menu
+2. Click \`System Integration\`, click \`Create System Integration\` or edit the existing endpoint
+3. 在编辑页面中，名称填写 \`Flashduty\` ，\`回调 URL\` 处填写告警集成的<span class='integration_url'>推送地址</span>。
+5. Click \`OK\` to complete the configuration
+
+<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/zh/fd/volcengine-1.png" />
+
+### Step 2: Use Notification Object in Alert Policy
+1. Login to your \`Volcengine\` console, find \`Alert Manager\` in the \`Alert Policy\` menu
+2. Click \`Create Alert Policy\` or edit the existing alert policy
+3. In the edit page, select the created \`Flashduty\` Endpoint
+4. Configure other settings as needed, and click \`OK\` to complete the configuration
+
+<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/zh/fd/volcengine-2.png" />
+
+</dev>
+
+## 二、Status Mapping
+
+<div class="md-block">
+
+| Detect |  Flashduty | Status |
+| ---------- | -------- | ---- |
+| P0  | Critical | Critical|
+| P2   | Warning  |  Warning|
+
+</div>
+
 `,Link:`---
 title: "Link Integration"
 description: "Through Link integration, you can quickly access external links by obtaining key parameters from incident attributes, labels, and other information"
@@ -7806,4 +7888,328 @@ https://cmdb.com/vm?sn=VM123456
 1. When referenced content does not exist, Link integration will still generate the corresponding link but will not be able to retrieve the value
 2. Each channel can bind up to three Link integrations
 3. Pay attention to reference syntax; improper variable reference formatting will result in failure to retrieve corresponding values
-`};n.FlashDocsEn=u})(window);
+`,ServiceNowSync:`---
+title: "ServiceNow Sync"
+description: "Sync incidents with ServiceNow Incidents through ServiceNow sync webhook."
+date: "2025-05-19T10:00:00+08:00"
+url: "https://docs.flashcat.cloud/en/flashduty/service-now-sync"
+---
+
+Through ServiceNow sync webhook, Flashduty incidents are associated and synchronized with ServiceNow Incidents to achieve integration between Flashduty and ServiceNow.
+
+## In ServiceNow
+
+### Create User
+
+1. Log in to the ServiceNow instance console, select \`ALL\`, enter \`USERS\` and select \`Organization\`-\`Users\`.
+2. Click \`New\` to create a new user.
+3. In the edit page, enter \`flashduty\` in the \`User ID\` field.
+4. Keep \`Password needs reset\`, \`Web service access only\`, and \`Internal Integration User\` unchecked.
+5. Submit and save.
+
+<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/snow/snow-1.png" />
+
+### Configure User
+
+The user used to access ServiceNow needs to have administrator roles.
+
+1. On the user list page, find the newly created \`flashduty\` user and go to the configuration page.
+2. In the edit page, click \`Set Password\` to set a password.
+3. Click \`Roles\` to add **admin and itil** roles.
+4. Click \`Update\` to update the configuration.
+
+<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/snow/snow-2.png" />
+
+## In Flashduty
+
+### Configure Integration
+
+Enter the username/password and instance name configured above into the integration information on the left and click Next to configure.
+
+- **Integration Name:** Define a name for the current integration.
+- **Management Team:** When a management team is selected, only team members and tenant administrators can edit this integration.
+- **Channel:** Select the channel where this integration takes effect.
+- **Sync Direction:**
+  - To_ServiceNow: Sync Flashduty incidents to ServiceNow.
+  - From_ServiceNow: Sync ServiceNow Incidents to Flashduty.
+  - Two-way: Bidirectional sync between Flashduty and ServiceNow.
+- **Trigger Mode**:
+  - Auto Trigger: Requires configuration of corresponding conditions, Flashduty will automatically sync incidents that meet the conditions to ServiceNow.
+  - Manual Trigger: Requires manual triggering of ServiceNow sync in the More Actions section of the incident details page (the integration configuration name is the trigger name).
+- **Severity Mapping:** ServiceNow's Priority is determined by the combined values of Impact and Urgency, so you can refer to ServiceNow's \`Priority Lookup Rules\` for configuration. Additionally, note that only when ServiceNow Incident's Urgency changes will it trigger updates to Flashduty incident severity.
+- **Custom Field Mapping:** You can choose to sync certain labels or all labels of incidents as well as custom field content to ServiceNow fields (only text-type fields are supported).
+
+## In ServiceNow
+
+When sync direction is set to From_ServiceNow or Two-way, additional configuration is required in ServiceNow to sync ServiceNow Incidents to Flashduty. When syncing to Flashduty, there are two methods available, choose based on your actual needs.
+
+### Manual Sync
+
+This method relies on ServiceNow's UI Action and Script Include configuration. The effect achieved by following the steps below: When creating or updating an Incident, you can see a button to send sync requests in the function area. Triggering this button will sync the current Incident content to Flashduty. Note that if the request fails when triggered, please retry (retry interval should be greater than 10 seconds).
+
+#### Configure UI Action
+
+1. Log in to the ServiceNow instance console, select \`ALL\`, enter \`UI Actions\` and select \`System Definition\`-\`UI Actions\`.
+2. Click \`New\` to create a new Action.
+3. Enter **Send To Flashduty** in \`Name\`, select **Incident** in \`Table\`.
+4. Keep \`Form button\`, \`Active\`, \`Show insert\`, \`Show update\`, \`Client\`, \`List v2/3 Compatible\` checked.
+5. Enter **onClick();** in \`Onclick\`.
+6. Enter the following in \`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. Submit and save.
+
+#### Configure Script Include
+
+1. Log in to the ServiceNow instance console, select \`ALL\`, enter \`Script Includes\` and select \`System Definition\`-\`Script Includes\`.
+2. Click \`New\` to create a new Script Include.
+3. Enter **IncidentWebhookHelper** in \`Name\`, select **All application scopes** in \`Accessible from\`.
+4. Keep \`Client callable\` and \`Active\` checked.
+5. Enter the following content in \`Script\`, where you need to add the integration push URL in **request.setEndpoint**:
+
+<div class="hide">
+
+Note: The body configures default receiving fields. If you have custom fields that need to be synced to Flashduty, you need to manually add content to the body. For example, if you want to add a field named: test_001 (this field name can be obtained when adding custom fields in the integration configuration, do not use the field name displayed in the ServiceNow Incident form), then you need to add to the 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"),
+      state: current.getDisplayValue("state"),
+      impact: current.getDisplayValue("impact"),
+      urgency: current.getDisplayValue("urgency"),
+      comments: getLastComment(current.getUniqueValue()),
+<label name='field_mapping' tab='6'>{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. Submit and save.
+7. Return to the Script Includes list and continue creating.
+8. Click \`New\` to create a new Script Include.
+9. Enter **IncidentWebhookHelperAjax** in \`Name\`, select **All application scopes** in \`Accessible from\`.
+10. Keep \`Client callable\` and \`Active\` checked.
+11. Enter the following content in \`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. Submit and save.
+
+### Auto Sync
+
+This method relies on ServiceNow's Business Rules configuration. Using this method, you can automatically sync Incidents to Flashduty when there are new or update events.
+
+#### Configure Business Rules
+
+1. Log in to the ServiceNow instance console, select \`ALL\`, enter \`Business Rules\` and select \`System Definition\`-\`Business Rules\`.
+2. Click \`New\` to create a new Business Rule.
+3. Enter **Send To Flashduty** in \`Name\`, select **Incident** in \`Table\`.
+4. Keep \`Advanced\` and \`Active\` checked.
+5. In the \`When to run\` section, select **async** in \`When\`, keep \`Insert\` and \`Upsert\` checked, configure others as needed.
+6. In the \`Advanced\` section, enter the following content in \`Script\`, where you need to add the integration push URL in **endpoint**:
+
+<div class="hide">
+
+Note: The body configures default receiving fields. If you have custom fields that need to be synced to Flashduty, you need to manually add content to the body. For example, if you want to add a field named: test_001 (this field name can be obtained when adding custom fields in the integration configuration, do not use the field name displayed in the ServiceNow Incident form), then you need to add to the 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. Submit and save.
+
+## Sync Information
+
+### Form Fields
+
+| ServiceNow          | Flashduty     | Notes |
+| ------------------- | ------------- | ----- |
+| Short_description   | Title         |       |
+| Description         | Description   |       |
+| Additional comments | Comments      |       |
+| State               | Progress      |       |
+| Urgency             | Severity      |       |
+| Others              | Custom Fields |       |
+
+### Status Mapping
+
+| ServiceNow  | Flashduty  | Notes                  |
+| ----------- | ---------- | ---------------------- |
+| New         | Trigger    |                        |
+| In Progress | Processing |                        |
+| On Hold     | Snoozed    | Default snooze 2 hours |
+| Resolved    | CLosed     |                        |
+| Closed      | CLosed     |                        |
+| Canceled    | CLosed     |                        |
+
+### Priority Mapping
+
+Only when ServiceNow's Urgency value changes will it affect Flashduty's Severity
+
+| ServiceNow | Flashduty | Notes |
+| ---------- | --------- | ----- |
+| Low        | Info      |       |
+| Medium     | Warning   |       |
+| High       | Critical  |       |
+`,Monit:`---
+title: "Monit Alert Integration"
+description: "Flashduty Monit alert integration, Monit service reports alerts through this integration"
+date: "2025-05-19T10:00:00+08:00"
+url: "https://docs.flashcat.cloud/en/flashduty/monit-alert-integration-guide?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5"
+---
+
+When you enable the Monit service, the system will automatically create this integration for you. This integration is used to collect alert events generated by the Monit service.
+
+:::tips
+You cannot modify or delete this integration. However, you can manage the label enrichment, alert pipeline, and routing rules under the integration.
+:::
+
+## How to Enable Monit Alerts
+
+Go to the \`Monit\` - \`Alert Rules\` - \`Rule Details\` page to configure monitoring metrics and threshold conditions, and enable alerts. You can choose to deliver alerts to multiple channels. Alert notification rules follow the escalation rules under the channel, and you can set responders for the team to assign to responders when alerts occur.
+
+![2025-08-19-20-35-45](https://docs-cdn.flashcat.cloud/images/png/59c9d2566db9a0482fb2eabb729ea739.png)
+
+In some cases, you may want to route alerts generated by the same alert rule to different channels based on conditions. In this case, you can choose to deliver alerts directly to the integration rather than to the channels, and set routing rules under the current integration.
+`,Rum:`---
+title: "RUM Alert Integration"
+description: "Flashduty RUM alert integration, RUM service reports alerts through this integration"
+date: "2025-05-19T10:00:00+08:00"
+url: "https://docs.flashcat.cloud/en/flashduty/rum-alert-integration-guide?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5"
+---
+
+When you enable the RUM service, the system will automatically create this integration for you. This integration is used to collect alert events generated by the RUM service.
+
+:::tips
+You cannot modify or delete this integration. However, you can manage the label enrichment, alert pipeline, and routing rules under the integration.
+:::
+
+## How to Enable RUM Alerts
+
+Go to the \`RUM\` - \`Application Details\` - \`Alert Settings\` page to enable alerts. You can choose to deliver alerts to multiple channels. Alert notification rules follow the escalation rules under the channel, and you can set responders for the team to assign to responders when alerts occur.
+
+![2025-08-20-10-16-14](https://docs-cdn.flashcat.cloud/images/png/b6ad24809a2ee8f0b3c0b38988b46030.png)
+
+For more information, please refer to [RUM Issue Alerting](https://docs.flashcat.cloud/en/flashduty/rum/issue-alerting?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5).
+`};n.FlashDocsEn=h})(window);