Skip to content

Commit 7f9cef7

Browse files
committed
chore: fix conflict
2 parents 49d1f00 + b5b2053 commit 7f9cef7

87 files changed

Lines changed: 3903 additions & 96 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs.json

Lines changed: 68 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@
4949
"zh/platform/pricing",
5050
"zh/platform/team-members",
5151
"zh/platform/permission-design",
52-
"zh/platform/configure-sso"
52+
"zh/platform/configure-sso",
53+
"zh/platform/audit-log"
5354
]
5455
},
5556
{
@@ -97,6 +98,7 @@
9798
"zh/on-call/incident/search-view-incident",
9899
"zh/on-call/incident/handle-update-incident",
99100
"zh/on-call/incident/escalate-dispatch-incident",
101+
"zh/on-call/incident/alert-management",
100102
"zh/on-call/incident/custom-actions",
101103
"zh/on-call/incident/past-incidents",
102104
"zh/on-call/incident/outlier-incidents"
@@ -105,7 +107,12 @@
105107
{
106108
"group": "状态页",
107109
"pages": [
108-
"zh/on-call/statuspage/statuspage"
110+
"zh/on-call/statuspage/statuspage",
111+
"zh/on-call/statuspage/create-manage-page",
112+
"zh/on-call/statuspage/components-sections",
113+
"zh/on-call/statuspage/publish-events",
114+
"zh/on-call/statuspage/templates",
115+
"zh/on-call/statuspage/subscriptions"
109116
]
110117
},
111118
{
@@ -367,6 +374,19 @@
367374
"zh/monitors/quickstart/quickstart"
368375
]
369376
},
377+
{
378+
"group": "数据源",
379+
"pages": [
380+
"zh/monitors/data-sources/data-sources"
381+
]
382+
},
383+
{
384+
"group": "告警引擎",
385+
"pages": [
386+
"zh/monitors/engine/engine",
387+
"zh/monitors/engine/engine-lost-alert"
388+
]
389+
},
370390
{
371391
"group": "告警规则",
372392
"pages": [
@@ -381,6 +401,18 @@
381401
"zh/monitors/alert-rules/victorialogs"
382402
]
383403
},
404+
{
405+
"group": "规则仓库",
406+
"pages": [
407+
"zh/monitors/rule-repository/rule-repository"
408+
]
409+
},
410+
{
411+
"group": "文件夹管理",
412+
"pages": [
413+
"zh/monitors/folders/folders"
414+
]
415+
},
384416
{
385417
"group": "常见问题",
386418
"pages": [
@@ -420,7 +452,8 @@
420452
"en/platform/pricing",
421453
"en/platform/team-members",
422454
"en/platform/permission-design",
423-
"en/platform/configure-sso"
455+
"en/platform/configure-sso",
456+
"en/platform/audit-log"
424457
]
425458
},
426459
{
@@ -468,6 +501,7 @@
468501
"en/on-call/incident/search-view-incident",
469502
"en/on-call/incident/handle-update-incident",
470503
"en/on-call/incident/escalate-dispatch-incident",
504+
"en/on-call/incident/alert-management",
471505
"en/on-call/incident/custom-actions",
472506
"en/on-call/incident/past-incidents",
473507
"en/on-call/incident/outlier-incidents"
@@ -476,7 +510,12 @@
476510
{
477511
"group": "Status Page",
478512
"pages": [
479-
"en/on-call/statuspage/statuspage"
513+
"en/on-call/statuspage/statuspage",
514+
"en/on-call/statuspage/create-manage-page",
515+
"en/on-call/statuspage/components-sections",
516+
"en/on-call/statuspage/publish-events",
517+
"en/on-call/statuspage/templates",
518+
"en/on-call/statuspage/subscriptions"
480519
]
481520
},
482521
{
@@ -739,6 +778,19 @@
739778
"en/monitors/quickstart/quickstart"
740779
]
741780
},
781+
{
782+
"group": "Data Sources",
783+
"pages": [
784+
"en/monitors/data-sources/data-sources"
785+
]
786+
},
787+
{
788+
"group": "Alert Engine",
789+
"pages": [
790+
"en/monitors/engine/engine",
791+
"en/monitors/engine/engine-lost-alert"
792+
]
793+
},
742794
{
743795
"group": "Alert Rules",
744796
"pages": [
@@ -753,6 +805,18 @@
753805
"en/monitors/alert-rules/victorialogs"
754806
]
755807
},
808+
{
809+
"group": "Rule Repository",
810+
"pages": [
811+
"en/monitors/rule-repository/rule-repository"
812+
]
813+
},
814+
{
815+
"group": "Folder Management",
816+
"pages": [
817+
"en/monitors/folders/folders"
818+
]
819+
},
756820
{
757821
"group": "FAQ",
758822
"pages": [
Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
---
2+
title: "Data source management"
3+
description: "Configure and manage data sources for Monitors, including Prometheus, Elasticsearch, Loki, ClickHouse, MySQL, Oracle, PostgreSQL, and SLS"
4+
keywords: ["data source", "Prometheus", "Elasticsearch", "Loki", "ClickHouse", "MySQL", "Oracle", "PostgreSQL", "SLS"]
5+
---
6+
7+
Data sources are where the alert engine queries data. You need to configure data sources first so the alert engine can read data from them for anomaly detection.
8+
9+
**Menu Entry**: Data Sources
10+
11+
## Supported data source types
12+
13+
Monitors supports the following 8 data source types:
14+
15+
| Type | Description |
16+
|------|-------------|
17+
| **Prometheus** | Time series database, queried via PromQL |
18+
| **Elasticsearch** | Distributed search and analytics engine |
19+
| **Loki** | Lightweight log aggregation system |
20+
| **ClickHouse** | Columnar analytics database |
21+
| **MySQL** | Relational database |
22+
| **Oracle** | Relational database |
23+
| **PostgreSQL** | Relational database |
24+
| **SLS** | Alibaba Cloud Log Service |
25+
26+
## Data source list
27+
28+
The data source list displays all configured data sources with the following information:
29+
30+
- **Name**: The identifier for the data source
31+
- **Type**: Data source type with icon
32+
- **Connection URL**: The access address of the data source
33+
- **Associated Alert Engine**: The bound alert engine cluster name, with engine online status indicator
34+
- **Notes**: Supplementary description
35+
36+
You can filter data sources by name or type using the search box. The list auto-refreshes every 5 seconds to reflect real-time engine connection status.
37+
38+
## Create a data source
39+
40+
<Steps>
41+
<Step title="Select data source type">
42+
Click the **New** button and select the data source type (e.g., Prometheus, MySQL) at the top of the form.
43+
</Step>
44+
<Step title="Fill in basic information">
45+
46+
| Config Item | Description |
47+
|-------------|-------------|
48+
| **Name** | Unique identifier for the data source; alert rules reference data sources by name (wildcards supported) |
49+
| **Notes** | Optional supplementary description |
50+
| **Associated Alert Engine** | Select the engine cluster responsible for querying this data source; typically choose a cluster in the same datacenter |
51+
52+
</Step>
53+
<Step title="Configure connection parameters">
54+
Fill in the connection parameters specific to the data source type. See the sections below for details.
55+
</Step>
56+
<Step title="Save">
57+
Click **OK** to complete creation.
58+
</Step>
59+
</Steps>
60+
61+
<Warning>
62+
Data source names are used for association in alert rules (wildcard matching supported). Changing a data source name may cause existing alert rules to stop working. Please proceed with caution.
63+
</Warning>
64+
65+
## Data source type configuration
66+
67+
### Prometheus
68+
69+
| Config Item | Description |
70+
|-------------|-------------|
71+
| **Server URL** | Prometheus server address, e.g., `http://localhost:9090` |
72+
| **Headers** | Custom HTTP request headers, supports multiple Key-Value pairs |
73+
| **Params** | Custom URL query parameters, supports multiple Key-Value pairs |
74+
| **Basic Authentication** | When enabled, requires username and password |
75+
| **Self-Signed Certificate** | When enabled, fill in CA certificate content |
76+
| **TLS Client Authentication** | When enabled, requires ServerName, client certificate, and client key |
77+
| **Skip TLS Certificate Validation** | Skip TLS certificate verification |
78+
79+
### MySQL / Oracle / PostgreSQL
80+
81+
Relational databases share a similar configuration structure:
82+
83+
| Config Item | Description | Default |
84+
|-------------|-------------|---------|
85+
| **Connection URL** | Database address, e.g., `localhost:3306` (MySQL), `localhost:1521` (Oracle), `localhost:5432` (PostgreSQL) | - |
86+
| **Max Connections** | Maximum open connections in the connection pool | 32 |
87+
| **Idle Connections** | Maximum idle connections in the connection pool | 4 |
88+
| **Connection Lifetime (seconds)** | Maximum connection lifetime | 600 |
89+
| **Timeout (milliseconds)** | Query timeout | 5000 |
90+
| **Username** | Database username | - |
91+
| **Password** | Database password | - |
92+
93+
Self-signed certificate and TLS client authentication configurations are also supported.
94+
95+
### Elasticsearch / Loki / ClickHouse / SLS
96+
97+
These data sources have connection configurations similar to Prometheus, including server address, authentication, and TLS settings. Refer to the creation form for specific parameters.
98+
99+
## Test a data source
100+
101+
In the data source list, click the **Test** button for the corresponding data source to open a query preview window, verify the connection, and preview query results.
102+
103+
## Edit and delete
104+
105+
- **Edit**: Click the **Edit** button in the data source list to modify the configuration and save.
106+
- **Delete**: Click the **Delete** button in the data source list and confirm to delete the data source.
107+
108+
<Warning>
109+
Before deleting a data source, ensure no alert rules reference it, otherwise the related alert rules will not execute properly.
110+
</Warning>
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
title: "Engine disconnection alert"
3+
description: "Configure engine disconnection alert rules to receive timely notifications when the alert engine goes down"
4+
keywords: ["engine disconnection", "alert engine", "monitedge", "disconnection alert", "health check"]
5+
---
6+
7+
If the alert engine (`monitedge`) goes down, alert rules cannot execute, which has a significant impact. The engine disconnection alert feature sends timely notifications when the engine goes down, ensuring the reliability of your monitoring system.
8+
9+
**Menu Entry**: Alert Engine → Engine Disconnection Alert
10+
11+
<Note>
12+
For an engine cluster composed of multiple instances, as long as at least one instance in the cluster is alive, the disconnection alert will not trigger. It only triggers when all instances in the cluster are disconnected.
13+
</Note>
14+
15+
## Alert rule list
16+
17+
The list displays all configured engine disconnection alert rules, with support for keyword search and customizable display columns.
18+
19+
| Column | Description |
20+
|--------|-------------|
21+
| **Rule Name** | Name of the alert rule |
22+
| **Severity** | Critical (red), Warning (orange), Info (yellow) |
23+
| **Include Pattern** | Engine cluster name patterns to monitor; supports wildcard `*` |
24+
| **Exclude Pattern** | Engine cluster name patterns to exclude from monitoring |
25+
| **Lost Duration (seconds)** | Triggers an alert after the engine cluster has no heartbeat for this duration |
26+
| **Channel** | The channel where alert events are delivered |
27+
| **Trigger Count** | Maximum number of alert events to generate during disconnection |
28+
| **Trigger Interval (seconds)** | Time interval between repeated alert event generation |
29+
| **Enabled** | Enable/disable toggle for the rule |
30+
31+
## Create an alert rule
32+
33+
Click the **New** button to configure the following parameters in the side drawer:
34+
35+
<Steps>
36+
<Step title="Basic information">
37+
38+
| Config Item | Description | Default |
39+
|-------------|-------------|---------|
40+
| **Rule Name** | Rule name for identification and search | `monitedge lost` |
41+
| **Enabled** | Whether to enable this rule immediately | Enabled |
42+
43+
</Step>
44+
<Step title="Severity">
45+
Select the severity level for alert events:
46+
47+
- **Critical**: Urgent, typically used for core engines
48+
- **Warning**: Warning level, the default
49+
- **Info**: Informational level
50+
</Step>
51+
<Step title="Include and exclude rules">
52+
53+
| Config Item | Description | Default |
54+
|-------------|-------------|---------|
55+
| **Include Pattern** | Enter engine cluster name patterns to monitor; supports multiple values; `*` matches all | `*` |
56+
| **Exclude Pattern** | Enter engine cluster name patterns to exclude | Empty |
57+
58+
<Note>
59+
Include pattern and exclude pattern cannot both be empty.
60+
</Note>
61+
</Step>
62+
<Step title="Trigger conditions">
63+
64+
| Config Item | Description | Default |
65+
|-------------|-------------|---------|
66+
| **Lost Duration (seconds)** | Triggers an alert when all instances in the cluster are disconnected for longer than this duration | 120 |
67+
| **Trigger Count** | Maximum number of alert events to repeatedly generate during continuous disconnection | 3 |
68+
| **Trigger Interval (seconds)** | Minimum time interval between each repeated alert event | 300 |
69+
70+
</Step>
71+
<Step title="Channel">
72+
Select the channel where alert events should be delivered. Alert events are processed through Flashduty On-call channels for subsequent notification dispatch and handling.
73+
</Step>
74+
</Steps>
75+
76+
## Edit and delete
77+
78+
- **Edit**: Click the **Edit** button in the list to modify rule configuration. Only the rule creator, primary account, or admin roles can edit.
79+
- **Delete**: Click the **Delete** button in the list. Only the rule creator, primary account, or admin roles can delete.
80+
- **Enable/Disable**: Quickly toggle the rule status using the switch in the list.

0 commit comments

Comments
 (0)