Start your 14-day free trial today & Get 20% Off All Annual Managed ELK Plans

No Credit Card Required

Try Logit.io Free

Already have an account? Sign In

Send data via MySql Metrics to your Logstash instance provided by Logit.io

MySql Metrics

Collect and ship MySql metrics to Logstash and Elasticsearch.

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.

Step 1 - Install MetricbeatCopy

deb (Debian/Ubuntu/Mint)

curl -L -O https://artifacts.elastic.co/downloads/beats//-oss-7.8.1-amd64.deb
sudo dpkg -i -oss-7.8.1-amd64.deb

rpm (CentOS/RHEL/Fedora)

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

macOS

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

Windows

  • Download the Windows zip file from the official downloads page.
  • Extract the contents of the zip file into C:\Program Files.
  • Rename the -<version>-windows directory 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
If script execution is disabled on your system, you need to set the execution policy for the current session to allow the script to run. For example: PowerShell.exe -ExecutionPolicy UnRestricted -File .\install-service-.ps1.
My OS isn't here! Don't see your system? Check out the official downloads page for more options (including 32-bit versions).

Step 2 - Locate configuration fileCopy

deb/rpm /etc/metricbeat/metricbeat.yml
mac/win <EXTRACTED_ARCHIVE>/metricbeat.yml

Step 3 - Configure outputCopy

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"]
No input available! Your stack is missing the required input for this data source Talk to support to add the input

Step 4 - Validate configurationCopy

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.

deb/rpm

sudo  -e -c /etc//.yml

macOS

cd <EXTRACTED_ARCHIVE>
./ -e -c .yml

Windows

cd <EXTRACTED_ARCHIVE>
.\.exe -e -c .yml

Step 5 - Enable moduleCopy

There are several built in metricbeat modules you can use. To enable the MySql module, run the following:

deb/rpm

metricbeat modules list
metricbeat modules enable mysql

macOS

./metricbeat modules list
./metricbeat modules enable mysql

Windows

PS > .\metricbeat.exe modules enable mysql

Step 6 - Configure moduleCopy

Each module has its own configuration file where different metricsets can be enabled / disabled. Locate the configuration file for the MySql module.

deb/rpm /etc/metricbeat/modules.d/mysql.yml

mac/win ~/<EXTRACTED_ARCHIVE>/modules.d/mysql.yml

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

Step 7 - Start MetricbeatCopy

Ok, time to start gathering metrics!

deb/rpm

sudo systemctl enable metricbeat
sudo systemctl start metricbeat

macOS

./metricbeat

Windows

PS C:\Program Files\Metricbeat> Start-Service metricbeat

Step 8 - CompatibilityCopy

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.

Step 9 - MySql Module DashboardCopy

The MySql module comes with a predefined Kibana dashboard.

Predefined Kibana dashboard

Toggle View

Expand View

Return to Search