Mysqld Exporter Snap

This repository contains the source for an unofficial snap for the mysqld exporter for Prometheus.

Getting Started

To get started with the Mysqld Exporter, install the snap using snapd:

sudo snap install mysqld-exporter

You will need to create a local user in your mysql database that allows access for the mysql exporter. The following configuration should work:

CREATE USER 'exporter'@'localhost' IDENTIFIED BY 'XXXXXXXX' WITH MAX_USER_CONNECTIONS 3;
GRANT PROCESS, REPLICATION CLIENT, SELECT ON *.* TO 'exporter'@'localhost';

The mysqld-exporter is configured to run as a systemd service and can be managed either through the snap command or the normal systemd systemctl command.

For example, to view the services provided by the snap you can use the snap services mysqld-exporter command. To restart the mysqld-exporter service, you can use the sudo snap restart mysqld-exporter.mysqld-exporter command.

Configuration

The mysqld-exporter snap provides the following configuration variables that can be set via the snap set command:

• mysql.host - the host to connect to mysql on, defaults to localhost
• mysql.port - the port to connect to mysql on, defaults to 3306
• mysql.user - the username to use when connecting to mysql, defaults to exporter
• mysql.password - the password to use when connecting to mysql

By default, the exporter will collect all metrics from MySQL that are relevant except the metrics that require userstat=1. Metrics that are collected can be disabled by setting the collect.<group>.<metric> key to False using the snap cli. Setting these values to False will cause the exporter to start with the --no-collect.<group>.<metric> flag set.

Note: configuration keys in the snap use a hyphen ('-') instead of an underscore ('_')
for configuration keys. The hyphen is converted into an underscore when the exporter
is started.

These metrics are turned off by default and the operator must expressly opt in to collecting these stats by setting the userstat settings to True. These settings are:

• collect.info-schema.clientstats
• collect.info-schema.tablestats
• collect.info-schema.schemastats
• collect.info-schema.userstats

Build

$ sudo snap install snapcraft
$ snapcraft --use-lxd

Try

To try the snap that was built, you can install it locally:

$ sudo snap install --devmode ./mysqld-prometheus-exporter_x86_64.snap