flashduty-knowledge-base 1.0.2 → 1.0.4

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.
Files changed (5) hide show
  1. package/dist/en.cjs +189 -17
  2. package/dist/en.js +203 -29
  3. package/dist/zh.cjs +200 -17
  4. package/dist/zh.js +214 -29
  5. package/package.json +1 -1
package/dist/en.js CHANGED
@@ -605,7 +605,7 @@ Prometheus to Flashduty severity mapping:
605
605
 
606
606
 
607
607
 
608
- `, i = `---
608
+ `, o = `---
609
609
  title: "Grafana Integration"
610
610
  description: "Sync Grafana alert events to Flashduty via webhook to achieve automated alert noise reduction."
611
611
  date: "2024-05-11T10:00:00+08:00"
@@ -718,7 +718,7 @@ The system extracts the \`severity\`, \`priority\`, and \`level\` labels from al
718
718
  | ok | Ok | Resolved |
719
719
 
720
720
  </div>
721
- `, o = `---
721
+ `, i = `---
722
722
  title: "Zabbix Integration"
723
723
  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"
724
724
  date: "2024-05-11T10:00:00+08:00"
@@ -3491,7 +3491,7 @@ Choose this option when you need to route alerts to different channels based on
3491
3491
  |No severity|Info|Info|
3492
3492
 
3493
3493
  </div>
3494
- `, T = `---
3494
+ `, R = `---
3495
3495
  title: "Splunk Alert Events"
3496
3496
  description: "Sync Splunk alert events to Flashduty via webhook for automated alert noise reduction"
3497
3497
  date: "2024-08-20T10:00:00+08:00"
@@ -3566,7 +3566,7 @@ Choose this method when you need to route alerts to different channels based on
3566
3566
  <div class="md-block">
3567
3567
  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.
3568
3568
  </div>
3569
- `, R = `---
3569
+ `, T = `---
3570
3570
  title: "AppDynamics Alert Integration"
3571
3571
  description: "Sync AppDynamics alerts to Flashduty via webhook for automated alert noise reduction"
3572
3572
  date: "2024-07-05T10:00:00+08:00"
@@ -4349,6 +4349,178 @@ Choose this option when you need to route alerts to different channels based on
4349
4349
 
4350
4350
  </div>
4351
4351
  `, W = `---
4352
+ title: "StateCloud Alert Events"
4353
+ description: "Sync StateCloud alert events to Flashduty via webhook for automated alert noise reduction"
4354
+ date: "2024-07-05T10:00:00+08:00"
4355
+ url: "https://docs.flashcat.cloud/en/flashduty/statecloud-integration-guide"
4356
+ ---
4357
+
4358
+ Sync StateCloud monitoring alert events to Flashduty via webhook for automated alert noise reduction.
4359
+
4360
+ For resource monitoring events from StateCloud [secondary nodes](#secondary-nodes), please use Huawei Cloud integration. Refer to [Huawei Cloud Alert Integration Guide](https://docs.flashcat.cloud/en/flashduty/huawei-ces-integration-guide?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5).
4361
+
4362
+
4363
+ <div class="hide">
4364
+
4365
+ ## In Flashduty
4366
+ ---
4367
+ You can obtain an integration push URL through either of these two methods:
4368
+
4369
+ ### Using Dedicated Integration
4370
+
4371
+ Choose this simpler option when you don't need to route alert events to different channels.
4372
+
4373
+ <details>
4374
+ <summary>Expand</summary>
4375
+
4376
+ 1. Go to the Flashduty console, select **Channel**, and enter a channel's details page
4377
+ 2. Select the **Integration** tab, click **Add Integration** to enter the integration page
4378
+ 3. Select **StateCloud** integration and click **Save** to generate a card
4379
+ 4. Click the generated card to view the **push URL**, copy it for later use, and you're done
4380
+
4381
+ </details>
4382
+
4383
+ ### Using Shared Integration
4384
+
4385
+ Choose this option when you need to route alerts to different channels based on the alert event's payload information.
4386
+
4387
+ <details>
4388
+ <summary>Expand</summary>
4389
+
4390
+ 1. Go to the Flashduty console, select **Integration Center=>Alert Events** to enter the integration selection page
4391
+ 2. Select **StateCloud** integration:
4392
+ - **Integration Name**: Define a name for this integration
4393
+ 3. Click **Save** and copy the newly generated **push URL** for later use
4394
+ 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
4395
+ 5. Done
4396
+
4397
+ </details>
4398
+ </div>
4399
+
4400
+ ## In StateCloud
4401
+ ---
4402
+
4403
+ <div class="md-block">
4404
+
4405
+ ## I. StateCloud Alert Push Configuration
4406
+
4407
+ 1. Log in to your \`StateCloud\` console, search for the \`Cloud Eye\` product, and enter its console
4408
+ 2. In \`Alarm Service\`, select \`Alarm Contact/Group\` and create corresponding alert contact/group
4409
+ 3. In \`Alarm Rules\`, choose to create or modify Alarm rule
4410
+ 4. In the alarm rule editing page, fill in the integration <span class='integration_url' >push URL</span> under \`Alert Callback\` and click test
4411
+ 5. After successful testing, click \`Save\`
4412
+
4413
+ <img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/en/fd/state-1.png" />
4414
+
4415
+ </dev>
4416
+
4417
+ ## II. Status Mapping
4418
+
4419
+ <div class="md-block">
4420
+
4421
+ | StateCloud | Flashduty | Status |
4422
+ | ---------- | --------- | ------ |
4423
+ | Urgent | Critical | critical |
4424
+ | Warning | Warning | warning |
4425
+ | Normal | Info | info |
4426
+
4427
+ ## III. StateCloud Secondary Node List<span id="secondary-nodes"></span>
4428
+
4429
+ | Region | Cities |
4430
+ | ---------- | -------- |
4431
+ | East China | Hangzhou/Nanchang/Shanghai4/Suzhou/Wuhu |
4432
+ | South China | Changsha2/Fuzhou1/Guangzhou4/Haikou/Nanning/Wuhan2 |
4433
+ | Northwest | Lanzhou/Urumqi/Xi'an2/Xining/Zhongwei |
4434
+ | Southwest | Chengdu3/Chongqing/Guizhou1/Kunming |
4435
+ | North | Beijing2/Changchun/Harbin/North China/Inner Mongolia3/Qingdao/Shenyang3/Shijiazhuang/Taiyuan/Tianjin/Zhengzhou |
4436
+
4437
+ </div>
4438
+ `, G = `---
4439
+ title: "Guance Alert Events"
4440
+ description: "Sync Guance alert events to Flashduty via webhook for automated alert noise reduction"
4441
+ date: "2024-07-05T10:00:00+08:00"
4442
+ url: "https://docs.flashcat.cloud/en/flashduty/statecloud-integration-guide"
4443
+ ---
4444
+
4445
+ Sync Guance monitoring alert events to Flashduty via webhook for automated alert noise reduction.
4446
+
4447
+ <div class="hide">
4448
+
4449
+ ## In Flashduty
4450
+ ---
4451
+ You can obtain an integration push URL through either of these two methods:
4452
+
4453
+ ### Using Dedicated Integration
4454
+
4455
+ Choose this simpler option when you don't need to route alert events to different channels.
4456
+
4457
+ <details>
4458
+ <summary>Expand</summary>
4459
+
4460
+ 1. Go to the Flashduty console, select **Channel**, and enter a specific channel's details page
4461
+ 2. Select the **Integrations** tab, click **Add Integration** to enter the integration page
4462
+ 3. Select **Guance** integration and click **Save** to generate a card
4463
+ 4. Click the generated card to view the **push URL**, copy it for later use, and you're done
4464
+
4465
+ </details>
4466
+
4467
+ ### Using Shared Integration
4468
+
4469
+ Choose this option when you need to route alerts to different channels based on the alert event's payload information.
4470
+
4471
+ <details>
4472
+ <summary>Expand</summary>
4473
+
4474
+ 1. Go to the Flashduty console, select **Integration Center=>Alert Events** to enter the integration selection page
4475
+ 2. Select **Guance** integration:
4476
+ - **Integration Name**: Define a name for this integration
4477
+ 3. Click **Save** and copy the newly generated **push URL** for later use
4478
+ 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
4479
+ 5. Done
4480
+
4481
+ </details>
4482
+ </div>
4483
+
4484
+ ## In Guance
4485
+ ---
4486
+
4487
+ <div class="md-block">
4488
+
4489
+ ## I. Alert Push Configuration
4490
+
4491
+ ### Step 1: Create Notification Object
4492
+ 1. Log in to your \`Guance\` console, select \`Notification Targets\` under \`Monitoring\`
4493
+ 2. Click \`Create\` and select \`Webhook\`
4494
+ 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
4495
+ 4. Configure other options as needed and click \`Confirm\` to complete
4496
+
4497
+ <img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/en/fd/guance-1.png" />
4498
+
4499
+ ### Step 2: Create Alert Strategies
4500
+
4501
+ 1. Log in to your \`Guance\` console, select \`Alert Strategies\` under \`Monitoring\`
4502
+ 2. Create new or modify existing alert policies on the \`Alert Strategies\` page
4503
+ 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\`
4504
+ 4. Configure other options as needed and click \`Save\` to complete
4505
+
4506
+ <img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/en/fd/guance-2.png" />
4507
+
4508
+ </dev>
4509
+
4510
+ ## II. Status Mapping
4511
+
4512
+ <div class="md-block">
4513
+
4514
+ | Guance | Flashduty | Status |
4515
+ | ---------- | -------- | ---- |
4516
+ | Critical | Critical | Critical |
4517
+ | Error | Warning | Warning |
4518
+ | Warning | Warning | Warning |
4519
+ | Info | Info | Info |
4520
+ | Data Missing | Info | Info |
4521
+
4522
+ </div>
4523
+ `, Y = `---
4352
4524
  title: "Custom Change Event Integration Guide"
4353
4525
  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."
4354
4526
  date: "2024-05-11T10:00:00+08:00"
@@ -4405,7 +4577,7 @@ Labels are descriptions of events. You should enrich label content as much as po
4405
4577
 
4406
4578
  </details>
4407
4579
 
4408
- `, G = `---
4580
+ `, q = `---
4409
4581
  title: "Jira Issue Events"
4410
4582
  description: "Sync Jira Issue events to Flashduty via webhooks to collect change events."
4411
4583
  date: "2024-05-11T10:00:00+08:00"
@@ -4479,7 +4651,7 @@ Flashduty extracts the status.name information from the webhook payload by defau
4479
4651
  Please contact Flashduty if you wish to modify this mapping.
4480
4652
 
4481
4653
  </div>
4482
- `, Y = `---
4654
+ `, O = `---
4483
4655
  title: Contributing to our documentation — Meilisearch documentation
4484
4656
  description: The Meilisearch documentation is open-source. Learn how to help make it even better.
4485
4657
  sidebarDepth: 3
@@ -4614,7 +4786,7 @@ Once published, you can access the application via mobile/PC client. First-time
4614
4786
  |Group Bot Webhook|Maximum 100 calls/minute|
4615
4787
  |Sending messages to the same user or group|Maximum 5 calls/second|
4616
4788
 
4617
- **Note:** Messages cannot be pushed normally when exceeding limits, please use notification channels reasonably`, q = `---
4789
+ **Note:** Messages cannot be pushed normally when exceeding limits, please use notification channels reasonably`, $ = `---
4618
4790
  title: "Dingtalk Integration"
4619
4791
  description: "Integrate with Dingtalk custom application to receive and respond to alerts within Dingtalk"
4620
4792
  date: "2024-05-11T10:00:00+08:00"
@@ -4770,7 +4942,7 @@ After the application is released, you can access it via mobile/PC client. First
4770
4942
  |Enterprise|5,500,000|60|1st of each month|
4771
4943
 
4772
4944
  **Note:** Messages cannot be pushed normally after exceeding limits, please use notification channels reasonably
4773
- `, O = `---
4945
+ `, j = `---
4774
4946
  title: "WeCom Integration"
4775
4947
  description: "Integrate WeCom third-party application to receive and respond to alerts within WeCom"
4776
4948
  date: "2024-05-11T10:00:00+08:00"
@@ -4849,7 +5021,7 @@ Integrate WeCom third-party application to receive and respond to alerts within
4849
5021
  7. **Incident notification fails with \`WeCom License Not Activated\`?**
4850
5022
 
4851
5023
  - Contact Flashduty customer service or dedicated support for license purchase and activation
4852
- `, $ = `---
5024
+ `, H = `---
4853
5025
  title: "Slack Integration"
4854
5026
  description: "Integrate with Slack to receive and respond to alerts within Slack"
4855
5027
  date: "2024-05-11T10:00:00+08:00"
@@ -4903,7 +5075,7 @@ Integrate with Slack to receive and respond to alerts within Slack.
4903
5075
 
4904
5076
  8. **Slack App shows Other questions error**
4905
5077
  - Try again, as this might be an unrecorded issue
4906
- - If the error persists, contact customer support`, j = `---
5078
+ - If the error persists, contact customer support`, B = `---
4907
5079
  title: "Microsoft Teams Integration"
4908
5080
  description: "Integrate Microsoft Teams as a third-party application to receive and respond to alerts within Microsoft Teams"
4909
5081
  date: "2024-05-11T10:00:00+08:00"
@@ -4998,7 +5170,7 @@ Please check in Integration Center => Instant Messaging => Microsoft Teams under
4998
5170
  Currently not supported
4999
5171
  </details>
5000
5172
 
5001
- `, 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.
5173
+ `, 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.
5002
5174
 
5003
5175
  <span id="EventTypes"></span>
5004
5176
 
@@ -5166,7 +5338,7 @@ curl -X POST 'https://example.com/alert/webhook?a=a' \\
5166
5338
  4. **Trusted IP whitelist for push sources?**
5167
5339
  - {ip_whitelist}
5168
5340
  - May be updated in the future, please check periodically
5169
- `, 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.
5341
+ `, 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.
5170
5342
 
5171
5343
  <span id="EventTypes"></span>
5172
5344
 
@@ -5372,7 +5544,7 @@ curl -X POST 'https://example.com/incident/webhook?a=a' \\
5372
5544
 
5373
5545
  4. **Trusted IP whitelist for push sources?**
5374
5546
  - {ip_whitelist}
5375
- - 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.
5547
+ - 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.
5376
5548
 
5377
5549
  ## I. Creating Actions
5378
5550
 
@@ -5619,7 +5791,7 @@ When an incident occurs and is confirmed to be caused by a change, directly trig
5619
5791
 
5620
5792
  ### Update Status Page
5621
5793
 
5622
- When an incident is confirmed to affect online services, trigger external status page updates to prompt`, z = `---
5794
+ When an incident is confirmed to affect online services, trigger external status page updates to prompt`, J = `---
5623
5795
  title: "Configure Notification Templates"
5624
5796
  description: "Customize notification content through template configuration"
5625
5797
  date: "2024-05-10T10:00:00+08:00"
@@ -6226,32 +6398,33 @@ As shown below:
6226
6398
  export {
6227
6399
  c as AWSCW,
6228
6400
  A as AWSEventBridge,
6229
- H as AlertWebhook,
6401
+ V as AlertWebhook,
6230
6402
  r as AliyunARMS,
6231
6403
  d as AliyunCm,
6232
6404
  l as AliyunCmEvent,
6233
6405
  c as AliyunSLS,
6234
- R as AppDynamics,
6406
+ T as AppDynamics,
6235
6407
  h as AzureMonitor,
6236
6408
  u as BaiDuBCM,
6237
- V as CustomAction,
6409
+ K as CustomAction,
6238
6410
  e as CustomAlert,
6239
- W as CustomChange,
6240
- q as Dingtalk,
6411
+ Y as CustomChange,
6412
+ $ as Dingtalk,
6241
6413
  L as Dynatrace,
6242
6414
  n as Email,
6243
6415
  F as GoogleCM,
6244
- i as Grafana,
6416
+ o as Grafana,
6245
6417
  k as Graylog,
6418
+ G as Guance,
6246
6419
  g as HuaWeiCES,
6247
6420
  x as HuaweiyunLTS,
6248
- B as IncidentWebhook,
6421
+ z as IncidentWebhook,
6249
6422
  p as InfluxDB,
6250
6423
  _ as Jiankongbao,
6251
- G as Jira,
6252
- Y as Lark,
6424
+ q as Jira,
6425
+ O as Lark,
6253
6426
  M as Meraki,
6254
- j as MicrosoftTeams,
6427
+ B as MicrosoftTeams,
6255
6428
  t as N9e,
6256
6429
  C as OceanBase,
6257
6430
  N as OpManager,
@@ -6260,10 +6433,11 @@ export {
6260
6433
  a as Prometheus,
6261
6434
  S as Sentry,
6262
6435
  I as Skywalking,
6263
- $ as Slack,
6436
+ H as Slack,
6264
6437
  U as SolarWinds,
6265
- T as Splunk,
6266
- z as Templates,
6438
+ R as Splunk,
6439
+ W as StateCloud,
6440
+ J as Templates,
6267
6441
  y as TencentBK,
6268
6442
  v as TencentCLS,
6269
6443
  b as TencentCm,
@@ -6272,6 +6446,6 @@ export {
6272
6446
  D as VolcEngineEvent,
6273
6447
  E as VolcEngineMetric,
6274
6448
  P as VolcEngineTLS,
6275
- O as Wecom,
6276
- o as Zabbix
6449
+ j as Wecom,
6450
+ i as Zabbix
6277
6451
  };