WARNING: Version 6.2 of Filebeat 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.

« Logstash module Nginx module »
Elastic Docs ›Filebeat Reference [6.2] ›Modules

MySQL module

edit

MySQL module

edit

The mysql module collects and parses the slow logs and error logs created by MySQL.

When you run the module, it performs a few tasks under the hood:

  • Sets the default paths to the log files (but don’t worry, you can override the defaults)
  • Makes sure each multiline log event gets sent as a single event
  • Uses ingest node to parse and process the log lines, shaping the data into a structure suitable for visualizing in Kibana
  • Deploys dashboards for visualizing the log data

Compatibility

edit

The mysql module was tested with logs from versions 5.5 and 5.7.

On Windows, the module was tested with MySQL installed from the Chocolatey repository.

Set up and run the module

edit

If you’ve secured Elasticsearch and Kibana, you need to configure the username and password options in the Elasticsearch output before setting up and running the module. See Configure the Elasticsearch output.

Before doing these steps, verify that Elasticsearch and Kibana are running and that Elasticsearch is ready to receive data from Filebeat.

To set up and run the module:

  1. Enable the module:

    ./filebeat modules enable mysql

    The modules enable command enables the mysql config defined in the modules.d directory. See Specify which modules to run for other ways to enable modules.

    To see a list of enabled and disabled modules, run:

    ./filebeat modules list

  2. Set up the initial environment:

    ./filebeat setup -e

    The setup command loads the recommended index template for writing to Elasticsearch and deploys the sample dashboards for visualizing the data in Kibana. This is a one-time setup step.

    The -e flag is optional and sends output to standard error instead of syslog.

  3. Run Filebeat:

    ./filebeat -e

    If the module is configured correctly, you’ll see INFO Harvester started messages for each file specified in the config.

    If your logs aren’t in the default location, see Configure the module, then run Filebeat after you’ve configured the module.

    Depending on how you’ve installed Filebeat, you might see errors related to file ownership or permissions when you try to run Filebeat modules. See Config File Ownership and Permissions in the Beats Platform Reference if you encounter errors related to file ownership or permissions.

  4. Explore your data in Kibana:

    1. Open your browser and navigate to the Dashboard overview in Kibana: http://localhost:5601/app/kibana#/dashboards. Replace localhost with the name of the Kibana host.
    2. If security is enabled, log in with the Kibana username and password that you used when you set up security.

    3. Enter mysql in the search box, then open a dashboard and explore the visualizations for your parsed logs.

      If you don’t see data in Kibana, try changing the date range to a larger range. By default, Kibana shows the last 15 minutes.

Example dashboard

edit

This module comes with a sample dashboard. For example:

kibana mysql

Configure the module

edit

You can further refine the behavior of the mysql module by specifying variable settings in the modules.d/mysql.yml file, or overriding settings at the command line.

The following example shows how to set paths in the modules.d/mysql.yml file to override the default paths for slow logs and error logs:

- module: mysql
  error:
    enabled: true
    var.paths: ["/path/to/log/mysql/error.log*"]
  slowlog:
    enabled: true
    var.paths: ["/path/to/log/mysql/mysql-slow.log*"]

To specify the same settings at the command line, you use:

./filebeat --modules mysql -M "mysql.error.var.paths=[/path/to/log/mysql/error.log*]" -M "mysql.slowlog.var.paths=[/path/to/log/mysql/mysql-slow.log*]"

Variable settings

edit

The mysql module provides the following settings for configuring the behavior of the module. Each fileset has separate settings.

If you don’t specify variable settings, the mysql module uses the defaults.

For more information, see Specify variable settings. Also see Advanced settings.

When you specify a setting at the command line, remember to prefix the setting with the module name, for example, mysql.error.var.paths instead of error.var.paths.

error log fileset settings

edit
var.paths
An array of paths that specify where to look for the log files. If left empty, Filebeat will choose the paths depending on your operating systems.

slowlog fileset settings

edit
var.paths
An array of paths that specify where to look for the log files. If left empty, Filebeat will choose the paths depending on your operating systems.

Fields

edit

For a description of each field in the module, see the exported fields section.

« Logstash module Nginx module »