flashduty-knowledge-base 1.2.3 → 1.2.4-beta.2
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 +2 -0
- package/dist/esm/en.js +201 -13
- package/dist/esm/zh.js +235 -13
- package/dist/iife/en.js +191 -3
- package/dist/iife/zh.js +223 -1
- package/dist/zh.d.ts +2 -0
- package/package.json +1 -1
package/dist/en.d.ts
CHANGED
package/dist/esm/en.js
CHANGED
|
@@ -3124,7 +3124,7 @@ Choose this option when you need to route alerts to different channels based on
|
|
|
3124
3124
|
|2|Info|Info|
|
|
3125
3125
|
|
|
3126
3126
|
</div>
|
|
3127
|
-
`,
|
|
3127
|
+
`,L=`---
|
|
3128
3128
|
title: "AWS EventBridge Alert Events"
|
|
3129
3129
|
description: "Sync AWS EventBridge alert events to Flashduty via webhook for automated alert noise reduction"
|
|
3130
3130
|
date: "2024-08-20T10: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
|
-
`,
|
|
3229
|
+
`,F=`---
|
|
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
|
+
`,_=`---
|
|
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
|
-
`,
|
|
4054
|
+
`,P=`---
|
|
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
|
-
`,
|
|
4191
|
+
`,N=`---
|
|
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"
|
|
@@ -4640,6 +4640,112 @@ Choose this method when you need to route alerts to different channels based on
|
|
|
4640
4640
|
</div>
|
|
4641
4641
|
|
|
4642
4642
|
`,q=`---
|
|
4643
|
+
title: "Huawei Cloud APM Alerts"
|
|
4644
|
+
description: "Sync Huawei Cloud APM alerts to Flashduty through webhook to achieve automatic alert noise reduction"
|
|
4645
|
+
date: "2024-07-05T10:00:00+08:00"
|
|
4646
|
+
url: "https://docs.flashcat.cloud/en/flashduty/huawei-apm-integration-guide"
|
|
4647
|
+
---
|
|
4648
|
+
|
|
4649
|
+
Sync Huawei Cloud APM alerts to Flashduty through webhook, to achieve automatic noise reduction of alerts.
|
|
4650
|
+
|
|
4651
|
+
<div class="hide">
|
|
4652
|
+
|
|
4653
|
+
## In Flashduty
|
|
4654
|
+
---
|
|
4655
|
+
You can get an integration push URL through the following 2 methods, choose one of them.
|
|
4656
|
+
|
|
4657
|
+
### Use dedicated integration
|
|
4658
|
+
|
|
4659
|
+
When you don't need to route alerts to different channels, choose this method, it's simpler.
|
|
4660
|
+
|
|
4661
|
+
<details>
|
|
4662
|
+
<summary>Expand</summary>
|
|
4663
|
+
|
|
4664
|
+
1. Go to Flashduty console, select **Channels**, enter the details page of a channel
|
|
4665
|
+
2. Select the **Integrations** tab, click **Add Integration** to enter the integration page
|
|
4666
|
+
3. Select **Huawei Cloud APM** integration, click **Save** to generate a card
|
|
4667
|
+
4. Click the generated card to view the **push URL**, copy it for later use. Done.
|
|
4668
|
+
|
|
4669
|
+
</details>
|
|
4670
|
+
|
|
4671
|
+
### Use shared integration
|
|
4672
|
+
|
|
4673
|
+
When you need to route alerts to different channels based on alert payload information, this method is preferred.
|
|
4674
|
+
|
|
4675
|
+
<details>
|
|
4676
|
+
<summary>Expand</summary>
|
|
4677
|
+
|
|
4678
|
+
1. Go to Flashduty console, select **Integration Center=>Alerts** to enter the integration selection page
|
|
4679
|
+
2. Select **Huawei Cloud APM** integration:
|
|
4680
|
+
- **Integration Name**: Define a name for the current integration
|
|
4681
|
+
3. Click **Save** and copy the newly generated **push URL** for later use
|
|
4682
|
+
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
|
|
4683
|
+
5. Done.
|
|
4684
|
+
|
|
4685
|
+
</details>
|
|
4686
|
+
</div>
|
|
4687
|
+
|
|
4688
|
+
## In Huawei Cloud
|
|
4689
|
+
---
|
|
4690
|
+
|
|
4691
|
+
<div class="md-block">
|
|
4692
|
+
|
|
4693
|
+
## I. Huawei Cloud APM Alert Push Configuration
|
|
4694
|
+
|
|
4695
|
+
### Create FlashDuty Alert Channel
|
|
4696
|
+
|
|
4697
|
+
1. Log in to your Huawei Cloud Console, search for \`SMN\` (Simple Message Notification) service and enter its console
|
|
4698
|
+
2. Select \`Topic Management=>Topics\` from the left navigation bar
|
|
4699
|
+
3. Click \`Create Topic\`, enter \`FlashDuty\` as the topic name in the edit page and confirm
|
|
4700
|
+
|
|
4701
|
+
<img src="https://download.flashcat.cloud/flashduty/doc/en/hw/lts-1.png" alt="drawing" width="500"/>
|
|
4702
|
+
|
|
4703
|
+
4. Return to the topic list and click \`Add Subscription\` in the newly created FlashDuty topic
|
|
4704
|
+
|
|
4705
|
+
<img src="https://download.flashcat.cloud/flashduty/doc/en/hw/lts-2.png" alt="drawing" width="500"/>
|
|
4706
|
+
|
|
4707
|
+
5. In the edit page, select \`HTTPS\` as the protocol, enter the **push URL** as the subscription endpoint and confirm
|
|
4708
|
+
|
|
4709
|
+
<img src="https://download.flashcat.cloud/flashduty/doc/en/hw/lts-3.png" alt="drawing" width="500"/>
|
|
4710
|
+
|
|
4711
|
+
6. After adding, check if the subscription status shows **Confirmed** in the subscription list
|
|
4712
|
+
|
|
4713
|
+
<img src="https://download.flashcat.cloud/flashduty/doc/en/hw/lts-4.png" alt="drawing" width="500"/>
|
|
4714
|
+
|
|
4715
|
+
### Configure Application Monitoring Alerts
|
|
4716
|
+
|
|
4717
|
+
#### Step 1: Add Notification Configuration
|
|
4718
|
+
1. Log in to your \`Huawei Cloud APM\` console, under \`Application Monitoring=>Metrics\`, click \`Notification\`
|
|
4719
|
+
2. Select the corresponding region, click \`Add\`, and select the created \`FlashDuty\` topic
|
|
4720
|
+
3. Click \`Confirm\` to complete the configuration
|
|
4721
|
+
|
|
4722
|
+
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/en/hw/hw-apm-1.png" />
|
|
4723
|
+
|
|
4724
|
+
#### Step 2: Create Alert Policy
|
|
4725
|
+
1. Under \`Application Monitoring=>Metrics\`, select your application and click the \`Settings\` button
|
|
4726
|
+
2. Select \`Alarm Policy\`, click \`Add Custom Alarm Policy\` or edit an existing alarm policy
|
|
4727
|
+
3. In the \`Alarm Policy\` edit page, configure alert metrics and conditions according to your business needs
|
|
4728
|
+
4. In \`Notification Content\`, when referencing variables, it's recommended to use K:V format for easier alert parsing, such as host:\${hostInfo}
|
|
4729
|
+
5. In \`Notification Object\`, select the created \`FlashDuty\` notification channel
|
|
4730
|
+
6. Click \`Confirm\` to complete the configuration
|
|
4731
|
+
|
|
4732
|
+
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/en/hw/hw-apm-2.png" />
|
|
4733
|
+
|
|
4734
|
+
**Note:** The current integration configuration only supports application monitoring alerts, and does not fully support front-end monitoring, link tracking, and App monitoring alerts.
|
|
4735
|
+
</div>
|
|
4736
|
+
|
|
4737
|
+
## II. Status Mapping
|
|
4738
|
+
|
|
4739
|
+
<div class="md-block">
|
|
4740
|
+
|
|
4741
|
+
| Huawei Cloud APM | Flashduty | Severity |
|
|
4742
|
+
| ---------- | -------- | ---- |
|
|
4743
|
+
| CRITICAL | Critical | Critical |
|
|
4744
|
+
| COMMON | Info | Info |
|
|
4745
|
+
|
|
4746
|
+
</div>
|
|
4747
|
+
|
|
4748
|
+
`,O=`---
|
|
4643
4749
|
title: "Custom Change Event Integration Guide"
|
|
4644
4750
|
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."
|
|
4645
4751
|
date: "2024-05-11T10:00:00+08:00"
|
|
@@ -4696,7 +4802,7 @@ Labels are descriptions of events. You should enrich label content as much as po
|
|
|
4696
4802
|
|
|
4697
4803
|
</details>
|
|
4698
4804
|
|
|
4699
|
-
`,
|
|
4805
|
+
`,j=`---
|
|
4700
4806
|
title: "Jira Issue Events"
|
|
4701
4807
|
description: "Sync Jira Issue events to Flashduty via webhooks to collect change events."
|
|
4702
4808
|
date: "2024-05-11T10:00:00+08:00"
|
|
@@ -4770,7 +4876,7 @@ Flashduty extracts the status.name information from the webhook payload by defau
|
|
|
4770
4876
|
Please contact Flashduty if you wish to modify this mapping.
|
|
4771
4877
|
|
|
4772
4878
|
</div>
|
|
4773
|
-
|
|
4879
|
+
`,$=`---
|
|
4774
4880
|
title: Contributing to our documentation — Meilisearch documentation
|
|
4775
4881
|
description: The Meilisearch documentation is open-source. Learn how to help make it even better.
|
|
4776
4882
|
sidebarDepth: 3
|
|
@@ -4905,7 +5011,7 @@ Once published, you can access the application via mobile/PC client. First-time
|
|
|
4905
5011
|
|Group Bot Webhook|Maximum 100 calls/minute|
|
|
4906
5012
|
|Sending messages to the same user or group|Maximum 5 calls/second|
|
|
4907
5013
|
|
|
4908
|
-
**Note:** Messages cannot be pushed normally when exceeding limits, please use notification channels reasonably
|
|
5014
|
+
**Note:** Messages cannot be pushed normally when exceeding limits, please use notification channels reasonably`,H=`---
|
|
4909
5015
|
title: "Dingtalk Integration"
|
|
4910
5016
|
description: "Integrate with Dingtalk custom application to receive and respond to alerts within Dingtalk"
|
|
4911
5017
|
date: "2024-05-11T10:00:00+08:00"
|
|
@@ -5061,7 +5167,7 @@ After the application is released, you can access it via mobile/PC client. First
|
|
|
5061
5167
|
|Enterprise|5,500,000|60|1st of each month|
|
|
5062
5168
|
|
|
5063
5169
|
**Note:** Messages cannot be pushed normally after exceeding limits, please use notification channels reasonably
|
|
5064
|
-
`,
|
|
5170
|
+
`,B=`---
|
|
5065
5171
|
title: "WeCom Integration"
|
|
5066
5172
|
description: "Integrate WeCom third-party application to receive and respond to alerts within WeCom"
|
|
5067
5173
|
date: "2024-05-11T10:00:00+08:00"
|
|
@@ -5140,7 +5246,7 @@ Integrate WeCom third-party application to receive and respond to alerts within
|
|
|
5140
5246
|
7. **Incident notification fails with \`WeCom License Not Activated\`?**
|
|
5141
5247
|
|
|
5142
5248
|
- Contact Flashduty customer service or dedicated support for license purchase and activation
|
|
5143
|
-
`,
|
|
5249
|
+
`,z=`---
|
|
5144
5250
|
title: "Slack Integration"
|
|
5145
5251
|
description: "Integrate with Slack to receive and respond to alerts within Slack"
|
|
5146
5252
|
date: "2024-05-11T10:00:00+08:00"
|
|
@@ -5289,7 +5395,7 @@ Please check in Integration Center => Instant Messaging => Microsoft Teams under
|
|
|
5289
5395
|
Currently not supported
|
|
5290
5396
|
</details>
|
|
5291
5397
|
|
|
5292
|
-
`,
|
|
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.
|
|
5293
5399
|
|
|
5294
5400
|
<span id="EventTypes"></span>
|
|
5295
5401
|
|
|
@@ -5910,7 +6016,89 @@ When an incident occurs and is confirmed to be caused by a change, directly trig
|
|
|
5910
6016
|
|
|
5911
6017
|
### Update Status Page
|
|
5912
6018
|
|
|
5913
|
-
When an incident is confirmed to affect online services, trigger external status page updates to prompt`,
|
|
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=`---
|
|
5914
6102
|
title: "Configure Notification Templates"
|
|
5915
6103
|
description: "Customize notification content through template configuration"
|
|
5916
6104
|
date: "2024-05-10T10:00:00+08:00"
|
|
@@ -6513,4 +6701,4 @@ If custom content is not set, the system default template will be used for notif
|
|
|
6513
6701
|
As shown below:
|
|
6514
6702
|
<img src="https://download.flashcat.cloud/flashduty/doc/en/fd/template-mail-1.png" width="800">
|
|
6515
6703
|
|
|
6516
|
-
`,
|
|
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;
|
package/dist/esm/zh.js
CHANGED
|
@@ -4215,7 +4215,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/volcengine-metric-integration-gui
|
|
|
4215
4215
|
|通知|Info|提醒|
|
|
4216
4216
|
|
|
4217
4217
|
</div>
|
|
4218
|
-
|
|
4218
|
+
`,E=`---
|
|
4219
4219
|
title: "火山引擎云监控事件中心告警事件"
|
|
4220
4220
|
description: "通过 webhook 的方式同步火山引擎云监控事件中心告警事件到 Flashduty,实现告警事件自动化降噪处理"
|
|
4221
4221
|
date: "2024-07-05T10:00:00+08:00"
|
|
@@ -4304,7 +4304,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/volcengine-event-integration-guid
|
|
|
4304
4304
|
|通知|Info|提醒|
|
|
4305
4305
|
|
|
4306
4306
|
</div>
|
|
4307
|
-
|
|
4307
|
+
`,$=`---
|
|
4308
4308
|
title: "火山引擎日志服务 TLS 告警事件"
|
|
4309
4309
|
description: "通过 webhook 的方式同步火山引擎日志服务 TLS 告警事件到 Flashduty,实现告警事件自动化降噪处理"
|
|
4310
4310
|
date: "2024-07-05T10: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
|
-
`,
|
|
4444
|
+
`,W=`---
|
|
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
|
-
`,
|
|
4579
|
+
`,R=`---
|
|
4580
4580
|
title: "Meraki 告警事件"
|
|
4581
4581
|
description: "通过 webhook 的方式同步 Meraki 告警事件到 Flashduty,实现告警事件自动化降噪处理"
|
|
4582
4582
|
date: "2024-07-05T10:00:00+08:00"
|
|
@@ -4904,6 +4904,114 @@ url: "https://docs.flashcat.cloud/zh/flashduty/zilliz-integration-guide"
|
|
|
4904
4904
|
</div>
|
|
4905
4905
|
|
|
4906
4906
|
`,H=`---
|
|
4907
|
+
title: "华为云 APM 告警事件"
|
|
4908
|
+
description: "通过 webhook 的方式同步华为云 APM 告警事件到 Flashduty,实现告警事件自动化降噪处理"
|
|
4909
|
+
date: "2024-07-05T10:00:00+08:00"
|
|
4910
|
+
url: "https://docs.flashcat.cloud/zh/flashduty/huawei-apm-integration-guide"
|
|
4911
|
+
---
|
|
4912
|
+
|
|
4913
|
+
通过 webhook 的方式同步华为云 APM 告警事件到 Flashduty,实现告警事件自动化降噪处理。
|
|
4914
|
+
|
|
4915
|
+
<div class="hide">
|
|
4916
|
+
|
|
4917
|
+
## 在 Flashduty
|
|
4918
|
+
---
|
|
4919
|
+
您可通过以下2种方式,获取一个集成推送地址,任选其一即可。
|
|
4920
|
+
|
|
4921
|
+
### 使用专属集成
|
|
4922
|
+
|
|
4923
|
+
当您不需要将告警事件路由到不同的协作空间,优先选择此方式,更简单。
|
|
4924
|
+
|
|
4925
|
+
<details>
|
|
4926
|
+
<summary>展开</summary>
|
|
4927
|
+
|
|
4928
|
+
1. 进入 Flashduty 控制台,选择 **协作空间**,进入某个空间的详情页面
|
|
4929
|
+
2. 选择 **集成数据** tab,点击 **添加一个集成**,进入添加集成页面
|
|
4930
|
+
3. 选择 **华为云 APM** 集成,点击 **保存**,生成卡片。
|
|
4931
|
+
4. 点击生成的卡片,可以查看到 **推送地址**,复制备用,完成。
|
|
4932
|
+
|
|
4933
|
+
|
|
4934
|
+
</details>
|
|
4935
|
+
|
|
4936
|
+
### 使用共享集成
|
|
4937
|
+
|
|
4938
|
+
当您需要根据告警事件的 Payload 信息,将告警路由到不同的协作空间,优先选择此方式。
|
|
4939
|
+
|
|
4940
|
+
<details>
|
|
4941
|
+
<summary>展开</summary>
|
|
4942
|
+
|
|
4943
|
+
1. 进入 Flashduty 控制台,选择 **集成中心=>告警事件**,进入集成选择页面。
|
|
4944
|
+
2. 选择 **华为云 APM** 集成:
|
|
4945
|
+
- **集成名称**:为当前集成定义一个名称。
|
|
4946
|
+
3. 点击 **保存** 后,复制当前页面的新生成的 **推送地址** 备用。
|
|
4947
|
+
4. 点击 **创建路由**,为集成配置路由规则。您可以按条件匹配不同的告警到不同的协作空间,也可以直接设置默认协作空间作为兜底,后续再按需调整。
|
|
4948
|
+
5. 完成。
|
|
4949
|
+
|
|
4950
|
+
</details>
|
|
4951
|
+
</div>
|
|
4952
|
+
|
|
4953
|
+
## 在华为云 APM
|
|
4954
|
+
---
|
|
4955
|
+
|
|
4956
|
+
<div class="md-block">
|
|
4957
|
+
|
|
4958
|
+
|
|
4959
|
+
## 一、华为云 APM 告警推送配置
|
|
4960
|
+
|
|
4961
|
+
### 创建 FlashDuty 告警通道
|
|
4962
|
+
1. 登录您的华为云控制台,检索 \`SMN\` 消息通知服务产品,并进入对应产品控制台。
|
|
4963
|
+
2. 在左侧导航栏选择 \`主题管理=>主题\`。
|
|
4964
|
+
3. 点击 \`创建主题\`,在编辑页面中的主题名称处输入 \`FlashDuty\` 并点击确认。
|
|
4965
|
+
|
|
4966
|
+
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/huawei-lts-1.png" />
|
|
4967
|
+
|
|
4968
|
+
4. 回到主题列表后,在刚创建的 FlashDuty 主题中点击 \`添加订阅\`。
|
|
4969
|
+
|
|
4970
|
+
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/huawei-lts-2.png" />
|
|
4971
|
+
|
|
4972
|
+
5. 在编辑页面中,协议选择 \`HTTPS\`,订阅终端填写 **集成推送地址** 并点击确认。
|
|
4973
|
+
|
|
4974
|
+
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/huawei-lts-3.png" />
|
|
4975
|
+
|
|
4976
|
+
6. 添加完成后,可以在订阅列表中查看已添加的订阅状态是否为 **已确认**。
|
|
4977
|
+
|
|
4978
|
+
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/huawei-lts-4.png" />
|
|
4979
|
+
|
|
4980
|
+
### 配置应用监控告警
|
|
4981
|
+
|
|
4982
|
+
#### 步骤1:添加通知配置
|
|
4983
|
+
1. 登录您的 \`华为云 APM\` 控制台,在 \`应用监控=>指标\` 中,点击 \`通知配置\`。
|
|
4984
|
+
2. 选择对应的区域后,点击 \`新增\`,在主题处选择已创建的 \`FlashDuty\` 主题。
|
|
4985
|
+
3. 点击 \`确认\` 完成配置。
|
|
4986
|
+
|
|
4987
|
+
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/zh/hw/hw-apm-1.png" />
|
|
4988
|
+
|
|
4989
|
+
#### 步骤2:创建告警策略
|
|
4990
|
+
1. 在 \`应用监控=>指标\` 中,选择您的应用并点击 \`设置\` 按钮。
|
|
4991
|
+
2. 选择 \`告警策略\`,点击 \`新增自定义告警策略\` 或编辑已有的告警策略。
|
|
4992
|
+
3. 在 \`告警策略\` 编辑页面中,告警指标、告警条件等请按业务需要进行配置。
|
|
4993
|
+
4. \`告警内容\` 中在引用变量时,建议以K:V的格式进行配置,便于后续告警事件的解析,比如 host:\${hostInfo}。
|
|
4994
|
+
5. \`通知对象\` 中选择已创建的 \`FlashDuty\` 通知渠道。
|
|
4995
|
+
6. 点击 \`确认\` 完成配置。
|
|
4996
|
+
|
|
4997
|
+
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/zh/hw/hw-apm-2.png" />
|
|
4998
|
+
|
|
4999
|
+
**注意:** 当前集成配置仅支持应用监控告警,还未完全兼容前端监控、链路追踪、App监控告警。
|
|
5000
|
+
</div>
|
|
5001
|
+
|
|
5002
|
+
## 二、状态对照
|
|
5003
|
+
|
|
5004
|
+
<div class="md-block">
|
|
5005
|
+
|
|
5006
|
+
| 华为云 APM | Flashduty | 状态 |
|
|
5007
|
+
| ---------- | -------- | ---- |
|
|
5008
|
+
| 严重告警 | Critical | 严重 |
|
|
5009
|
+
| 轻微告警 | Info | 提醒 |
|
|
5010
|
+
|
|
5011
|
+
|
|
5012
|
+
</div>
|
|
5013
|
+
|
|
5014
|
+
`,O=`---
|
|
4907
5015
|
title: "自定义变更事件集成指引"
|
|
4908
5016
|
description: "通过标准协议推送自有系统变更事件到 Flashduty,大部分故障由变更导致,变更和告警事件联动有助于快速定位故障原因。"
|
|
4909
5017
|
date: "2024-05-11T10:00:00+08:00"
|
|
@@ -4960,7 +5068,7 @@ Flashduty 已经适配部分常用工单、部署系统的 webhook 协议,对
|
|
|
4960
5068
|
|
|
4961
5069
|
</details>
|
|
4962
5070
|
|
|
4963
|
-
`,
|
|
5071
|
+
`,q=`---
|
|
4964
5072
|
title: "Jira 事件集成指引"
|
|
4965
5073
|
description: "通过 webhook 的方式同步 Jira Issue 事件到 Flashduty,实现变更事件收集。"
|
|
4966
5074
|
date: "2024-05-11T10:00:00+08:00"
|
|
@@ -5034,7 +5142,7 @@ Flashduty 默认提取 webhook payload 中 status.name 信息,并按照下边
|
|
|
5034
5142
|
如您希望变更此映射关系,请联系 Flashduty。
|
|
5035
5143
|
|
|
5036
5144
|
</div>
|
|
5037
|
-
`,
|
|
5145
|
+
`,B=`---
|
|
5038
5146
|
title: Contributing to our documentation — Meilisearch documentation
|
|
5039
5147
|
description: The Meilisearch documentation is open-source. Learn how to help make it even better.
|
|
5040
5148
|
sidebarDepth: 3
|
|
@@ -5144,14 +5252,34 @@ sidebarDepth: 3
|
|
|
5144
5252
|
- 确保账户已经完成关联,前往 飞书 > 工作台 > 搜索应用名称 > 打开应用,完成一次登录并关联(飞书< - >Flashduty)账号。如果已经登录过,尝试点击右上角菜单,切换账户,重新登录来绑定账号
|
|
5145
5253
|
- 确保已购买足够的 license,已使用 license 情况,可以在控制台 > 费用中心查看
|
|
5146
5254
|
|
|
5147
|
-
|
|
5255
|
+
3. **分派策略飞书群聊列表为空**?
|
|
5148
5256
|
|
|
5149
5257
|
- 前往 飞书,选择群聊会话,添加已创建的Flashduty机器人,如下图所示:
|
|
5150
5258
|
- 回到分派策略配置页面,刷新后重新选择群聊列表
|
|
5151
5259
|
|
|
5152
5260
|
<img alt="drawing" width="800" src="https://download.flashcat.cloud/feishu-self-app-invite-to-chat.jpeg" />
|
|
5153
5261
|
<img src="https://download.flashcat.cloud/feishu-self-app-notify-rule.png" alt="drawing" width="800"/>
|
|
5154
|
-
|
|
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=`---
|
|
5155
5283
|
title: "钉钉集成"
|
|
5156
5284
|
description: "通过集成钉钉自建应用,实现在钉钉端内接收和响应告警的能力"
|
|
5157
5285
|
date: "2024-05-11T10:00:00+08:00"
|
|
@@ -5302,6 +5430,15 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide"
|
|
|
5302
5430
|
|
|
5303
5431
|
<img src="https://download.flashcat.cloud/dingtalk-self-app-notify-rule.png" alt="drawing" width="800"/>
|
|
5304
5432
|
|
|
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
|
+
**注意:** 超出限制后将无法正常推送消息,建议合理使用通知渠道
|
|
5305
5442
|
`,G=`---
|
|
5306
5443
|
title: "企业微信集成"
|
|
5307
5444
|
description: "通过集成企业微信第三方应用,实现在企业微信端内接收和响应告警的能力"
|
|
@@ -5436,7 +5573,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/slack-integration-guide"
|
|
|
5436
5573
|
|
|
5437
5574
|
8. **Slack App 内 Other questions,报错**
|
|
5438
5575
|
- 重新操作,遇到了还没被记录的问题
|
|
5439
|
-
- 重试后仍然报错,联系客服`,
|
|
5576
|
+
- 重试后仍然报错,联系客服`,K=`---
|
|
5440
5577
|
title: "Microsoft Teams集成"
|
|
5441
5578
|
description: "通过集成 Microsoft Teams 第三方应用,实现在 Microsoft Teams 内接收和响应告警的能力"
|
|
5442
5579
|
date: "2024-05-11T10:00:00+08:00"
|
|
@@ -5531,7 +5668,7 @@ Microsoft Teams 集成现处于 Beta 阶段,在关联前您需要先完成以
|
|
|
5531
5668
|
暂不支持
|
|
5532
5669
|
</details>
|
|
5533
5670
|
|
|
5534
|
-
`,
|
|
5671
|
+
`,Z=`配置告警 Webhook,当告警发生特定操作(如触发、关闭)时,系统通过 HTTP 回调您配置的地址。回调内容将包含告警最新关键信息,您可以与自研工具进行集成。
|
|
5535
5672
|
|
|
5536
5673
|
<span id="EventTypes"></span>
|
|
5537
5674
|
|
|
@@ -5699,7 +5836,7 @@ curl -X POST 'https://example.com/alert/webhook?a=a' \\
|
|
|
5699
5836
|
4. **推送来源可信 IP 白名单?**
|
|
5700
5837
|
- {ip_whitelist}
|
|
5701
5838
|
- 未来可能会更新,请定期查验
|
|
5702
|
-
`,
|
|
5839
|
+
`,X=`配置故障 Webhook,当故障发生特定操作(如触发、关闭)时,系统通过 HTTP 回调您配置的地址。回调内容将包含故障最新关键信息,您可以与自研工具进行集成。
|
|
5703
5840
|
|
|
5704
5841
|
<span id="EventTypes"></span>
|
|
5705
5842
|
|
|
@@ -5906,7 +6043,7 @@ curl -X POST 'https://example.com/incident/webhook?a=a' \\
|
|
|
5906
6043
|
|
|
5907
6044
|
4. **推送来源可信 IP 白名单?**
|
|
5908
6045
|
- {ip_whitelist}
|
|
5909
|
-
- 未来可能会更新,请定期查验`,
|
|
6046
|
+
- 未来可能会更新,请定期查验`,Y=`配置故障 自定义操作,允许您在故障排查期间,快速调用外部接口,实现故障自愈、信息丰富等任何自定义操作。
|
|
5910
6047
|
|
|
5911
6048
|
## 一、创建操作
|
|
5912
6049
|
|
|
@@ -6166,6 +6303,91 @@ curl -X POST 'https://example.com/incident/action?a=a' \\
|
|
|
6166
6303
|
2. **推送来源可信 IP 白名单?**
|
|
6167
6304
|
- {ip_whitelist}
|
|
6168
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=`---
|
|
6169
6391
|
title: "配置通知模版"
|
|
6170
6392
|
description: "通过自定义配置模版,可以实现个性化通知内容的需求"
|
|
6171
6393
|
date: "2024-05-10T10:00:00+08:00"
|
|
@@ -6995,4 +7217,4 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
|
|
|
6995
7217
|
<img src="https://download.flashcat.cloud/flashduty/changelog/20230720/email_render.png" alt="drawing" style="display: block; margin: 0 auto;" width="500"/>
|
|
6996
7218
|
|
|
6997
7219
|
|
|
6998
|
-
`,
|
|
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;
|
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
|
-
`,
|
|
314
|
+
`,i=`---
|
|
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
|
-
`,
|
|
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"
|
|
@@ -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:
|
|
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:`---
|
|
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"
|
|
@@ -6513,4 +6513,192 @@ If custom content is not set, the system default template will be used for notif
|
|
|
6513
6513
|
As shown below:
|
|
6514
6514
|
<img src="https://download.flashcat.cloud/flashduty/doc/en/fd/template-mail-1.png" width="800">
|
|
6515
6515
|
|
|
6516
|
+
`,HuaweiyunAPM:`---
|
|
6517
|
+
title: "Huawei Cloud APM Alerts"
|
|
6518
|
+
description: "Sync Huawei Cloud APM alerts to Flashduty through webhook to achieve automatic alert noise reduction"
|
|
6519
|
+
date: "2024-07-05T10:00:00+08:00"
|
|
6520
|
+
url: "https://docs.flashcat.cloud/en/flashduty/huawei-apm-integration-guide"
|
|
6521
|
+
---
|
|
6522
|
+
|
|
6523
|
+
Sync Huawei Cloud APM alerts to Flashduty through webhook, to achieve automatic noise reduction of alerts.
|
|
6524
|
+
|
|
6525
|
+
<div class="hide">
|
|
6526
|
+
|
|
6527
|
+
## In Flashduty
|
|
6528
|
+
---
|
|
6529
|
+
You can get an integration push URL through the following 2 methods, choose one of them.
|
|
6530
|
+
|
|
6531
|
+
### Use dedicated integration
|
|
6532
|
+
|
|
6533
|
+
When you don't need to route alerts to different channels, choose this method, it's simpler.
|
|
6534
|
+
|
|
6535
|
+
<details>
|
|
6536
|
+
<summary>Expand</summary>
|
|
6537
|
+
|
|
6538
|
+
1. Go to Flashduty console, select **Channels**, enter the details page of a channel
|
|
6539
|
+
2. Select the **Integrations** tab, click **Add Integration** to enter the integration page
|
|
6540
|
+
3. Select **Huawei Cloud APM** integration, click **Save** to generate a card
|
|
6541
|
+
4. Click the generated card to view the **push URL**, copy it for later use. Done.
|
|
6542
|
+
|
|
6543
|
+
</details>
|
|
6544
|
+
|
|
6545
|
+
### Use shared integration
|
|
6546
|
+
|
|
6547
|
+
When you need to route alerts to different channels based on alert payload information, this method is preferred.
|
|
6548
|
+
|
|
6549
|
+
<details>
|
|
6550
|
+
<summary>Expand</summary>
|
|
6551
|
+
|
|
6552
|
+
1. Go to Flashduty console, select **Integration Center=>Alerts** to enter the integration selection page
|
|
6553
|
+
2. Select **Huawei Cloud APM** integration:
|
|
6554
|
+
- **Integration Name**: Define a name for the current integration
|
|
6555
|
+
3. Click **Save** and copy the newly generated **push URL** for later use
|
|
6556
|
+
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
|
|
6557
|
+
5. Done.
|
|
6558
|
+
|
|
6559
|
+
</details>
|
|
6560
|
+
</div>
|
|
6561
|
+
|
|
6562
|
+
## In Huawei Cloud
|
|
6563
|
+
---
|
|
6564
|
+
|
|
6565
|
+
<div class="md-block">
|
|
6566
|
+
|
|
6567
|
+
## I. Huawei Cloud APM Alert Push Configuration
|
|
6568
|
+
|
|
6569
|
+
### Create FlashDuty Alert Channel
|
|
6570
|
+
|
|
6571
|
+
1. Log in to your Huawei Cloud Console, search for \`SMN\` (Simple Message Notification) service and enter its console
|
|
6572
|
+
2. Select \`Topic Management=>Topics\` from the left navigation bar
|
|
6573
|
+
3. Click \`Create Topic\`, enter \`FlashDuty\` as the topic name in the edit page and confirm
|
|
6574
|
+
|
|
6575
|
+
<img src="https://download.flashcat.cloud/flashduty/doc/en/hw/lts-1.png" alt="drawing" width="500"/>
|
|
6576
|
+
|
|
6577
|
+
4. Return to the topic list and click \`Add Subscription\` in the newly created FlashDuty topic
|
|
6578
|
+
|
|
6579
|
+
<img src="https://download.flashcat.cloud/flashduty/doc/en/hw/lts-2.png" alt="drawing" width="500"/>
|
|
6580
|
+
|
|
6581
|
+
5. In the edit page, select \`HTTPS\` as the protocol, enter the **push URL** as the subscription endpoint and confirm
|
|
6582
|
+
|
|
6583
|
+
<img src="https://download.flashcat.cloud/flashduty/doc/en/hw/lts-3.png" alt="drawing" width="500"/>
|
|
6584
|
+
|
|
6585
|
+
6. After adding, check if the subscription status shows **Confirmed** in the subscription list
|
|
6586
|
+
|
|
6587
|
+
<img src="https://download.flashcat.cloud/flashduty/doc/en/hw/lts-4.png" alt="drawing" width="500"/>
|
|
6588
|
+
|
|
6589
|
+
### Configure Application Monitoring Alerts
|
|
6590
|
+
|
|
6591
|
+
#### Step 1: Add Notification Configuration
|
|
6592
|
+
1. Log in to your \`Huawei Cloud APM\` console, under \`Application Monitoring=>Metrics\`, click \`Notification\`
|
|
6593
|
+
2. Select the corresponding region, click \`Add\`, and select the created \`FlashDuty\` topic
|
|
6594
|
+
3. Click \`Confirm\` to complete the configuration
|
|
6595
|
+
|
|
6596
|
+
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/en/hw/hw-apm-1.png" />
|
|
6597
|
+
|
|
6598
|
+
#### Step 2: Create Alert Policy
|
|
6599
|
+
1. Under \`Application Monitoring=>Metrics\`, select your application and click the \`Settings\` button
|
|
6600
|
+
2. Select \`Alarm Policy\`, click \`Add Custom Alarm Policy\` or edit an existing alarm policy
|
|
6601
|
+
3. In the \`Alarm Policy\` edit page, configure alert metrics and conditions according to your business needs
|
|
6602
|
+
4. In \`Notification Content\`, when referencing variables, it's recommended to use K:V format for easier alert parsing, such as host:\${hostInfo}
|
|
6603
|
+
5. In \`Notification Object\`, select the created \`FlashDuty\` notification channel
|
|
6604
|
+
6. Click \`Confirm\` to complete the configuration
|
|
6605
|
+
|
|
6606
|
+
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/en/hw/hw-apm-2.png" />
|
|
6607
|
+
|
|
6608
|
+
**Note:** The current integration configuration only supports application monitoring alerts, and does not fully support front-end monitoring, link tracking, and App monitoring alerts.
|
|
6609
|
+
</div>
|
|
6610
|
+
|
|
6611
|
+
## II. Status Mapping
|
|
6612
|
+
|
|
6613
|
+
<div class="md-block">
|
|
6614
|
+
|
|
6615
|
+
| Huawei Cloud APM | Flashduty | Severity |
|
|
6616
|
+
| ---------- | -------- | ---- |
|
|
6617
|
+
| CRITICAL | Critical | Critical |
|
|
6618
|
+
| COMMON | Info | Info |
|
|
6619
|
+
|
|
6620
|
+
</div>
|
|
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.
|
|
6516
6704
|
`};n.FlashDocsEn=u})(window);
|
package/dist/iife/zh.js
CHANGED
|
@@ -5144,13 +5144,33 @@ sidebarDepth: 3
|
|
|
5144
5144
|
- 确保账户已经完成关联,前往 飞书 > 工作台 > 搜索应用名称 > 打开应用,完成一次登录并关联(飞书< - >Flashduty)账号。如果已经登录过,尝试点击右上角菜单,切换账户,重新登录来绑定账号
|
|
5145
5145
|
- 确保已购买足够的 license,已使用 license 情况,可以在控制台 > 费用中心查看
|
|
5146
5146
|
|
|
5147
|
-
|
|
5147
|
+
3. **分派策略飞书群聊列表为空**?
|
|
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
|
+
**注意:** 超出限制后将无法正常推送消息,建议合理使用通知渠道
|
|
5154
5174
|
`,Dingtalk:`---
|
|
5155
5175
|
title: "钉钉集成"
|
|
5156
5176
|
description: "通过集成钉钉自建应用,实现在钉钉端内接收和响应告警的能力"
|
|
@@ -5302,6 +5322,15 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide"
|
|
|
5302
5322
|
|
|
5303
5323
|
<img src="https://download.flashcat.cloud/dingtalk-self-app-notify-rule.png" alt="drawing" width="800"/>
|
|
5304
5324
|
|
|
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
|
+
**注意:** 超出限制后将无法正常推送消息,建议合理使用通知渠道
|
|
5305
5334
|
`,Wecom:`---
|
|
5306
5335
|
title: "企业微信集成"
|
|
5307
5336
|
description: "通过集成企业微信第三方应用,实现在企业微信端内接收和响应告警的能力"
|
|
@@ -6995,4 +7024,197 @@ CloseTime | int64 | 否 | 关闭时间,EndTime 为告警恢复时间,CloseTi
|
|
|
6995
7024
|
<img src="https://download.flashcat.cloud/flashduty/changelog/20230720/email_render.png" alt="drawing" style="display: block; margin: 0 auto;" width="500"/>
|
|
6996
7025
|
|
|
6997
7026
|
|
|
7027
|
+
`,HuaweiyunAPM:`---
|
|
7028
|
+
title: "华为云 APM 告警事件"
|
|
7029
|
+
description: "通过 webhook 的方式同步华为云 APM 告警事件到 Flashduty,实现告警事件自动化降噪处理"
|
|
7030
|
+
date: "2024-07-05T10:00:00+08:00"
|
|
7031
|
+
url: "https://docs.flashcat.cloud/zh/flashduty/huawei-apm-integration-guide"
|
|
7032
|
+
---
|
|
7033
|
+
|
|
7034
|
+
通过 webhook 的方式同步华为云 APM 告警事件到 Flashduty,实现告警事件自动化降噪处理。
|
|
7035
|
+
|
|
7036
|
+
<div class="hide">
|
|
7037
|
+
|
|
7038
|
+
## 在 Flashduty
|
|
7039
|
+
---
|
|
7040
|
+
您可通过以下2种方式,获取一个集成推送地址,任选其一即可。
|
|
7041
|
+
|
|
7042
|
+
### 使用专属集成
|
|
7043
|
+
|
|
7044
|
+
当您不需要将告警事件路由到不同的协作空间,优先选择此方式,更简单。
|
|
7045
|
+
|
|
7046
|
+
<details>
|
|
7047
|
+
<summary>展开</summary>
|
|
7048
|
+
|
|
7049
|
+
1. 进入 Flashduty 控制台,选择 **协作空间**,进入某个空间的详情页面
|
|
7050
|
+
2. 选择 **集成数据** tab,点击 **添加一个集成**,进入添加集成页面
|
|
7051
|
+
3. 选择 **华为云 APM** 集成,点击 **保存**,生成卡片。
|
|
7052
|
+
4. 点击生成的卡片,可以查看到 **推送地址**,复制备用,完成。
|
|
7053
|
+
|
|
7054
|
+
|
|
7055
|
+
</details>
|
|
7056
|
+
|
|
7057
|
+
### 使用共享集成
|
|
7058
|
+
|
|
7059
|
+
当您需要根据告警事件的 Payload 信息,将告警路由到不同的协作空间,优先选择此方式。
|
|
7060
|
+
|
|
7061
|
+
<details>
|
|
7062
|
+
<summary>展开</summary>
|
|
7063
|
+
|
|
7064
|
+
1. 进入 Flashduty 控制台,选择 **集成中心=>告警事件**,进入集成选择页面。
|
|
7065
|
+
2. 选择 **华为云 APM** 集成:
|
|
7066
|
+
- **集成名称**:为当前集成定义一个名称。
|
|
7067
|
+
3. 点击 **保存** 后,复制当前页面的新生成的 **推送地址** 备用。
|
|
7068
|
+
4. 点击 **创建路由**,为集成配置路由规则。您可以按条件匹配不同的告警到不同的协作空间,也可以直接设置默认协作空间作为兜底,后续再按需调整。
|
|
7069
|
+
5. 完成。
|
|
7070
|
+
|
|
7071
|
+
</details>
|
|
7072
|
+
</div>
|
|
7073
|
+
|
|
7074
|
+
## 在华为云 APM
|
|
7075
|
+
---
|
|
7076
|
+
|
|
7077
|
+
<div class="md-block">
|
|
7078
|
+
|
|
7079
|
+
|
|
7080
|
+
## 一、华为云 APM 告警推送配置
|
|
7081
|
+
|
|
7082
|
+
### 创建 FlashDuty 告警通道
|
|
7083
|
+
1. 登录您的华为云控制台,检索 \`SMN\` 消息通知服务产品,并进入对应产品控制台。
|
|
7084
|
+
2. 在左侧导航栏选择 \`主题管理=>主题\`。
|
|
7085
|
+
3. 点击 \`创建主题\`,在编辑页面中的主题名称处输入 \`FlashDuty\` 并点击确认。
|
|
7086
|
+
|
|
7087
|
+
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/huawei-lts-1.png" />
|
|
7088
|
+
|
|
7089
|
+
4. 回到主题列表后,在刚创建的 FlashDuty 主题中点击 \`添加订阅\`。
|
|
7090
|
+
|
|
7091
|
+
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/huawei-lts-2.png" />
|
|
7092
|
+
|
|
7093
|
+
5. 在编辑页面中,协议选择 \`HTTPS\`,订阅终端填写 **集成推送地址** 并点击确认。
|
|
7094
|
+
|
|
7095
|
+
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/huawei-lts-3.png" />
|
|
7096
|
+
|
|
7097
|
+
6. 添加完成后,可以在订阅列表中查看已添加的订阅状态是否为 **已确认**。
|
|
7098
|
+
|
|
7099
|
+
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/huawei-lts-4.png" />
|
|
7100
|
+
|
|
7101
|
+
### 配置应用监控告警
|
|
7102
|
+
|
|
7103
|
+
#### 步骤1:添加通知配置
|
|
7104
|
+
1. 登录您的 \`华为云 APM\` 控制台,在 \`应用监控=>指标\` 中,点击 \`通知配置\`。
|
|
7105
|
+
2. 选择对应的区域后,点击 \`新增\`,在主题处选择已创建的 \`FlashDuty\` 主题。
|
|
7106
|
+
3. 点击 \`确认\` 完成配置。
|
|
7107
|
+
|
|
7108
|
+
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/zh/hw/hw-apm-1.png" />
|
|
7109
|
+
|
|
7110
|
+
#### 步骤2:创建告警策略
|
|
7111
|
+
1. 在 \`应用监控=>指标\` 中,选择您的应用并点击 \`设置\` 按钮。
|
|
7112
|
+
2. 选择 \`告警策略\`,点击 \`新增自定义告警策略\` 或编辑已有的告警策略。
|
|
7113
|
+
3. 在 \`告警策略\` 编辑页面中,告警指标、告警条件等请按业务需要进行配置。
|
|
7114
|
+
4. \`告警内容\` 中在引用变量时,建议以K:V的格式进行配置,便于后续告警事件的解析,比如 host:\${hostInfo}。
|
|
7115
|
+
5. \`通知对象\` 中选择已创建的 \`FlashDuty\` 通知渠道。
|
|
7116
|
+
6. 点击 \`确认\` 完成配置。
|
|
7117
|
+
|
|
7118
|
+
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/zh/hw/hw-apm-2.png" />
|
|
7119
|
+
|
|
7120
|
+
**注意:** 当前集成配置仅支持应用监控告警,还未完全兼容前端监控、链路追踪、App监控告警。
|
|
7121
|
+
</div>
|
|
7122
|
+
|
|
7123
|
+
## 二、状态对照
|
|
7124
|
+
|
|
7125
|
+
<div class="md-block">
|
|
7126
|
+
|
|
7127
|
+
| 华为云 APM | Flashduty | 状态 |
|
|
7128
|
+
| ---------- | -------- | ---- |
|
|
7129
|
+
| 严重告警 | Critical | 严重 |
|
|
7130
|
+
| 轻微告警 | Info | 提醒 |
|
|
7131
|
+
|
|
7132
|
+
|
|
7133
|
+
</div>
|
|
7134
|
+
|
|
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。
|
|
6998
7220
|
`};n.FlashDocsZh=t})(window);
|
package/dist/zh.d.ts
CHANGED