[comment]: # ({cafc1ec5-aee47150})
# 9 MySQL plugin
[comment]: # (tags: mysql)
[comment]: # ({/cafc1ec5-aee47150})
[comment]: # ({7e8aa5c3-7e8aa5c3})
#### Overview
This section lists parameters supported in the MySQL Zabbix agent 2
plugin configuration file (mysql.conf).
Note that:
- The default values reflect process defaults, not the values in the
shipped configuration files;
- Zabbix supports configuration files only in UTF-8 encoding without
[BOM](https://en.wikipedia.org/wiki/Byte_order_mark);
- Comments starting with "\#" are only supported at the beginning of
the line.
[comment]: # ({/7e8aa5c3-7e8aa5c3})
[comment]: # ({d41c94df-b9c98913})
#### Parameters
|Parameter|Mandatory|Range|Default|Description|
|--|--|--|--|----------|
|Plugins.Mysql.CallTimeout|no|1-30|global timeout|The maximum amount of time in seconds to wait for a request to be done.|
|Plugins.Mysql.CustomQueriesPath|no| |empty|Full path to the directory used for storing custom queries.
Supported since version 6.0.21.|
|Plugins.Mysql.Default.Password|no| | |Default password for connecting to MySQL; used if no value is specified in an item key or named session.
Supported since version 6.0.18.|
|Plugins.Mysql.Default.TLSCAFile|no
(yes, if Plugins.Mysql.Default.TLSConnect is set to *verify_ca* or *verify_full*)| | |Full pathname of a file containing the top-level CA(s) certificates for peer certificate verification for encrypted communications between Zabbix agent 2 and monitored databases; used if no value is specified in a named session.
Supported since version 6.0.18.|
|Plugins.Mysql.Default.TLSCertFile|no
(yes, if Plugins.Mysql.Default.TLSConnect is set to *verify_ca* or *verify_full*)| | |Full pathname of a file containing the agent certificate or certificate chain for encrypted communications between Zabbix agent 2 and monitored databases; used if no value is specified in a named session.
Supported since version 6.0.18.|
|Plugins.Mysql.Default.TLSConnect|no| | |Encryption type for communications between Zabbix agent 2 and monitored databases; used if no value is specified in a named session.
Supported values:
*required* - require TLS connection;
*verify\_ca* - verify certificates;
*verify\_full* - verify certificates and IP address.
Supported since version 6.0.18.|
|Plugins.Mysql.Default.TLSKeyFile|no
(yes, if Plugins.Mysql.Default.TLSConnect is set to *verify_ca* or *verify_full*)| | |Full pathname of a file containing the database private key for encrypted communications between Zabbix agent 2 and monitored databases; used if no value is specified in a named session.
Supported since version 6.0.18.|
|Plugins.Mysql.Default.Uri|no| |tcp://localhost:3306|Default URI for connecting to MySQL; used if no value is specified in an item key or named session.
Should not include embedded credentials (they will be ignored).
Must match the URI format.
Supported schemes: `tcp`, `unix`; a scheme can be omitted.
A port can be omitted (default=3306).
Examples: `tcp://localhost:3306`
`localhost`
`unix:/var/run/mysql.sock`
Supported since version 6.0.18.|
|Plugins.Mysql.Default.User|no| | |Default username for connecting to MySQL; used if no value is specified in an item key or named session.
Supported since version 6.0.18.|
|Plugins.Mysql.KeepAlive|no|60-900|300|The maximum time of waiting (in seconds) before unused plugin connections are closed.|
|Plugins.Mysql.Sessions..Password|no| | |Named session password.
**** - define name of a session for using in item keys.|
|Plugins.Mysql.Sessions..TLSCAFile|no
(yes, if Plugins.Mysql.Sessions..TLSConnect is set to *verify_ca* or *verify_full*)| | |Full pathname of a file containing the top-level CA(s) certificates for peer certificate verification, used for encrypted communications between Zabbix agent 2 and monitored databases.
**** - define name of a session for using in item keys.|
|Plugins.Mysql.Sessions..TLSCertFile|yes, if Plugins.Mysql.Sessions..TLSKeyFile is specified
Before version 6.0.23 always mandatory if Plugins.Mysql.Sessions..TLSConnect is set to *verify_ca* or *verify_full*| | |Full pathname of a file containing the agent certificate or certificate chain, used for encrypted communications between Zabbix agent 2 and monitored databases.
**** - define name of a session for using in item keys.|
|Plugins.Mysql.Sessions..TLSConnect|no| | |Encryption type for communications between Zabbix agent 2 and monitored databases.
**** - define name of a session for using in item keys.
Supported values:
*required* - require TLS connection;
*verify\_ca* - verify certificates;
*verify\_full* - verify certificates and IP address.|
|Plugins.Mysql.Sessions..TLSKeyFile|yes, if Plugins.Mysql.Sessions..TLSCertFile is specified
Before version 6.0.23 always mandatory if Plugins.Mysql.Sessions..TLSConnect is set to *verify_ca* or *verify_full*| | |Full pathname of a file containing the database private key used for encrypted communications between Zabbix agent 2 and monitored databases.
**** - define name of a session for using in item keys.|
|Plugins.Mysql.Sessions..Uri|no| | |Connection string of a named session.
**** - define name of a session for using in item keys.
Should not include embedded credentials (they will be ignored).
Must match the URI format.
Supported schemes: `tcp`, `unix`; a scheme can be omitted.
A port can be omitted (default=3306).
Examples: `tcp://localhost:3306`
`localhost`
`unix:/var/run/mysql.sock`|
|Plugins.Mysql.Sessions..User|no| | |Named session username.
**** - define name of a session for using in item keys.|
|Plugins.Mysql.Timeout|no|1-30|global timeout|The maximum time in seconds for waiting when a connection has to be established.|
See also:
- Description of general Zabbix agent 2 configuration parameters:
[Zabbix agent 2 (UNIX)](/manual/appendix/config/zabbix_agent2) /
[Zabbix agent 2
(Windows)](/manual/appendix/config/zabbix_agent2_win)
- Instructions for configuring [plugins](/manual/config/items/plugins)
[comment]: # ({/d41c94df-b9c98913})