Quick onboard
Deployment
Data Modeling
Connecting
Migration
Query
Operations and Maintenance
Common Maintenance
Partition
Backup and Restore
Expansion
Mirroring
Resource Management
Security
Monitoring
Performance Tuning
Troubleshooting
Reference Guide
Tool guide
Data type
Storage Engine
Executor
Stream
DR (Disaster Recovery)
Configuration
Index
Extension
SQL Reference
YMatrix provides a native graphical monitoring tool based on Grafana. This document describes the steps to deploy and manage the monitoring components. YMatrix provides a default monitoring dashboard that can monitor the following information. Users can also create custom dashboards in Grafana based on the collected system data.
After deployment, the monitoring interface appears as shown below. Starting from version 4.4, the monitoring dashboards are split into two panels: MatrixDB Dashboard and MatrixDB Database.
MatrixDB Dashboard:
MatrixDB Database:
Monitoring components are included in the YMatrix installation package. After deploying YMatrix, complete the monitoring setup in two steps: enabling metric collection and installing and configuring Grafana.
Perform the following steps to enable metric collection for YMatrix and system resource usage. Collected data is stored in a newly created database named matrixmgr. In the examples below, the master node is named mdw.
[<regular_user>@mdw ~]$ sudo su - mxadmin[mxadmin@mdw ~]$ psql -d matrixmgr
matrixmgr=# SELECT mxmgr_init_local();Upon success, a new schema named local appears in the matrixmgr database. Tables and views under this schema contain cluster monitoring and configuration information. Do not modify the definitions or contents of these tables and views manually.
Prepare a host that can access both the Master node and the Internet. This can be the Master, Standby Master, or a separate machine (Linux, macOS, Windows, etc.).
Install Grafana, version 7.3 or later is recommended. The official download page is: https://grafana.com/grafana/download.
Commands below use CentOS 7 as an example. For other operating systems, refer to the corresponding documentation.
Note!
YMatrix supports offline Grafana installation. For details, see Monitoring and Alerting FAQ.
wget https://dl.grafana.com/oss/release/grafana-7.3.6-1.x86_64.rpm
sudo yum install grafana-7.3.6-1.x86_64.rpm[mxadmin@mdw ~]$ sudo systemctl daemon-reload
[mxadmin@mdw ~]$ sudo systemctl start grafana-server
[mxadmin@mdw ~]$ sudo systemctl status grafana-server
[mxadmin@mdw ~]$ sudo systemctl enable grafana-serverNote!
- The Grafana version provided by
yumin CentOS 7 is often outdated (6.x), sosudo yum install grafanais not recommended.- For the complete official installation guide, see: https://grafana.com/docs/grafana/latest/installation/rpm
After installation, access the following URL in a browser. Port 3000 is the default Grafana port and can be changed. Log in using the default credentials (admin / admin). For security, change the password after logging in by clicking the user icon in the lower-left corner.
http://<IP_or_hostname_of_installed_node>:3000After Grafana is installed, add the matrixmgr database in YMatrix as a data source and import the predefined monitoring dashboards.
Steps to add a data source:
Before importing the predefined dashboards, copy the dashboard.json and database.json files to your local machine. Locate the files on the server, copy them, and then upload them locally. Follow these steps:
First, log in to the server and switch to the mxadmin user. Navigate to the path shown in the image to locate dashboard.json and database.json. You can use the cd command, find command, or any other method you prefer. Below is an example using find for database.json.
[mxadmin@mdw ~]$ cd /opt/ymatrix/matrixdb5/share/doc/postgresql/extension
##or
[mxadmin@mdw ~]$ find /opt/ymatrix/matrixdb5/share/doc/postgresql/extension -name database.jsonNext, use the scp command to copy the file locally. Permission issues may arise. Consider copying the file to /tmp/ first, then to your local machine. Example using database.json:
Note!
When copying from/tmp/to the local machine, ensure proper user context to avoid permission issues.
[mxadmin@mdw]$ scp mxadmin@<server_IP>:/opt/ymatrix/matrixdb5/share/doc/postgresql/extension/"database.json" mxadmin@<server_IP>:/tmp/
~ scp waq@<server_IP>:/tmp/"database.json" /Users/akkepler/workplace/GrafanaFinally, open the local folder or use the command line to verify the file was copied successfully. After confirmation, import the files into the Grafana interface.
Note!
If import fails, perform the following variable modifications.
In dashboard.json, replace all instances of ${cluster} with local. Replace $host with the actual hostnames. For example, if your cluster consists of mdw, sdw1, and sdw2, change all $host entries in dashboard.json to 'mdw','sdw1','sdw2'. For database.json, only replace ${cluster} with local. After modification, import the files into Grafana.
Click Upload JSON file to select and import dashboard.json and database.json. These files are located by default in /opt/ymatrix/matrixdb5/share/doc/postgresql/extension.
Note!
For more information on YMatrix data panel configuration, adding node_exporter panels, deploying MatrixGate monitoring panels, and etcd monitoring panels, see Grafana Monitoring Configuration.
For alert configuration, see Grafana Cluster Alerts.
After enabling cluster metric collection, each host runs a collection service. Related logs are stored in the /var/log/matrixdb directory.
If you restart YMatrix or reboot the server and restart YMatrix, the data collection service starts automatically. No manual intervention is required.
To stop the data collection service, connect to the matrixmgr database and run mxmgr_remove_all. Collected data remains after stopping:
[mxadmin@mdw ~]$ psql -d matrixmgr
matrixmgr=# SELECT mxmgr_remove_all('local');If the collection service is stopped manually or after reinstalling YMatrix, re-enable collection by connecting to the matrixmgr database and running mxmgr_deploy:
matrixmgr=# SELECT mxmgr_deploy('local');