diff --git a/ecp/en_US/monitor/_assets/manager-setting-log.png b/ecp/en_US/monitor/_assets/manager-setting-log.png new file mode 100644 index 0000000..2c10eb7 Binary files /dev/null and b/ecp/en_US/monitor/_assets/manager-setting-log.png differ diff --git a/ecp/en_US/monitor/_assets/manager-setting-monitor.png b/ecp/en_US/monitor/_assets/manager-setting-monitor.png index 2b091dd..abab0b1 100644 Binary files a/ecp/en_US/monitor/_assets/manager-setting-monitor.png and b/ecp/en_US/monitor/_assets/manager-setting-monitor.png differ diff --git a/ecp/en_US/monitor/introduction.md b/ecp/en_US/monitor/introduction.md index 5e94958..a4d11ac 100644 --- a/ecp/en_US/monitor/introduction.md +++ b/ecp/en_US/monitor/introduction.md @@ -2,7 +2,7 @@ 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. @@ -10,18 +10,12 @@ Departing from traditional methods, ECP strives for a seamless experience across 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 {{appname}}. - - `health_check_interval` for Elasticsearch can be configured as needed. +- `index_name` refers to the index name in Elasticsearch, which should always be {{appname}}. +- `health_check_interval` for Elasticsearch can be configured as needed. ``` [[outputs.elasticsearch]] @@ -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: `:`. -- **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. -log-receiver-config +log-receiver-config ### 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. monitor-config