WARNING: Version 6.0 of Metricbeat has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« MongoDB status metricset MySQL status metricset »
Elastic Docs ›Metricbeat Reference [6.0] ›Modules

MySQL module

edit

MySQL module

edit

This module periodically fetches metrics from MySQL servers.

Module-specific configuration notes

edit

When configuring the hosts option, you must use a MySQL Data Source Name (DSN) of the following format:

[username[:password]@][protocol[(address)]]/

You can also separately specify the username and password using the respective configuration options. Usernames and passwords specified in the DSN take precedence over those specified in the username and password config options.

- module: mysql
  metricsets: ["status"]
  hosts: ["tcp(127.0.0.1:3306)/"]
  username: root
  password: secret

Compatibility

edit

The mysql MetricSets were tested with mysql 5.7.12 and are expected to work with all versions >= 5.7.0.

Example configuration

edit

The MySQL module supports the standard configuration options that are described in Specify which modules to run. Here is an example configuration:

metricbeat.modules:
- module: mysql
  metricsets: ["status"]
  period: 10s

  # 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: ["root:secret@tcp(127.0.0.1:3306)/"]

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

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

  # By setting raw to true, all raw fields from the status metricset will be added to the event.
  #raw: false

Metricsets

edit

The following metricsets are available:

« MongoDB status metricset MySQL status metricset »