Already have an account? Sign In
Metricbeat is a lightweight shipper that helps you monitor your MySql database servers by collecting metrics running on the MySql server. Configure Metricbeat using the pre-defined examples below to collect and ship MySql database server metrics and statistics to Logstash or Elasticsearch.
curl -L -O https://artifacts.elastic.co/downloads/beats//-oss-7.8.1-amd64.deb sudo dpkg -i -oss-7.8.1-amd64.deb
curl -L -O https://artifacts.elastic.co/downloads/beats//-oss-7.8.1-x86_64.rpm sudo rpm -vi -oss-7.8.1-x86_64.rpm
curl -L -O https://artifacts.elastic.co/downloads/beats//-oss-7.8.1-darwin-x86_64.tar.gz tar xzvf -oss-7.8.1-darwin-x86_64.tar.gz
- Download the Windows zip file from the official downloads page.
- Extract the contents of the zip file into C:\Program Files.
- Rename the
-<version>-windowsdirectory to ``.
- Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select Run As Administrator). If you are running Windows XP, you may need to download and install PowerShell.
- Run the following commands to install as a Windows service:
cd 'C:\Program Files\' .\install-service-.ps1
PowerShell.exe -ExecutionPolicy UnRestricted -File .\install-service-.ps1.
We'll be shipping to Logstash so that we have the option to run filters before the data is indexed.
Comment out the elasticsearch output block.
## Comment out elasticsearch output #output.elasticsearch: # hosts: ["localhost:9200"]
Let's check the configuration file is syntactically correct by running directly inside the terminal.
If the file is invalid, will print an
error loading config file error message with details on how to correct the problem.
sudo -e -c /etc//.yml
cd <EXTRACTED_ARCHIVE> ./ -e -c .yml
cd <EXTRACTED_ARCHIVE> .\.exe -e -c .yml
There are several built in metricbeat modules you can use. To enable the MySql module, run the following:
metricbeat modules list metricbeat modules enable mysql
./metricbeat modules list ./metricbeat modules enable mysql
PS > .\metricbeat.exe modules enable mysql
Each module has its own configuration file where different metricsets can be enabled / disabled. Locate the configuration file for the MySql module.
By default the status metricset is disabled. To enable or disable a metric simply comment or uncomment the line out.
- module: mysql metricsets: - status - galera_status period: 10s
You will also need to enter the host location of the database and the username and password to access it.
# Host DSN should be defined as "user:pass@tcp(127.0.0.1:3306)/" # The username and password can either be set in the DSN or using the username # and password config options. Those specified in the DSN take precedence. hosts: ["(127.0.0.1:3306)/"] # Username of hosts. Empty by default. username: root # Password of hosts. Empty by default. password: secret
Ok, time to start gathering metrics!
sudo systemctl enable metricbeat sudo systemctl start metricbeat
PS C:\Program Files\Metricbeat> Start-Service metricbeat
The mysql MetricSets were tested with MySQL and Percona 5.7 and 8.0 and are expected to work with all versions >= 5.7.0. It is also tested with MariaDB 10.2, 10.3 and 10.4.
The MySql module comes with a predefined Kibana dashboard.