Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
chongyuanyin committed Aug 8, 2024
1 parent 3319631 commit 56a1409
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 7 deletions.
4 changes: 2 additions & 2 deletions ecp/directory.json
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@
},
{
"title": "EMQX 集群监控",
"path": "https://docs.emqx.com/zh/enterprise/v4.4/getting-started/dashboard-ee.html#%E7%9B%91%E6%8E%A7"
"path": "monitor/monitor_cluster"
},
{
"title": "边缘服务监控",
Expand Down Expand Up @@ -326,7 +326,7 @@
},
{
"title": "Monitor EMQX Clusters",
"path": "https://docs.emqx.com/en/enterprise/v4.4/getting-started/dashboard-ee.html#monitor"
"path": "monitor/monitor_cluster"
},
{
"title": "Monitor Edge Services",
Expand Down
Binary file modified ecp/en_US/monitor/_assets/alert-notification.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ecp/en_US/monitor/_assets/alert-rules.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 8 additions & 4 deletions ecp/en_US/monitor/alarm_rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ You can configure the notification silence duration and the objects for which th

If the silence duration applies to "Single alarm level", then ECP won't repeatedly send notifications for the same alarm within the silence duration period. Notifications will resume once the silence duration expires.

If the silence duration applies to "Edge service instance level", then any alarms generated on the same edge service within the silence duration period won't trigger repeated notifications. Notifications will resume once the silence duration expires.
If the silence duration applies to "Edge/Cluster service instance level", then any alarms generated on the same edge service or cluster within the silence duration period won't trigger repeated notifications. Notifications will resume once the silence duration expires.

Notification silence settings only affect alarms notification through emails and Webhooks. All alarm events will still be displayed in the Active/History Alarms.

Expand All @@ -58,7 +58,7 @@ Log in as system admins, organization admins, or project admins, you can also se

![alert_rules](./_assets/alert-rules.png)

ECP currently supports alarm rules triggered by edge services and those triggered by ECP itself. Rules triggered by edge services include NeuronEX driver exceptions, NeuronEX rule exceptions, and NeuronEX restarted event. ECP-triggered rules include NeuronEX offline event, email sending failures, and Webhook sending failures. For more details on these rules, please refer to the [Operations Management - Alarm Rules List](../monitor/rules.md).
ECP currently supports alarm rules triggered by edge services, by EMQX clusters and by ECP itself. Rules triggered by edge services include NeuronEX driver exceptions, NeuronEX rule exceptions, NeuronEX offline event, and NeuronEX restarted event. Rules triggered by clusters include EMQX rule exceptions and EMQX connector exceptions. ECP-triggered rules include email sending failures, and Webhook sending failures. For more details on these rules, please refer to the [Operations Management - Alarm Rules List](../monitor/rules.md).

You can set both the triggering conditions and rescovery conditions for each rule. The only exception is **NeuronEX restart** alarm rule, which you cannot set for either. You can set smaller triggering values if you want alarms to be more sensitive. Or you can set larger triggering values if you prefer to limit the frequency of alarms. Currently, the upper limit for triggering and recovery values is 10.

Expand All @@ -70,16 +70,20 @@ Log in as system admins, organization admins, or project admins, you can also se

![alarm-notification-config](./_assets/alarm-notification-config.png)

ECP supports configuring one or more alarm notifications. Different alarm notifications are associated with different edge services by service tags. When alarms are triggered on these associated edge services, notifications will be sent to the corresponding email and Webhooks.
ECP supports configuring one or more alarm notifications. Different alarm notifications are associated with different edge services by service tags, or associated to cluster if **Push EMQX Alarm** is enabled. When alarms are triggered on these associated edge services or clusters, notifications will be sent to the corresponding email and Webhooks.

<img src="./_assets/alert-notification.png" style="zoom: 50%;" align="middle">
<img src="./_assets/alert-notification.png" style="zoom: 80%;" align="middle">

### Alarmed Edge Services

If "All" is selected, any alarms triggered on edge services within the project will be sent to the emails and Webhooks set in this configuration. Alternatively, one or more service tags can be chosen, and only alarms from edge services associated with these selected tags will be notified.

Please note: If the alarm is triggered on project level, such as email sending failure or Webhook sending failure alarms, notifications will be sent to emails and Webhooks in all notification configurations.

### Push EMQX Alarm

If "Push EMQX Alarm" is enabled, any alarm generated on clusters within the project will be sent to the email or Webhook.

### Email Notification

1. Click the **Email Notification** toggle switch to enable notification by email.
Expand Down
15 changes: 15 additions & 0 deletions ecp/en_US/monitor/monitor_cluster.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Monitor EMQX Cluster

ECP provides a comprehensive operating status overview on the **Cluster Monitor** page.

![cluster-monitor](./_assets/cluster-monitor.png)

## Basic Statistics

- Connection: The number of all connections and live connections of all clusters in the project.
- Rule: The number of total cluster rules, running rules and stopped rules in the project.
- Connector: The number of total cluster connectors, connected ones and disconnected ones in the project.

### Cluster Rule and Connector Lists

Underneath these cards, you'll find the details of stopped cluster rules and disconnected connectors lists. You can filter the lists by cluster name. Moreover, you can perform O&M actions per instance by clicking **Details** button from Action column.
4 changes: 3 additions & 1 deletion ecp/en_US/monitor/rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@ See below for a list of alarms in ECP.
| NeuronEX offline alarm | Critical | NeuronEX <code v-pre>{{instance name}}</code> Offline | From the same NeuronEX instance |
| NeuronEX restart alarm | Critical | NeuronEX <code v-pre>{{instance name}}</code> Restarted | From the same NeuronEX instance |
| Email send failed alarm | Normal | Email sending failed, please check mail server configuration. | |
| Webhook send failed alarm | Normal | Webhook sending failed, Webhook address: <code v-pre>{{address}}</code> | |
| Webhook send failed alarm | Normal | Webhook sending failed, Webhook address: <code v-pre>{{address}}</code>. | |
| EMQX rule alarm | Critical | EMQX <code v-pre>{{instance name}}</code> Rule <code v-pre>{{rule name}}</code> alarm. | From the same EMQX cluster |
| EMQX connector alarm | Critical | EMQX <code v-pre>{{instance name}}</code> Connector <code v-pre>{{connector name}}</code> alarm. | From the same EMQX cluster |

0 comments on commit 56a1409

Please sign in to comment.