Skip to content

Commit

Permalink
update en doc for monitoring
Browse files Browse the repository at this point in the history
  • Loading branch information
chongyuanyin committed Apr 3, 2024
1 parent 8779f7e commit 3cb1566
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 19 deletions.
Binary file added ecp/en_US/monitor/_assets/manager-setting-log.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/manager-setting-monitor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 14 additions & 19 deletions ecp/en_US/monitor/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,20 @@

ECP platform's logs and observability feature offers a comprehensive solution for managing and monitoring both cloud-based EMQX clusters and edge devices.

By integrating with [Prometheus](https://prometheus.io/docs/introduction/overview/), the open-source renowned for monitoring and alerting, EMQX achieves real-time collection, analysis, and monitoring of data and provides our users with precise resource management, performance tuning, and risk prediction.
By integrating with [Prometheus](https://prometheus.io/docs/introduction/overview/), the open-source renowned for monitoring and alerting, ECP achieves real-time collection, analysis, and monitoring of data and provides our users with precise resource management, performance tuning, and risk prediction.

Departing from traditional methods, ECP strives for a seamless experience across cloud and edge environments, facilitating the management and monitoring of various components, including EMQX clusters, edge services, and network connections, with a single toolkit, leading to notable enhancements in the performance, reliability, and scalability of both cloud and edge computing.

## External Log Service Setup

ECP gathers log data by connecting to an external Elasticsearch log server, offering logging services. For edge services, the logs are collected into Elasticsearch server from Telegraf which is configured on ECP side.

Before enabling log service, please install Elasticsearch and Telegraf, then follow the instructions to set input plugin and output plugin to Telegraf configuration file.
Log service requires Elasticsearch and Telegraf. Telegraf has been included in the installation package, please install Elasticsearch on your own and follow the instructions to set Elasticsearch output plugin to Telegraf configuration file.

1. Configure input plugin to make Telegraf the receiver of syslogs sending from edge services. Only UDP is supported for now, and the UDP port can be configured as needed.
- `urls` `username` `password` refer to Elasticsearch HTTP server address, username and password for basic auth.

```
[[inputs.syslog]]
server = "udp://:10514"
```
2. Configure output plugin to send syslogs to Elasticsearch.
- `urls` `username` `password` refer to Elasticsearch HTTP server address, username and password for basic auth.
- `index_name` refers to the index name in Elasticsearch, which should always be <code v-pre>{{appname}}</code>.
- `health_check_interval` for Elasticsearch can be configured as needed.
- `index_name` refers to the index name in Elasticsearch, which should always be <code v-pre>{{appname}}</code>.
- `health_check_interval` for Elasticsearch can be configured as needed.

```
[[outputs.elasticsearch]]
Expand All @@ -30,33 +24,34 @@ Before enabling log service, please install Elasticsearch and Telegraf, then fol
password = "elastic"
index_name = "{{appname}}"
health_check_interval = "10s"
insecure_skip_verify = true
```

## System Level Configurations

Before using the log and observability feature, System Admins can do some system-level settings.
Before using the log and monitoring feature, System Admins need to do some system-level settings.

### Enable Log Service

To activate this service, sign in as the system administrator. Then, navigate to the **Administration** page. Select **System Settings** -> **General Setting** and expand the **Log Receiver** section.
To activate this service, sign in as the system administrator. Then, navigate to the **Administration** page. Select **System Settings** -> **General Setting** and expand the **Log Receiver** section, and select the **Open** radio button.

Within this section, you can set up the Elasticsearch and Telegraf information. Once each connection test succeeds , you can save the log receiver details and establish a connection to the external log data source.
Within this section, you can set up the Elasticsearch information. Once the connection test succeeds , you can save the log receiver details and establish a connection to the external log data source.

- **Telegraf Address**: Refers to the server item in input plugin section of the Telegraf configuration file, which is like: `<telegarf-server-host>:<port>`.
- **Telegraf Protocol**: Only UDP is supported for now.
- **Log Level**: Refers to the lowest severity level of the logs which are collected from edge services.
- **ES URL**: Refers to Elasticsearch service address.
- **ES Username**: Refers to Elasticsearch user name.
- **ES Password**: Refers to Elasticsearch user password.

<img src="./_assets/log-receiver.png" alt="log-receiver-config" style="zoom:80%;" />
<img src="./_assets/manager-setting-log.png" alt="log-receiver-config" style="zoom:80%;" />

### Monitor

The monitoring service within ECP permits individualized configuration of pull intervals and timeout rules for EMQX and NeuronEX.

- **Pull Interval**: Refers to the frequency (in seconds), at which the monitoring system collects metric data.
- **Pull Timeout**: Specifies the duration (in seconds), after which the monitoring system will declare a data pull unsuccessful if no response is received.
- **EMQX Pull Interval**: Specifies the frequency (in seconds), at which the monitoring system collects EMQX metric data.
- **EMQX Pull Timeout**: Specifies the duration (in seconds), after which the monitoring system will declare a data pull unsuccessful if no response from EMQX is received.
- **NeuronEX Pull Interval**: Specifies the frequency (in seconds), at which the monitoring system collects NeuronEX metric data.
- **NeuronEX Probe Interval**: Specifies the frequency (in seconds), at which NeuronEX reports heartbeat to ECP.

<img src="./_assets/manager-setting-monitor.png" alt="monitor-config" style="zoom:80%;" />

Expand Down

0 comments on commit 3cb1566

Please sign in to comment.