Skip to main content

MySQL/MariaDB

Pack assets​

Templates​

The Monitoring Connector MySQL/MariaDB brings a host template:

  • App-DB-MySQL

The connector brings the following service templates (sorted by the host template they are attached to):

Service AliasService TemplateService Description
Connection-TimeApp-DB-MySQL-Connection-TimeCheck the connection time to the server. This time is given in seconds
Connections-NumberApp-DB-MySQL-Connections-NumberCheck the number of open connections
Database-SizeApp-DB-MySQL-Database-SizeCheck the size of databases. No alerts by default
Myisam-KeycacheApp-DB-MySQL-Myisam-KeycacheCheck the hit rate of the MyISAM tables
Open-FilesApp-DB-MySQL-Open-FilesCheck the number of files that currently are open
QueriesApp-DB-MySQL-QueriesCheck the average number of queries per second
SlowqueriesApp-DB-MySQL-SlowqueriesCheck the number of slow queries since the last check. Gives the average rate per second

The services listed above are created automatically when the App-DB-MySQL host template is used.

Collected metrics & status​

Here is the list of services for this connector, detailing all metrics linked to each service.

Metric nameUnit
backup status
backup_name#backup.time.last.execution.secondss

Prerequisites​

Listing of user privileges needed by service:

ServicePrivilegesDatabase
BackupSELECTmysql
Connection-TimeUSAGE
Connections-NumberUSAGE
Database-SizeSELECT
Innodb-BufferpoolUSAGE
Long-QueriesPROCESS
MariaDB-ReplicationPROCESS, REPLICATION CLIENT
Myisam-KeycacheUSAGE
Password-ExpirationSELECTmysql
Qcache-HitrateUSAGE
QueriesUSAGE
SlowqueriesUSAGE
UptimeUSAGE

Installing the monitoring connector​

Pack​

  1. If the platform uses an online license, you can skip the package installation instruction below as it is not required to have the connector displayed within the Configuration > Monitoring Connectors Manager menu. If the platform uses an offline license, install the package on the central server with the command corresponding to the operating system's package manager:
dnf install centreon-pack-applications-databases-mysql
  1. Whatever the license type (online or offline), install the MySQL/MariaDB connector through the Configuration > Monitoring Connectors Manager menu.

Plugin​

Since Centreon 22.04, you can benefit from the 'Automatic plugin installation' feature. When this feature is enabled, you can skip the installation part below.

You still have to manually install the plugin on the poller(s) when:

  • Automatic plugin installation is turned off
  • You want to run a discovery job from a poller that doesn't monitor any resource of this kind yet

More information in the Installing the plugin section.

Use the commands below according to your operating system's package manager:

dnf install centreon-plugin-Applications-Databases-Mysql

Using the monitoring connector​

Using a host template provided by the connector​

  1. Log into Centreon and add a new host through Configuration > Hosts.
  2. Fill the Name, Alias & IP Address/DNS fields according to your ressource settings.
  3. Apply the App-DB-MySQL-custom template to the host. A list of macros appears. Macros allow you to define how the connector will connect to the resource, and to customize the connector's behavior.
  4. Fill in the macros you want. Some macros are mandatory.
MacroDescriptionDefault valueMandatory
MYSQLPASSWORDPassword for the defined user namePASSWORDX
MYSQLPORTX
MYSQLUSERNAMEUser name used to connect to the databaseUSERNAMEX
MYSQLEXTRAOPTIONSAny extra option you may want to add to every command (E.g. a --verbose flag). All options are listed here
  1. Deploy the configuration. The host appears in the list of hosts, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the host: it shows the values of the macros.

Using a service template provided by the connector​

  1. If you have used a host template and checked Create Services linked to the Template too, the services linked to the template have been created automatically, using the corresponding service templates. Otherwise, create manually the services you want and apply a service template to them.
  2. Fill in the macros you want (e.g. to change the thresholds for the alerts). Some macros are mandatory (see the table below).
MacroDescriptionDefault valueMandatory
FILTERTYPEFilter backups by type (regexp can be used)
CRITICALSTATUSSet critical threshold for status (Default: '%{has_backup} eq "yes" and %{exit_state} ne "SUCCESS" and %{last_error} ne "NO_ERROR"'). You can use the following variables: %{has_backup}, %{last_error}, %{exit_state}, %{type}%{has_backup} eq "yes" and %{exit_state} ne "SUCCESS" and %{last_error} ne "NO_ERROR"
WARNINGSTATUSSet warning threshold for status. You can use the following variables: %{has_backup}, %{last_error}, %{exit_state}, %{type}
WARNINGTIMELASTEXECUTIONThresholds
CRITICALTIMELASTEXECUTIONThresholds
EXTRAOPTIONSAny extra option you may want to add to the command (E.g. a --verbose flag). All options are listed here--verbose
  1. Deploy the configuration. The service appears in the list of service, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the service: it shows the values of the macros.

How to check in the CLI that the configuration is OK and what are the main options for?​

Once the plugin is installed, log into your Centreon poller's CLI using the centreon-engine user account (su - centreon-engine). Test that the connector is able to monitor a server using a command like this one (replace the sample values by yours):

/usr/lib/centreon/plugins/centreon_mysql.pl \
    --plugin=database::mysql::plugin  \
    --host=10.0.0.1 \
    --username='myuser' \
    --password='mypass' \
    --port='3306'  \
    --mode=connection-time \
    --verbose

The expected command output is shown below:

OK: Connection established in 0.038s. | 'connection.time.milliseconds'=38ms;;;0;

Troubleshooting​

Please find the troubleshooting documentation for Centreon Plugins typical issues.

Available modes​

All available modes can be displayed by adding the --list-mode parameter to the command:

/usr/lib/centreon/plugins/centreon_mysql.pl \
    --plugin=database::mysql::plugin  \
    --list-mode

