MySQL module
editMySQL module
editThe 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
Read the quick start to learn how to set up and run modules.
Compatibility
editThe mysql
module was tested with logs from MySQL 5.5, 5.7 and 8.0,
MariaDB 10.1, 10.2 and 10.3, and Percona 5.7 and 8.0.
On Windows, the module was tested with MySQL installed from the Chocolatey repository.
Configure the module
editYou 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:
-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
editEach fileset has separate variable settings for configuring the behavior of the
module. If you don’t specify variable settings, the mysql
module uses
the defaults.
For more information, see Configure variable settings. Also see Override input 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 glob-based paths that specify where to look for the log files. All
patterns supported by Go Glob
are also supported here. For example, you can use wildcards to fetch all files
from a predefined level of subdirectories:
/path/to/log/*/*.log
. This fetches all.log
files from the subfolders of/path/to/log
. It does not fetch log files from the/path/to/log
folder itself. If this setting is left empty, Filebeat will choose log paths based on your operating system.
slowlog
fileset settings
edit-
var.paths
-
An array of glob-based paths that specify where to look for the log files. All
patterns supported by Go Glob
are also supported here. For example, you can use wildcards to fetch all files
from a predefined level of subdirectories:
/path/to/log/*/*.log
. This fetches all.log
files from the subfolders of/path/to/log
. It does not fetch log files from the/path/to/log
folder itself. If this setting is left empty, Filebeat will choose log paths based on your operating system.
Example dashboard
editThis module comes with a sample dashboard. For example:
Fields
editFor a description of each field in the module, see the exported fields section.