MySQL plugin

MySQL is a relational database management system that runs as a server providing multi-user access to a number of databases. For more information visit

This functionality is only available for agents running on Linux. It is not available on Windows.


Even if the MySQL plugin is not configured, Monitoring will discover MySQL services running in your Cloud Platform project by:

  • Searching instance names for mysql
  • Checking for ports opened to 3306 via firewall rules

To see the metrics for MySQL, do the following:

  1. In the Google Cloud console, go to the  Dashboards page:

    Go to Dashboards

    If you use the search bar to find this page, then select the result whose subheading is Monitoring.

  2. Select the MySQL dashboard from the list.

Configuring MySQL monitoring

The Monitoring agent uses the Connector/C API to monitor MySQL. For Linux distributions that don't include the Connector/C library with MySQL, run the appropriate command to install it:

Ubuntu 16.04 LTS and Ubuntu 18.04 LTS

    sudo apt-get install libmysqlclient20

Ubuntu 19.10

    sudo apt-get install libmysqlclient21

Debian 9

    sudo apt-get install libmariadbclient18

Amazon AMI 2016.03 or later

    sudo yum install mysql-libs


    sudo zypper install libmysqlclient18


    sudo zypper install libmariadb3

Configuring Monitoring to monitor MySQL

After you install the monitoring agent, use the following instructions to configure the MySQL plugin on your instances.


For MySQL collection, you must add a user with a password to MySQL that can run the SHOW STATUS command. This user and password are referred to as STATS_USER and STATS_PASS in the following config file.

Enabling the MySQL monitoring plugin

MySQL is configured per database on your system. At the moment, no drop-in configuration is available. The following configuration file shows how to configure one database, named DATABASE_NAME. You would need to use that configuration as a template for your databases.

On your VM instance, download mysql.conf from the GitHub configuration repository and place it in the directory /etc/stackdriver/collectd.d/:

(cd /etc/stackdriver/collectd.d/ && sudo curl -O

As root, edit the downloaded configuration file and add information about your databases. Inline comments point out where you need to add configuration for additional databases. Wherever you see DATABASE_NAME, substitute the name of your database.

After editing the configuration file, restart the monitoring agent by running the following command:

sudo service stackdriver-agent restart

For more information on the collectd mysql plugin, see Plugin:MySQL.

What is monitored

The full list of metrics the MySQL plugin monitors is at Agent metrics: mysql.