Skip to content

F wecom alert #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
niuweili merged 16 commits into from
Sep 17, 2025
Merged

F wecom alert #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
125eaa3
docs: session replay
Fiona2016 Aug 5, 2025
63a09df
add sdk config
Aug 7, 2025
eb5bc5f
feat: update config
Fiona2016 Aug 7, 2025
bd9bbd9
feat: 1. update images 2. add english version
Fiona2016 Aug 11, 2025
7831cae
feat: update tip
Fiona2016 Aug 14, 2025
a5c1c32
fix: update document
Fiona2016 Aug 15, 2025
b7d9099
fix: privacy config
Fiona2016 Aug 18, 2025
2394582
Merge pull request #74 from flashcatcloud/f-cloudflare-dev
niuweili Aug 26, 2025
d3572da
feat: v1.3.3
Aug 26, 2025
8b28c92
Update README.md
niuweili Sep 2, 2025
f9d326b
update standard integration doc
pijiang3 Sep 3, 2025
4766dba
modify default template
alick-liming Sep 5, 2025
067e410
Merge pull request #68 from flashcatcloud/feat/rum-session-replay
Fiona2016 Sep 9, 2025
7357359
update servicenow docs
pijiang3 Sep 15, 2025
6f42108
add wecom alert docs
pijiang3 Sep 17, 2025
116e6ea
Merge branch 'test' into f-wecom-alert
pijiang3 Sep 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,4 @@ date: "2023-12-18T10:00:00+08:00"
```

完成润色后，可在 VSCode / Cursor 中打开文档，然后在文档 tab 页中右击，点击 `格式化文档`。

81 changes: 81 additions & 0 deletions ...On-call/8. Integrations/8.1 Alerts integration/8.1.52 WecomAlert Integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
title: "Wecom Alert Integration"
description: "Generate a unique Wecom robot address in Flashduty, and synchronize the occurrence and recovery of alerts through Wecom"
date: "2025-05-19T10:00:00+08:00"
url: "https://docs.flashcat.cloud/en/flashduty/Wecom-alert-integration-guide"
---

Generate a unique Wecom robot address in Flashduty, and synchronize the occurrence and recovery of alerts through Wecom.

<div class="hide">

## Operation Steps
---

### Create Wecom Alert Integration

You can obtain a Wecom alert integration address through either of these two methods:

#### Using Dedicated Integration

Choose this method when you don't need to route alert events to different channels. It's simpler and recommended.

<details>
<summary>Expand</summary>

1. Go to the Flashduty console, select **Channel**, and enter a specific channel's details page
2. Select the **Integration** tab, click **Add Integration** to enter the integration page
3. Choose **Wecom Alert** integration and click **Save** to generate a card
4. Click the generated card to view the **Wecom Alert Integration URL**, copy it for later use, and you're done

</details>

#### Using Shared Integration

Choose this method when you need to route alerts to different channels based on the alert event'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 **Wecom Alert** integration:
- **Integration Name**: Define a name for the current integration
- **Message Type**: Select Wecom alert message type, currently only Text and Markdown are supported
- **Push Mode**: Choose when to trigger or recover alerts for Wecom notifications
3. Copy the **Wecom Alert Integration URL** for later use
4. Configure the default route and select the corresponding channel (after integration creation, you can go to `Routes` to configure more routing rules)
5. Done

</details>
</div>

### Customize Wecom Alert Integration

#### Wecom Alert Integration URL

The system will generate a unique Wecom alert integration URL for you. This URL is compatible with Wecom robot message protocol. When platforms only support Wecom robot channels, you can use this URL to receive corresponding messages.

#### Push Mode

By default, the system always creates new alerts for each message, but you can switch to these modes:

**Trigger or Close Alert Based on Rules**: In this mode, when receiving a new message, the system matches messages according to your rules and triggers new alerts or closes existing alerts based on the matching results.

- You need to fill in at least one **trigger** rule
- You must set up regex extraction rules for Alert Key. The system uses this field to find historical alerts for updates or closure. **If regex extraction fails, the system will use the message title to generate an Alert Key** to ensure alerts won't be lost due to configuration errors
- You can choose whether to discard messages when none of the rules match

Configuration example:

- Receive all messages, close the alert when the message content contains **RESOLVED**, otherwise trigger a new alert
- Extract Alert Key from message title using the rule **/(.*)/**.


### Notes
- Wecom alert integration URL only supports Text and Markdown message types; other message types cannot be received
- Flashduty will generate a default alert title: "Wecom robot Alert , If you need to change the title, you can customize it using the [alert pipeline](https://docs.flashcat.cloud/en/flashduty/alert-pipelines)"

## Severity Mapping
---

Currently, all alerts pushed to Flashduty through the Wecom integration are set to Warning severity. However, you can customize the severity using the [alert pipeline](https://docs.flashcat.cloud/en/flashduty/alert-pipelines).
2 changes: 1 addition & 1 deletion flashduty/en/1. On-call/8. Integrations/8.5 Webhooks/8.5.5 ServiceNow sync.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The user used to access ServiceNow needs to have administrator roles.

1. On the user list page, find the newly created `flashduty` user and go to the configuration page.
2. In the edit page, click `Set Password` to set a password.
3. Click `Roles` to add **admin and itil** roles.
3. Click `Roles` to add **personalize_dictionary and itil** roles (If custom field mapping configuration is not required, the personalize_dictionary permission does not need to be retained).
4. Click `Update` to update the configuration.

<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/snow/snow-2.png" />
Expand Down
56 changes: 28 additions & 28 deletions flashduty/en/2. RUM/2. Applications/2. SDK Integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,35 +108,35 @@ Add the following code snippet to the beginning of the `head` tag in each `HTML`

You can check for loading issues with `window.FC_RUM` if the RUM browser SDK fails to load.




## Initialization Parameters

| Configuration | Type | Required | Description |
| -------------------------- | -------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| applicationId | String | Yes | Application ID, obtained from the application management page |
| clientToken | String | Yes | Client Token, obtained from the application management page |
| service | String | Yes | Service name, used to distinguish different services |
| env | String | No | Environment identifier, such as production, staging, etc. |
| version | String | No | Application version |
| trackingConsent | "granted" \| "not-granted" | No | Set initial user tracking consent status. See user tracking consent. Default: `granted` |
| trackViewsManually | Boolean | No | Allows you to control RUM view creation. See override default RUM view names. Default: `false` |
| trackUserInteractions | Boolean | No | Enable automatic collection of user actions. Default: `true` |
| trackResources | Boolean | No | Enable collection of resource events. Default: `true` |
| trackLongTasks | Boolean | No | Enable collection of long task events. Default: `true` |
| trackAnonymousUser | Boolean | No | Enable cross-session collection of anonymous user IDs. Default: `true` |
| enablePrivacyForActionName | Boolean | No | See mask action names. Default: `false` |
| actionNameAttribute | String | No | Specify your own attribute to use for naming actions. Default: `false` |
| sessionSampleRate | Number | No | Percentage of sessions to track: 100 for all, 0 for none. Only tracked sessions send RUM events. Default: `100` |
| silentMultipleInit | Boolean | No | If the RUM browser SDK is already initialized on the page, initialization will silently fail. Default: `false` |
| proxy | String | No | Optional proxy URL, for example: `https://www.proxy.com/path` |
| allowedTracingUrls | Array | No | List of request URLs for injecting tracing headers. For more information, see [Connect RUM and Traces](https://docs.flashcat.cloud/en/flashduty/rum/sdk-integration#Connect%20RUM%20and%20Traces) |
| traceSampleRate | Number | No | Percentage of requests to trace: 100 for all, 0 for none. Default: `100` |
| excludedActivityUrls | Array | No | List of request origins to ignore when calculating page activity |
| compressIntakeRequests | Boolean | No | Compress requests sent to the FlashDuty intake to reduce bandwidth usage when sending large amounts of data. Compression is done in a Worker thread. Default: `false` |
| storeContextsAcrossPages | Boolean | No | Store global context and user context in localStorage to preserve them across user navigation. Default: `false` |
| allowUntrustedEvents | Boolean | No | Allow capturing [untrusted events][https://developer.mozilla.org/en-US/docs/Web/API/Event/isTrusted], for example in automated UI tests. Default: `false` |
| Configuration | Type | Required | Description |
| ----------------------------------- | -------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| applicationId | String | Yes | Application ID, obtained from the application management page |
| clientToken | String | Yes | Client Token, obtained from the application management page |
| service | String | Yes | Service name, used to distinguish different services |
| env | String | No | Environment identifier, such as production, staging, etc. |
| version | String | No | Application version |
| trackingConsent | "granted" \| "not-granted" | No | Set initial user tracking consent status. See user tracking consent. Default: `granted` |
| trackViewsManually | Boolean | No | Allows you to control RUM view creation. See override default RUM view names. Default: `false` |
| trackUserInteractions | Boolean | No | Enable automatic collection of user actions. Default: `true` |
| trackResources | Boolean | No | Enable collection of resource events. Default: `true` |
| trackLongTasks | Boolean | No | Enable collection of long task events. Default: `true` |
| trackAnonymousUser | Boolean | No | Enable cross-session collection of anonymous user IDs. Default: `true` |
| enablePrivacyForActionName | Boolean | No | See mask action names. Default: `false` |
| actionNameAttribute | String | No | Specify your own attribute to use for naming actions. Default: `false` |
| sessionSampleRate | Number | No | Percentage of sessions to track: 100 for all, 0 for none. Only tracked sessions send RUM events. Default: `100` |
| sessionReplaySampleRate | Number | No | Percentage of tracked sessions to enable [session replay](https://docs.flashcat.cloud/en/flashduty/rum/session-replay) functionality: 100 for all, 0 for none. Default: `0` |
| sessionReplayPrivacyLevel | String | No | Privacy policy for session replay data collection. 'allow' collects all data except passwords, 'mask-user-input' hides user input field content, 'mask-all' hides all text information. Default: `'mask-user-input'` |
| startSessionReplayRecordingManually | Boolean | No | Whether to manually enable session replay recording switch |
| silentMultipleInit | Boolean | No | If the RUM browser SDK is already initialized on the page, initialization will silently fail. Default: `false` |
| proxy | String | No | Optional proxy URL, for example: `https://www.proxy.com/path` |
| allowedTracingUrls | Array | No | List of request URLs for injecting tracing headers. For more information, see [Connect RUM and Traces](https://docs.flashcat.cloud/en/flashduty/rum/advanced-configuration#connect-rum-and-distributed-tracing) |
| traceSampleRate | Number | No | Percentage of requests to trace: 100 for all, 0 for none. Default: `100` |
| excludedActivityUrls | Array | No | List of request origins to ignore when calculating page activity |
| compressIntakeRequests | Boolean | No | Compress requests sent to the FlashDuty intake to reduce bandwidth usage when sending large amounts of data. Compression is done in a Worker thread. Default: `false` |
| storeContextsAcrossPages | Boolean | No | Store global context and user context in localStorage to preserve them across user navigation. Default: `false` |
| allowUntrustedEvents | Boolean | No | Allow capturing [untrusted events](https://developer.mozilla.org/en-US/docs/Web/API/Event/isTrusted), for example in automated UI tests. Default: `false` |

## Use Cases

Expand Down Expand Up @@ -209,4 +209,4 @@ After integration, you can validate whether the integration was successful throu

- [RUM Application Management](https://docs.flashcat.cloud/en/flashduty/rum/application-management?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5): Learn how to create and manage RUM applications
- [RUM SDK Advanced Configuration](https://docs.flashcat.cloud/en/flashduty/rum/advanced-configuration?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5): Learn how to configure advanced features of the SDK
- [RUM Analysis Dashboard](https://docs.flashcat.cloud/en/flashduty/rum/analysis-dashboard?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5): View and analyze RUM data
- [RUM Analysis Dashboard](https://docs.flashcat.cloud/en/flashduty/rum/analysis-dashboard?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5): View and analyze RUM data
Loading