flashduty-knowledge-base 1.0.1 → 1.0.3

package/dist/en.js

@@ -51,42 +51,120 @@ Choose this method when you need to route alerts to different channels based on
 </details>
 </div>
 
-## Implementation Protocol
---- 
+## I. Request Description
 
-Please refer to the [Developer Documentation](https://developer.flashcat.cloud/zh/flashduty/event-api/alert-event) to complete the protocol development.
+### Request Method
 
-## Best Practices
----
+POST, Content-Type:"application/json"
 
-1. Send events to Flashduty when alert status changes
-2. When an alert recovers, send an event with status "Ok" to close the alert. Otherwise, the alert will remain open. If your alert system doesn't have recovery events, we recommend manually sending recovery events
-3. Labels are event descriptions. You should enrich label content as much as possible (specified when sending or generated through enrichment rules), such as:
-   - Alert source, like host, cluster, check, or metric
-   - Alert ownership information, like team, owner
-   - Alert category information, like class (api, db, net)
+### Request Parameters:
 
+QueryString must include the integration_key parameter for access control.
 
-## FAQ
----
+JsonBody parameters are as follows:
 
-<details>
-  <summary>Why haven't I received alerts in Flashduty?</summary>
+|     Field     | Required |  Type  | Description                                                                                                                                                                                                                                    |
+| :----------: | :------: | :----: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| event_status |   Yes    | string | Alert event status, enumerated values: Critical, Warning, Info, Ok                                                                                                                                                                               |
+|  alert_key   |   Yes    | string | Event grouping basis, different alert events are grouped into one alert based on this field and time window                                                                                                                                      |
+|  title_rule  |    No    | string | Alert title generation rule, in the form of \`$a::b::$c\`, substrings are separated by \`::\`; each substring can be a fixed string or a variable prefixed with \`$\`. Variable content will be extracted from the labels parameter, error if not found. By default, the system will generate rules by extracting service, cluster, resource, and check tags from the labels field |
+| description  |    No    | string | Alert description, no more than 2048 characters                                                                                                                                                                                                  |
+|    labels    |    No    |  map   | Alert label collection, key is the label name, value is the label value. Labels are event descriptions, crucial for subsequent correlation and noise reduction. 1. Label keys and values are case-sensitive strings. 2. Label keys should not exceed 128 characters. 3. Maximum 50 labels allowed. \`Label content reference\` [Best Practices](#Best-Practices) |
 
-  #### In Flashduty
-  
-  1. Check if the integration shows **Latest Event Time**? If not, Flashduty hasn't received the push, prioritize checking your system
-  2. If you're using **Shared Integration**, first confirm whether you've configured **Routing Rules**. Without routing rules, the system will reject new pushes since there's no channel to receive your alerts. In this case, simply configure routing rules to your desired channel
-
-  #### In Your System
+</div>
 
-  1. Confirm that your request URL exactly matches the URL in the integration details
-  2. Verify that your service can access the external domain api.flashcat.cloud. If not, you need to enable external network access for your server or specifically for the Flashduty domain
-  3. Print the response from the Flashduty service to check for specific messages
+### Response
 
-  If you still can't identify the root cause after these steps, please contact us with the **request_id** from the request response
+<div class="md-block">
+    
+Body:
     
-</details>`, n = `---
+Parameter|Required|Type|Description
+----------|---|---|---
+request_id|Yes|string|Request trace id for issue tracking
+error|No|[Error](#Error)|Error description, returned only when an error occurs
+
+<span id="Error"></span>
+Error:
+
+| Parameter | Optional | Type   | Description     |
+| --------- | -------- | ------ | --------------- |
+| code      | Yes      | string | Error code      |
+| message   | Yes      | string | Error message   |
+
+<span id="Code"></span>
+Code:
+
+| Error Code           | HTTP Status | Description                                        |
+| -------------------- | ----------- | -------------------------------------------------- |
+| InvalidParameter     | 400         | Parameter error                                    |
+| InvalidContentType   | 400         | Content-Type not supported                         |
+| MethodNotAllowed     | 400         | HTTP method not supported                          |
+| Unauthorized         | 401         | Login authentication failed                        |
+| AccessDenied         | 403         | Permission authentication failed                   |
+| RequestTooFrequently | 429         | Request too frequent                               |
+| RouteNotFound        | 404         | Request Method+Path not matched                    |
+| ResourceNotFound     | 400         | Account resource not purchased, proceed to billing |
+| InternalError        | 500         | Internal or unknown error                          |
+
+</div>
+
+### Request Example
+
+Request:
+
+\`\`\`
+curl -X POST '{api_host}/event/push/alert/standard?integration_key=$key' \\
+-H 'Content-Type: application/json' \\
+-d '{
+    "event_status": "Warning",
+    "alert_key": "asdfjl1234asdf2s",
+    "description": "cpu idle low than 20%",
+    "title_rule": "$cluster::$resource::$check",
+    "labels": {
+        "service": "engine",
+        "cluster":"nj",
+        "resource":"es.nj.01",
+        "check":"cpu.idle<20%",
+        "metric":"node_cpu_seconds_total"
+    }
+}' -v
+\`\`\`
+
+Successful response:
+
+\`\`\`
+{
+    "request_id": "0ace00116215ab4ca0ec5244b8fc54b0"
+}
+\`\`\`
+
+Failed response:
+
+\`\`\`
+{
+    "request_id": "0ace00116215abc0ba4e52449bd305b0",
+    "error": {
+        "code": "InvalidParameter",
+        "message": "integration_key is not a valid one"
+    }
+}
+\`\`\`
+
+<span id="Best-Practices"></span>
+
+## II. Best Practices
+
+1. Send events to Flashcat Cloud when alert status changes or labels are updated
+2. When an alert recovers, send an event with status Ok to close the alert. Otherwise, the alert will remain open. If your alert system doesn't have recovery events, we recommend manually sending recovery events
+3. Labels are event descriptions. You should enrich label content as much as possible (specified when sending or generated through enrichment rules), such as:
+   - Alert source information: host, cluster, check, or metric
+   - Alert ownership information: team, owner
+   - Alert category information: class (api, db, net)
+   - Alert details link for jumping to the alert system
+4. alert_key is used to group different alert events into one alert. For example, when a host's cpu.idle drops below threshold, escalates, and recovers, you should send 3 events with the same alert_key, which will be grouped into one alert
+5. title_rule is used to generate alert display titles. It's recommended to include the source system alert name (commonly defined as rule_name or check) and add cluster, host, and other information as auxiliary reminders
+`, n = `---
 title: "Email Integration"
 description: "Generate a unique email address in Flashduty to synchronize alert triggers and recoveries through email"
 date: "2024-05-11T10:00:00+08:00"
@@ -527,7 +605,7 @@ Prometheus to Flashduty severity mapping:
 
 
 
-`, i = `---
+`, o = `---
 title: "Grafana Integration"
 description: "Sync Grafana alert events to Flashduty via webhook to achieve automated alert noise reduction."
 date: "2024-05-11T10:00:00+08:00"
@@ -640,7 +718,7 @@ The system extracts the \`severity\`, \`priority\`, and \`level\` labels from al
 | ok               | Ok       | Resolved |
 
 </div>
-`, o = `---
+`, i = `---
 title: "Zabbix Integration"
 description: "Synchronize Zabbix alert events to Flashduty via webhook (supports Zabbix 3.x ~ 6.x versions, with different configuration requirements) to achieve automated alert noise reduction"
 date: "2024-05-11T10:00:00+08:00"
@@ -689,14 +767,9 @@ Choose this method when you need to route alerts to different channels based on
 ## In Zabbix 
 ---
 
-<<<<<<< HEAD
-
 - [7.x version](#v7)
 - [5.x~6.x version](#v5)
 - [3.x~4.x version](#v4)
-=======
-<div class="md-block">
->>>>>>> 798fffa6edf238347e9cac531eac2314fae21c18
 
 <span id="v7"></span>
 
@@ -3418,7 +3491,7 @@ Choose this option when you need to route alerts to different channels based on
 |No severity|Info|Info|
 
 </div>
-`, T = `---
+`, R = `---
 title: "Splunk Alert Events"
 description: "Sync Splunk alert events to Flashduty via webhook for automated alert noise reduction"
 date: "2024-08-20T10:00:00+08:00"
@@ -3493,7 +3566,7 @@ Choose this method when you need to route alerts to different channels based on
 <div class="md-block">
 Since Splunk alert events don't differentiate severity levels, all alert events pushed from Splunk to Flashduty will have a Warning status and won't include recovery events.
 </div>
-`, R = `---
+`, T = `---
 title: "AppDynamics Alert Integration"
 description: "Sync AppDynamics alerts to Flashduty via webhook for automated alert noise reduction"
 date: "2024-07-05T10:00:00+08:00"
@@ -4069,7 +4142,7 @@ Choose this method when you need to route alerts to different channels based on
 </div>
 
 </div>
-`, M = `---
+`, N = `---
 title: "OpManager Alert Events"
 description: "Sync OpManager alert events to Flashduty via webhook for automated alert noise reduction"
 date: "2024-07-05T10:00:00+08:00"
@@ -4203,7 +4276,7 @@ Choose this method when you need to route alerts to different channels based on
 | Attention  | Info           | Info |
 
 </div>
-`, N = `---
+`, M = `---
 title: "Meraki Alert Events"
 description: "Sync Meraki alert events to Flashduty via webhook for automated alert noise reduction"
 date: "2024-07-05T10:00:00+08:00"
@@ -4276,6 +4349,165 @@ Choose this option when you need to route alerts to different channels based on
 
 </div>
 `, W = `---
+title: "StateCloud Alert Events"
+description: "Sync StateCloud 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/statecloud-integration-guide"
+---
+
+Sync StateCloud monitoring 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 Dedicated Integration
+
+Choose this simpler option when you don't need to route alert events to different channels.
+
+<details>
+  <summary>Expand</summary>
+  
+  1. Go to the Flashduty console, select **Channel**, and enter a channel's details page
+  2. Select the **Integration** tab, click **Add Integration** to enter the integration page
+  3. Select **StateCloud** 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 option when you need to route alerts to different channels based on the alert event's payload information.
+
+<details>
+  <summary>Expand</summary>
+  
+  1. Go to the Flashduty console, select **Integration Center=>Alert Events** to enter the integration selection page
+  2. Select **StateCloud** integration:
+        - **Integration Name**: Define a name for this integration
+  3. Click **Save** and copy the newly generated **push URL** for later use
+  4. Click **Create Route** to configure routing rules for the integration. You can match different alerts to different channels based on conditions, or set a default channel as a fallback and adjust as needed later
+  5. Done
+    
+</details>
+</div>
+
+## In StateCloud
+---
+
+<div class="md-block">
+
+## I. StateCloud Alert Push Configuration
+
+1. Log in to your \`StateCloud\` console, search for the \`Cloud Eye\` product, and enter its console
+2. In \`Alarm Service\`, select \`Alarm Contact/Group\` and create corresponding alert contact/group
+3. In \`Alarm Rules\`, choose to create or modify Alarm rule
+4. In the alarm rule editing page, fill in the integration <span class='integration_url' >push URL</span> under \`Alert Callback\` and click test
+5. After successful testing, click \`Save\`
+
+<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/zh/statecloud/state-1.png" />
+
+</dev>
+
+## II. Status Mapping
+
+<div class="md-block">
+
+| StateCloud | Flashduty | Status |
+| ---------- | --------- | ------ |
+| Urgent     | Critical  | critical |
+| Warning    | Warning   | warning |
+| Normal     | Info      | info |
+
+</div>
+`, G = `---
+title: "Guance Alert Events"
+description: "Sync Guance 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/statecloud-integration-guide"
+---
+
+Sync Guance monitoring 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 Dedicated Integration
+
+Choose this simpler option when you don't need to route alert events to different channels.
+
+<details>
+  <summary>Expand</summary>
+  
+  1. Go to the Flashduty console, select **Channel**, and enter a specific channel's details page
+  2. Select the **Integrations** tab, click **Add Integration** to enter the integration page
+  3. Select **Guance** 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 option when you need to route alerts to different channels based on the alert event's payload information.
+
+<details>
+  <summary>Expand</summary>
+  
+  1. Go to the Flashduty console, select **Integration Center=>Alert Events** to enter the integration selection page
+  2. Select **Guance** integration:
+        - **Integration Name**: Define a name for this integration
+  3. Click **Save** and copy the newly generated **push URL** for later use
+  4. Click **Create Route** to configure routing rules for the integration. You can match different alerts to different channels based on conditions, or set a default channel as a fallback and adjust as needed later
+  5. Done
+    
+</details>
+</div>
+
+## In Guance
+---
+
+<div class="md-block">
+
+## I. Alert Push Configuration
+
+### Step 1: Create Notification Object
+1. Log in to your \`Guance\` console, select \`Notification Targets\` under \`Monitoring\`
+2. Click \`Create\` and select \`Webhook\`
+3. Fill in the name as \`Flashduty\` and enter the alert integration's <span class='integration_url'>push URL</span> in the \`Webhook URL\` field
+4. Configure other options as needed and click \`Confirm\` to complete
+
+<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/en/fd/guance-1.png" />
+
+### Step 2: Create Alert Strategies
+
+1. Log in to your \`Guance\` console, select \`Alert Strategies\` under \`Monitoring\`
+2. Create new or modify existing alert policies on the \`Alert Strategies\` page
+3. In the notification configuration section of the alert strategies editing page, select \`severity\` and choose \`FlashDuty\` created in Step 1 as the \`Notification Tragets\`
+4. Configure other options as needed and click \`Save\` to complete
+
+<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/zh/en/guance-2.png" />
+
+</dev>
+
+## II. Status Mapping
+
+<div class="md-block">
+
+| Guance | Flashduty | Status |
+| ---------- | -------- | ---- |
+| Emergency | Critical | Critical |
+| Important | Warning | Warning |
+| Warning | Warning | Warning |
+| Info | Info | Info |
+| Data Gap | Info | Info |
+
+</div>
+`, Y = `---
 title: "Custom Change Event Integration Guide"
 description: "Push change events from your own systems to Flashduty using standard protocols. Most incidents are caused by changes, and the correlation between changes and alerts helps quickly identify incident causes."
 date: "2024-05-11T10:00:00+08:00"
@@ -4332,7 +4564,7 @@ Labels are descriptions of events. You should enrich label content as much as po
     
 </details>
 
-`, G = `---
+`, q = `---
 title: "Jira Issue Events"
 description: "Sync Jira Issue events to Flashduty via webhooks to collect change events."
 date: "2024-05-11T10:00:00+08:00"
@@ -4406,7 +4638,7 @@ Flashduty extracts the status.name information from the webhook payload by defau
 Please contact Flashduty if you wish to modify this mapping.
 
 </div>
-`, Y = `---
+`, O = `---
 title: Contributing to our documentation — Meilisearch documentation
 description: The Meilisearch documentation is open-source. Learn how to help make it even better.
 sidebarDepth: 3
@@ -4541,7 +4773,7 @@ Once published, you can access the application via mobile/PC client. First-time
     |Group Bot Webhook|Maximum 100 calls/minute|
     |Sending messages to the same user or group|Maximum 5 calls/second|
 
-    **Note:** Messages cannot be pushed normally when exceeding limits, please use notification channels reasonably`, O = `---
+    **Note:** Messages cannot be pushed normally when exceeding limits, please use notification channels reasonably`, $ = `---
 title: "Dingtalk Integration"
 description: "Integrate with Dingtalk custom application to receive and respond to alerts within Dingtalk"
 date: "2024-05-11T10:00:00+08:00"
@@ -4697,7 +4929,7 @@ After the application is released, you can access it via mobile/PC client. First
 |Enterprise|5,500,000|60|1st of each month|
 
 **Note:** Messages cannot be pushed normally after exceeding limits, please use notification channels reasonably
-`, q = `---
+`, j = `---
 title: "WeCom Integration"
 description: "Integrate WeCom third-party application to receive and respond to alerts within WeCom"
 date: "2024-05-11T10:00:00+08:00"
@@ -4776,7 +5008,7 @@ Integrate WeCom third-party application to receive and respond to alerts within
 7. **Incident notification fails with \`WeCom License Not Activated\`?**
 
    - Contact Flashduty customer service or dedicated support for license purchase and activation
-`, $ = `---
+`, H = `---
 title: "Slack Integration"
 description: "Integrate with Slack to receive and respond to alerts within Slack"
 date: "2024-05-11T10:00:00+08:00"
@@ -4830,7 +5062,7 @@ Integrate with Slack to receive and respond to alerts within Slack.
 
 8. **Slack App shows Other questions error**
    - Try again, as this might be an unrecorded issue
-   - If the error persists, contact customer support`, j = `---
+   - If the error persists, contact customer support`, B = `---
 title: "Microsoft Teams Integration"
 description: "Integrate Microsoft Teams as a third-party application to receive and respond to alerts within Microsoft Teams"
 date: "2024-05-11T10:00:00+08:00"
@@ -4925,7 +5157,7 @@ Please check in Integration Center => Instant Messaging => Microsoft Teams under
 Currently not supported
 </details>
 
-`, H = `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.
+`, V = `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.
 
 <span id="EventTypes"></span>
 
@@ -5093,7 +5325,7 @@ curl -X POST 'https://example.com/alert/webhook?a=a' \\
 4. **Trusted IP whitelist for push sources?**
    - {ip_whitelist}
    - May be updated in the future, please check periodically
-`, B = `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.
+`, 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.
 
 <span id="EventTypes"></span>
 
@@ -5299,7 +5531,7 @@ curl -X POST 'https://example.com/incident/webhook?a=a' \\
 
 4. **Trusted IP whitelist for push sources?**
    - {ip_whitelist}
-   - May be updated in the future, please check periodically`, V = `Custom incident actions allow you to quickly invoke external interfaces during incident troubleshooting for incident self-healing, information enrichment, and other custom operations.
+   - May be updated in the future, please check periodically`, K = `Custom incident actions allow you to quickly invoke external interfaces during incident troubleshooting for incident self-healing, information enrichment, and other custom operations.
 
 ## I. Creating Actions
 
@@ -5546,7 +5778,7 @@ When an incident occurs and is confirmed to be caused by a change, directly trig
 
 ### Update Status Page
 
-When an incident is confirmed to affect online services, trigger external status page updates to prompt`, z = `---
+When an incident is confirmed to affect online services, trigger external status page updates to prompt`, J = `---
 title: "Configure Notification Templates"
 description: "Customize notification content through template configuration"
 date: "2024-05-10T10:00:00+08:00"
@@ -6153,44 +6385,46 @@ As shown below:
 export {
   c as AWSCW,
   A as AWSEventBridge,
-  H as AlertWebhook,
+  V as AlertWebhook,
   r as AliyunARMS,
   d as AliyunCm,
   l as AliyunCmEvent,
   c as AliyunSLS,
-  R as AppDynamics,
+  T as AppDynamics,
   h as AzureMonitor,
   u as BaiDuBCM,
-  V as CustomAction,
+  K as CustomAction,
   e as CustomAlert,
-  W as CustomChange,
-  O as Dingtalk,
+  Y as CustomChange,
+  $ as Dingtalk,
   L as Dynatrace,
   n as Email,
   F as GoogleCM,
-  i as Grafana,
+  o as Grafana,
   k as Graylog,
+  G as Guance,
   g as HuaWeiCES,
   x as HuaweiyunLTS,
-  B as IncidentWebhook,
+  z as IncidentWebhook,
   p as InfluxDB,
   _ as Jiankongbao,
-  G as Jira,
-  Y as Lark,
-  N as Meraki,
-  j as MicrosoftTeams,
+  q as Jira,
+  O as Lark,
+  M as Meraki,
+  B as MicrosoftTeams,
   t as N9e,
   C as OceanBase,
-  M as OpManager,
+  N as OpManager,
   m as OpenFalcon,
   f as PagerDuty,
   a as Prometheus,
   S as Sentry,
   I as Skywalking,
-  $ as Slack,
+  H as Slack,
   U as SolarWinds,
-  T as Splunk,
-  z as Templates,
+  R as Splunk,
+  W as StateCloud,
+  J as Templates,
   y as TencentBK,
   v as TencentCLS,
   b as TencentCm,
@@ -6199,6 +6433,6 @@ export {
   D as VolcEngineEvent,
   E as VolcEngineMetric,
   P as VolcEngineTLS,
-  q as Wecom,
-  o as Zabbix
+  j as Wecom,
+  i as Zabbix
 };