The plugin brings the following modes:

ModeLinked service template
backupApp-DB-MySQL-Backup
collectionNot used in this Monitoring Connector
connection-timeApp-DB-MySQL-Connection-Time
databases-sizeApp-DB-MySQL-Database-Size
innodb-bufferpool-hitrateApp-DB-MySQL-Innodb-Bufferpool
long-queriesApp-DB-MySQL-Long-Queries
myisam-keycache-hitrateApp-DB-MySQL-Myisam-Keycache
open-filesApp-DB-MySQL-Open-Files
password-expirationApp-DB-MySQL-Password-Expiration
qcache-hitrateApp-DB-MySQL-Qcache-Hitrate
queriesApp-DB-MySQL-Queries
replicationApp-DB-MySQL-MariaDB-Replication
slow-queriesApp-DB-MySQL-Slowqueries
sqlApp-DB-MySQL-Sql-Statement-Generic
sql-stringApp-DB-MySQL-Sql-Statement-String-Generic
threads-connectedApp-DB-MySQL-Connections-Number
uptimeApp-DB-MySQL-Uptime

Available options​

Generic options​

All generic options are listed here:

OptionDescriptionType
--modeDefine the mode in which you want the plugin to be executed (see--list-mode).Global
--dyn-modeSpecify a mode with the module's path (advanced).Global
--list-modeList all available modes.Global
--mode-versionCheck minimal version of mode. If not, unknown error.Global
--versionReturn the version of the plugin.Global
--sqlmodeThis plugin offers several ways to query the database (default: dbi). See --list-sqlmode.Global
--list-sqlmodeList all available sql modes.Global
--multipleEnable connecting to multiple databases (required by some specific modes such as replication).Global
--pass-managerDefine the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass.Global
--verboseDisplay extended status information (long output).Output
--debugDisplay debug messages.Output
--filter-perfdataFilter perfdata that match the regexp. Eg: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data.Output
--filter-perfdata-advFilter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %{variable} or %(variable). Eg: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value.Output
--explode-perfdata-maxCreate a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '_max' suffix). Eg: it will split 'used_prct'=26.93%;0:80;0:90;0;100 into 'used_prct'=26.93%;0:80;0:90;0;100 'used_prct_max'=100%;;;;Output
--change-perfdata --extend-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[m ax]] Common examples: Convert storage free perfdata into used: --change-perfdata=free,used,invert() Convert storage free perfdata into used: --change-perfdata=used,free,invert() Scale traffic values automatically: --change-perfdata=traffic,,scale(auto) Scale traffic values in Mbps: --change-perfdata=traffic_in,,scale(Mbps),mbps Change traffic values in percent: --change-perfdata=traffic_in,,percent()Output
--extend-perfdata-groupAdd new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation[,[ne wuom],[min],[max]] regex: regular expression namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated newuom (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets_wrong,sum(packets_(discard |error)_(in|out))' Sum traffic by interface: --extend-perfdata-group='traffic_in_(.*),traffic_$1,sum(traf fic_(in|out)_$1)'Output
--change-short-output --change-long-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Eg: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'Output
--change-exitReplace an exit code with one of your choice. Eg: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state.Output
--range-perfdataChange perfdata range thresholds display: 1 = start value equals to '0' is removed, 2 = threshold range is not display.Output
--filter-uomMasks the units when they don't match the given regular expression.Output
--opt-exitReplace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown.Output
--output-ignore-perfdataRemove all the metrics from the service. The service will still have a status and an output.Output
--output-ignore-labelRemove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Eg: 'OK: Ram Total:...' will become 'Ram Total:...'Output
--output-xmlReturn the output in XML format (to send to an XML API).Output
--output-jsonReturn the output in JSON format (to send to a JSON API).Output
--output-openmetricsReturn the output in OpenMetrics format (to send to a tool expecting this format).Output
--output-fileWrite output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt.Output
--disco-formatApplies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML).Output
--disco-showApplies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery.Output
--float-precisionDefine the float precision for thresholds (default: 8).Output
--source-encodingDefine the character encoding of the response sent by the monitored resource Default: 'UTF-8'.Output
--datasourceDatabase server information, mandatory if the server's address and port are not defined in the corresponding options. The syntax depends on the database type.Dbi
--usernameUser name used to connect to the database.Dbi
--passwordPassword for the defined user name.Dbi
--connect-optionsAdd connection options for the DBI connect method. Format: name=value,name2=value2,...Dbi
--connect-queryExecute a query just after the connection.Dbi
--sql-errors-exitExpected status in case of DB error or timeout. Possible values are warning, critical and unknown (default).Dbi
--timeoutTimeout in seconds for connection.Dbi
--exec-timeoutTimeout in seconds for query executionDbi

Modes options​

All modes specific options are listed here:

OptionDescriptionType
--filter-typeFilter backups by type (regexp can be used).Mode
--unknown-statusSet unknown threshold for status. You can use the following variables: %{has_backup}, %{last_error}, %{exit_state}, %{type}Mode
--warning-statusSet warning threshold for status. You can use the following variables: %{has_backup}, %{last_error}, %{exit_state}, %{type}Mode
--critical-statusSet critical threshold for status (Default: '%{has_backup} eq "yes" and %{exit_state} ne "SUCCESS" and %{last_error} ne "NO_ERROR"'). You can use the following variables: %{has_backup}, %{last_error}, %{exit_state}, %{type}Mode
--warning- --critical-Thresholds. Can be: 'time-last-execution'.Mode

All available options for a given mode can be displayed by adding the --help parameter to the command:

/usr/lib/centreon/plugins/centreon_mysql.pl \
    --plugin=database::mysql::plugin  \
    --host=10.0.0.1 \
    --help