Skip to content
Merged
565 changes: 564 additions & 1 deletion api-reference/monitors.openapi.en.json

Large diffs are not rendered by default.

565 changes: 564 additions & 1 deletion api-reference/monitors.openapi.zh.json

Large diffs are not rendered by default.

565 changes: 564 additions & 1 deletion api-reference/openapi.en.json

Large diffs are not rendered by default.

565 changes: 564 additions & 1 deletion api-reference/openapi.zh.json

Large diffs are not rendered by default.

34 changes: 32 additions & 2 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -2251,10 +2251,30 @@
"source": "/monit/datasource/update",
"destination": "/zh/api-reference/monitors/data-sources/monit-datasource-write-update"
},
{
"source": "/monit/folder/create",
"destination": "/zh/api-reference/monitors/rule-folders/monit-folder-write-create"
},
{
"source": "/monit/folder/delete",
"destination": "/zh/api-reference/monitors/rule-folders/monit-folder-write-delete"
},
{
"source": "/monit/folder/health",
"destination": "/zh/api-reference/monitors/rule-folders/monit-folder-read-health"
},
{
"source": "/monit/folder/list",
"destination": "/zh/api-reference/monitors/rule-folders/monit-folder-read-list"
},
{
"source": "/monit/folder/move",
"destination": "/zh/api-reference/monitors/rule-folders/monit-folder-write-move"
},
{
"source": "/monit/folder/update",
"destination": "/zh/api-reference/monitors/rule-folders/monit-folder-write-update"
},
{
"source": "/monit/prometheus/api/v1/label/{label_name}/values",
"destination": "/zh/api-reference/monitors/data-sources/monit-prometheus-read-label-values"
Expand Down Expand Up @@ -4365,7 +4385,12 @@
"group": "规则分组",
"icon": "folder-tree",
"pages": [
"POST /monit/folder/list"
"POST /monit/folder/list",
"POST /monit/folder/health",
"POST /monit/folder/create",
"POST /monit/folder/update",
"POST /monit/folder/move",
"POST /monit/folder/delete"
]
}
]
Expand Down Expand Up @@ -6116,7 +6141,12 @@
"group": "Rule folders",
"icon": "folder-tree",
"pages": [
"POST /monit/folder/list"
"POST /monit/folder/list",
"POST /monit/folder/health",
"POST /monit/folder/create",
"POST /monit/folder/update",
"POST /monit/folder/move",
"POST /monit/folder/delete"
]
}
]
Expand Down
4 changes: 2 additions & 2 deletions en/developer/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The tool is open source at [flashcatcloud/flashduty-cli](https://github.com/flas
curl -sSL https://static.flashcat.cloud/flashduty-cli/install.sh | sh
```

Installs to `/usr/local/bin` by default. Override with the `FLASHDUTY_INSTALL_DIR` environment variable.
Installs into the directory of the `flashduty` already on your `PATH` (an upgrade replaces it in place, so no stale copy shadows the new one), or `/usr/local/bin` if there is none. Override with the `FLASHDUTY_INSTALL_DIR` environment variable.
</Tab>

<Tab title="Windows (PowerShell)">
Expand All @@ -39,7 +39,7 @@ Read the latest version from the [CDN latest version pointer](https://static.fla
| Variable | Description | Default |
|----------|-------------|---------|
| `FLASHDUTY_VERSION` | Install a specific version, for example, `v1.5.12` | latest |
| `FLASHDUTY_INSTALL_DIR` | Custom install directory | `/usr/local/bin` (shell), `~\.flashduty\bin` (PowerShell) |
| `FLASHDUTY_INSTALL_DIR` | Custom install directory | shell: the directory of the `flashduty` already on `PATH`, else `/usr/local/bin`; PowerShell: `~\.flashduty\bin` |
| `MIRROR_URL` | Override the release asset download mirror prefix used by the installer script; must use `https://` | `https://static.flashcat.cloud/flashduty-cli` |
| `FLASHDUTY_UPDATE_BASE_URL` | Override the base URL used by `flashduty update` and the automatic update check | `https://static.flashcat.cloud/flashduty-cli` |
| `INSTALLED_NAME` | Command name to install as, for example, `fduty` | `flashduty` |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,25 +45,16 @@ Choose this option when you need to route alerts to different collaboration spac
</div>

## In Alibaba Cloud DataWorks
**Step 1: Create a custom webhook**

<div className="md-block">

1. Log in to the Alibaba Cloud console and open the **DataWorks** product
2. Go to **DataStudio** or **Operation Center** and open the **Intelligent Monitoring** page
3. Open the alarm receiver configuration (the custom webhook entry) and create a new webhook
4. Set the request URL to the Flashduty integration push URL copied above; the request method is POST
5. After saving, you can click **Send test message**. DataWorks pushes a connectivity test message (`message.content`); Flashduty returns success without creating an alert event

</div>

**Step 2: Enable the webhook in monitoring rules**

<div className="md-block">
2. Go to **Data Development and O&M** → **Operation Center**
3. In the left navigation, choose **Monitoring and Alerting** → **Rule Management**
4. Open an existing rule, or create a new one
5. In the rule's **Alarm Behavior** section, select **WebHook** as the alarm method, and paste the Flashduty integration push URL copied above into the webhook address field
6. Save the rule. Alerts triggered by this rule are pushed to Flashduty in real time

1. In **Intelligent Monitoring**, open the **custom rules** (instance status alerts, resource group alerts), **baseline management**, or **event management** page
2. Create or edit a rule, and select the custom webhook created above as an alarm channel
3. Save the rule. Alerts triggered by this rule are pushed to Flashduty in real time
> After entering the URL, you can click **Send test message** to verify connectivity. The test message only verifies the push URL; Flashduty returns success without creating an alert event.

</div>

Expand Down
11 changes: 6 additions & 5 deletions en/rum/quickstart/app-management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ The console provides detailed integration guides for each platform:

Each platform's SDK configuration page automatically fills in the current application's `applicationId` and `clientToken`, so you can copy the code directly into your project.

The Web, Android, iOS, Flutter, HarmonyOS, and WeChat Mini Program SDK configuration pages all provide an **Allow remote configuration** switch, which is on by default. When it's on, the generated code includes `remoteConfigurationEnabled: true` (`.setRemoteConfigurationEnabled(true)` on Android and HarmonyOS). When it's off, that line is omitted and the client never requests the remote configuration. The switch only affects the generated code. You still need to enable and publish a configuration on the [Remote Configuration](#remote-configuration) tab. Until you publish, the client uses the configuration in your code.
The Web, Android, iOS, Flutter, HarmonyOS, WeChat Mini Program, and Electron SDK configuration pages all provide an **Allow remote configuration** switch, which is on by default. When it's on, the generated code includes `remoteConfigurationEnabled: true` (`.setRemoteConfigurationEnabled(true)` on Android and HarmonyOS; in the main-process `init()` on Electron). When it's off, that line is omitted and the client never requests the remote configuration. The switch only affects the generated code. You still need to enable and publish a configuration on the [Remote Configuration](#remote-configuration) tab. Until you publish, the client uses the configuration in your code.

<Warning>
Modifying SDK configuration in application management will not take effect in real-time on integrated clients. All configuration changes need to be updated in your frontend code and redeployed to take effect.
Expand Down Expand Up @@ -353,7 +353,7 @@ The repository names shown in the list link to the corresponding repository on G
The **Remote Configuration** tab lets you adjust collection and privacy parameters online, without code changes or a new release. When enabled, the configuration on this page overrides SDK initialization settings. When disabled, clients fall back to their SDK initialization settings and data collection continues uninterrupted.

<Note>
- Remote Configuration is currently available for **Browser**, **iOS**, **Android**, **HarmonyOS**, **Flutter** and **WeChat Mini Program** applications. Other platform types will be enabled as their SDKs ship support.
- Remote Configuration is currently available for **Browser**, **iOS**, **Android**, **HarmonyOS**, **Flutter**, **WeChat Mini Program**, and **Electron** applications. Other platform types will be enabled as their SDKs ship support.
- The **Remote Configuration** tab is open to every account, on SaaS and private deployments alike — there is nothing for support to enable. Whether the tab appears depends only on whether the application type is one of the supported platforms listed above.
</Note>

Expand All @@ -363,20 +363,21 @@ The **Remote Configuration** tab lets you adjust collection and privacy paramete
|------|------|------|
| **Session sample rate** | Integer 0–100 (%) | Percentage of sessions collected. Leave it empty to skip delivering this field; clients keep the value set at SDK initialization |
| **Session replay sample rate** | Integer 0–100 (%) | Percentage of sessions recorded by Session Replay. If empty, the SDK setting applies |
| **On-error session capture** (`sessionOnError`) | On / Off / Use SDK setting | For sessions missed by session sampling, uploads up to the last minute of events on error and continues collection; Web applications require Web SDK 0.3.0 or later, HarmonyOS applications require HarmonyOS SDK 0.7.0 or later |
| **On-error session capture** (`sessionOnError`) | On / Off / Use SDK setting | For sessions missed by session sampling, uploads up to the last minute of events on error and continues collection; Web applications require Web SDK 0.3.0 or later, HarmonyOS applications require HarmonyOS SDK 0.7.0 or later, Electron applications require Electron SDK 0.4.0 or later |
| **On-error replay capture** (`sessionReplayOnError`) | On / Off / Use SDK setting | For collected sessions missed by replay sampling, uploads buffered replay on error and continues recording; requires Web SDK 0.3.0 or later |
| **Trace sample rate** | Integer 0–100 (%) | A second session-level sampling pass within already-collected sessions, deciding which sessions inject trace headers into eligible requests; the outcome is consistent within one session. Overall trace coverage is roughly *session sample rate × trace sample rate*. If empty, the SDK setting applies |
| **Replay privacy level** | `mask` / `mask-user-input` / `allow` | Default masking of page content in Session Replay: `mask` obscures text and hides input values; `mask-user-input` keeps page text and hides only what users typed; `allow` records the page as it is. Loosening the level starts collecting content that was not collected before, and replays already uploaded cannot be retroactively masked. The console asks you to confirm again before publishing |
| **Custom configuration keys** | Key–value pairs typed as string / number / boolean / JSON | Delivered to clients together with the remote configuration and read by your application code; the platform does not interpret them. Up to 5 keys; each key name is at most 64 bytes (counted in UTF-8, not characters), each value at most 4 KB and nesting at most 3 levels (objects and arrays each count one level), and all custom entries together at most 16 KB |

The two on-error options are independent: **On** delivers `true`, **Off** delivers `false`, and **Use SDK setting** omits the field so the corresponding `init()` option applies (off if unset). Browser applications require Web SDK 0.3.0 or later with `remoteConfigurationEnabled: true` at initialization; HarmonyOS applications use the same `sessionOnError` option (HarmonyOS SDK 0.7.0 or later, with `.setRemoteConfigurationEnabled(true)` at initialization) and have no on-error replay option. Turning off on-error capture does not affect sessions selected by ordinary sampling. See [Web SDK on-error session capture](/en/rum/sdk/web/advanced-config#on-error-session-capture) for scope, billing, and limitations.
The two on-error options are independent: **On** delivers `true`, **Off** delivers `false`, and **Use SDK setting** omits the field so the corresponding `init()` option applies (off if unset). Browser applications require Web SDK 0.3.0 or later with `remoteConfigurationEnabled: true` at initialization; HarmonyOS applications use the same `sessionOnError` option (HarmonyOS SDK 0.7.0 or later, with `.setRemoteConfigurationEnabled(true)` at initialization) and have no on-error replay option; Electron applications use the same `sessionOnError` option too (Electron SDK 0.4.0 or later, with `remoteConfigurationEnabled: true` in the main-process `init()`) and have no on-error replay option either. Turning off on-error capture does not affect sessions selected by ordinary sampling. See [Web SDK on-error session capture](/en/rum/sdk/web/advanced-config#on-error-session-capture) for scope, billing, and limitations.

iOS, Android, Flutter, and WeChat Mini Program applications also show the **Remote Configuration** tab, but their SDKs read only the **session sample rate** and **custom configuration keys**; the HarmonyOS SDK reads those two plus **on-error session capture**. None of them has Session Replay, and the other values have no effect. Every SDK has to opt in with `remoteConfigurationEnabled: true` at initialization (off by default; an application that has not opted in never requests the configuration). Minimum versions:
iOS, Android, Flutter, and WeChat Mini Program applications also show the **Remote Configuration** tab, but their SDKs read only the **session sample rate** and **custom configuration keys**; the HarmonyOS and Electron SDKs read those two plus **on-error session capture**. None of them has Session Replay to sample through this channel (Electron's replay is sampled by the renderer's own Browser SDK, which remote configuration does not reach), and the other values have no effect. Every SDK has to opt in with `remoteConfigurationEnabled: true` at initialization (off by default; an application that has not opted in never requests the configuration). Minimum versions:

- iOS: SDK 0.6.0. See [iOS SDK Advanced Configuration](/en/rum/sdk/ios/advanced-config#remote-configuration).
- Android: SDK 0.7.0. See [Android SDK Advanced Configuration](/en/rum/sdk/android/advanced-config#remote-configuration-adjust-the-sample-rate-from-the-console).
- HarmonyOS: SDK 0.6.0, or 0.7.0 for on-error session capture. See [HarmonyOS SDK Advanced Configuration](/en/rum/sdk/harmony/advanced-config#remote-configuration).
- Flutter: `flashcat_flutter_plugin` 0.2.0. See [Flutter SDK Advanced Configuration](/en/rum/sdk/flutter/advanced-config#remote-configuration).
- Electron: `@flashcatcloud/electron-sdk` 0.4.0, enabled in the main process. See [Electron SDK Advanced Configuration](/en/rum/sdk/electron/advanced-config#remote-configuration).

<Warning>
Custom entries are delivered to clients and may be readable by end users. Never put secrets, access tokens, or personally sensitive information in them.
Expand Down
Loading
Loading