Start your 14-day free trial today

No Credit Card Required

Try Free

Already have an account? Sign In

Send data via MySql Metrics to your Logstash instance provided by

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
sudo dpkg -i -oss-7.15.1-amd64.deb

rpm (CentOS/RHEL/Fedora)

curl -L -O
sudo rpm -vi -oss-7.15.1-x86_64.rpm


curl -L -O
tar xzvf -oss-7.15.1-darwin-x86_64.tar.gz


  • Download and extract the Windows zip file.
  • Rename the -<version>-windows directory to ``.
  • Open a PowerShell prompt as an Administrator.
  • Run the following to install as a Windows service:
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! Chat to support now

Step 2 - Copy configuration fileCopy

The configuration file below is pre-configured to send data to your Stack via Logstash.

Copy the configuration file below and overwrite the contents of metricbeat.yml.

###################### Metricbeat Configuration Example #######################
# =========================== Modules configuration ============================

  # Glob pattern for configuration loading
  path: ${path.config}/modules.d/*.yml

  # Set to true to enable config reloading
  reload.enabled: false

  # Period on which files under path should be checked for changes
  #reload.period: 10s
# ======================= Elasticsearch template setting =======================
  index.number_of_shards: 1
  index.codec: best_compression
  #_source.enabled: false

# ================================== Outputs ===================================
# ------------------------------ Logstash Output -------------------------------
<div class="sw-warning">
    <b>No input available! </b> Your stack is missing the required input for this data source <a href="#" onclick="Intercom('showNewMessage')" class="btn btn-info btn-sm">Talk to support to add the input</a>

Step 3 - Enable moduleCopy

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

Step 4 - 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
    - 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:[email protected]("
# 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: ["("]

# Username of hosts. Empty by default.
username: root

# Password of hosts. Empty by default.
password: secret

Step 5 - Start MetricbeatCopy

Ok, time to start gathering metrics!


sudo systemctl enable metricbeat
sudo systemctl start metricbeat




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

Step 6 - how to diagnose no data in StackCopy

If you don't see data appearing in your Stack after following the steps, visit the Help Centre guide for steps to diagnose no data appearing in your Stack or Chat to support now.

Step 7 - 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 8 - MySql Module DashboardCopy

The MySql module comes with predefined Kibana dashboards.

Predefined Kibana dashboard

Toggle View

Expand View

Return to Search

© 2022 Ltd, All rights reserved.