Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/percona/mysqld_exporter
Exporter for MySQL server metrics
https://github.com/percona/mysqld_exporter
hacktoberfest observability pmm
Last synced: 2 months ago
JSON representation
Exporter for MySQL server metrics
- Host: GitHub
- URL: https://github.com/percona/mysqld_exporter
- Owner: percona
- License: apache-2.0
- Fork: true (prometheus/mysqld_exporter)
- Created: 2016-08-22T05:22:36.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-11-11T13:58:08.000Z (2 months ago)
- Last Synced: 2024-11-11T14:30:48.837Z (2 months ago)
- Topics: hacktoberfest, observability, pmm
- Language: Go
- Homepage: http://prometheus.io
- Size: 12.6 MB
- Stars: 66
- Watchers: 18
- Forks: 43
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-pmm - Percona MySQL Exporter - Prometheus exporter for MySQL server metrics. (Exporters / Percona)
README
# MySQL Server Exporter [][travis]
[][circleci]
[][quay]
[][hub]
[](https://goreportcard.com/report/github.com/prometheus/mysqld_exporter)
Prometheus exporter for MySQL server metrics.
Supported versions:
* MySQL >= 5.6.
* MariaDB >= 10.3
NOTE: Not all collection methods are supported on MySQL/MariaDB < 5.6
## Building and running
### Required Grants
```sql
CREATE USER 'exporter'@'localhost' IDENTIFIED BY 'XXXXXXXX' WITH MAX_USER_CONNECTIONS 3;
GRANT PROCESS, REPLICATION CLIENT, SELECT ON *.* TO 'exporter'@'localhost';
```
NOTE: It is recommended to set a max connection limit for the user to avoid overloading the server with monitoring scrapes under heavy load. This is not supported on all MySQL/MariaDB versions; for example, MariaDB 10.1 (provided with Ubuntu 18.04) [does _not_ support this feature](https://mariadb.com/kb/en/library/create-user/#resource-limit-options).
### Build
make
### Running
Running using an environment variable:
export DATA_SOURCE_NAME='user:password@(hostname:3306)/'
./mysqld_exporter
Running using ~/.my.cnf:
./mysqld_exporter
Example format for flags for version > 0.10.0:
--collect.auto_increment.columns
--no-collect.auto_increment.columns
Example format for flags for version <= 0.10.0:
-collect.auto_increment.columns
-collect.auto_increment.columns=[true|false]
### Collector Flags
Name | MySQL Version | Description
-------------------------------------------------------------|---------------|------------------------------------------------------------------------------------
collect.auto_increment.columns | 5.1 | Collect auto_increment columns and max values from information_schema.
collect.binlog_size | 5.1 | Collect the current size of all registered binlog files
collect.engine_innodb_status | 5.1 | Collect from SHOW ENGINE INNODB STATUS.
collect.engine_tokudb_status | 5.6 | Collect from SHOW ENGINE TOKUDB STATUS.
collect.global_status | 5.1 | Collect from SHOW GLOBAL STATUS (Enabled by default)
collect.global_variables | 5.1 | Collect from SHOW GLOBAL VARIABLES (Enabled by default)
collect.plugins | 5.1 | Collect from SHOW PLUGINS
collect.info_schema.clientstats | 5.5 | If running with userstat=1, set to true to collect client statistics.
collect.info_schema.innodb_metrics | 5.6 | Collect metrics from information_schema.innodb_metrics.
collect.info_schema.innodb_tablespaces | 5.7 | Collect metrics from information_schema.innodb_sys_tablespaces.
collect.info_schema.innodb_cmp | 5.5 | Collect InnoDB compressed tables metrics from information_schema.innodb_cmp.
collect.info_schema.innodb_cmpmem | 5.5 | Collect InnoDB buffer pool compression metrics from information_schema.innodb_cmpmem.
collect.info_schema.processlist | 5.1 | Collect thread state counts from information_schema.processlist.
collect.info_schema.processlist.min_time | 5.1 | Minimum time a thread must be in each state to be counted. (default: 0)
collect.info_schema.query_response_time | 5.5 | Collect query response time distribution if query_response_time_stats is ON.
collect.info_schema.replica_host | 5.6 | Collect metrics from information_schema.replica_host_status.
collect.info_schema.tables | 5.1 | Collect metrics from information_schema.tables.
collect.info_schema.tables.databases | 5.1 | The list of databases to collect table stats for, or '`*`' for all.
collect.info_schema.tablestats | 5.1 | If running with userstat=1, set to true to collect table statistics.
collect.info_schema.schemastats | 5.1 | If running with userstat=1, set to true to collect schema statistics
collect.info_schema.userstats | 5.1 | If running with userstat=1, set to true to collect user statistics.
collect.mysql.user | 5.5 | Collect data from mysql.user table
collect.perf_schema.eventsstatements | 5.6 | Collect metrics from performance_schema.events_statements_summary_by_digest.
collect.perf_schema.eventsstatements.digest_text_limit | 5.6 | Maximum length of the normalized statement text. (default: 120)
collect.perf_schema.eventsstatements.limit | 5.6 | Limit the number of events statements digests by response time. (default: 250)
collect.perf_schema.eventsstatements.timelimit | 5.6 | Limit how old the 'last_seen' events statements can be, in seconds. (default: 86400)
collect.perf_schema.eventsstatementssum | 5.7 | Collect metrics from performance_schema.events_statements_summary_by_digest summed.
collect.perf_schema.eventswaits | 5.5 | Collect metrics from performance_schema.events_waits_summary_global_by_event_name.
collect.perf_schema.file_events | 5.6 | Collect metrics from performance_schema.file_summary_by_event_name.
collect.perf_schema.file_instances | 5.5 | Collect metrics from performance_schema.file_summary_by_instance.
collect.perf_schema.file_instances.remove_prefix | 5.5 | Remove path prefix in performance_schema.file_summary_by_instance.
collect.perf_schema.indexiowaits | 5.6 | Collect metrics from performance_schema.table_io_waits_summary_by_index_usage.
collect.perf_schema.memory_events | 5.7 | Collect metrics from performance_schema.memory_summary_global_by_event_name.
collect.perf_schema.memory_events.remove_prefix | 5.7 | Remove instrument prefix in performance_schema.memory_summary_global_by_event_name.
collect.perf_schema.tableiowaits | 5.6 | Collect metrics from performance_schema.table_io_waits_summary_by_table.
collect.perf_schema.tablelocks | 5.6 | Collect metrics from performance_schema.table_lock_waits_summary_by_table.
collect.perf_schema.replication_group_members | 5.7 | Collect metrics from performance_schema.replication_group_members.
collect.perf_schema.replication_group_member_stats | 5.7 | Collect metrics from performance_schema.replication_group_member_stats.
collect.perf_schema.replication_applier_status_by_worker | 5.7 | Collect metrics from performance_schema.replication_applier_status_by_worker.
collect.slave_status | 5.1 | Collect from SHOW SLAVE STATUS (Enabled by default)
collect.slave_hosts | 5.1 | Collect from SHOW SLAVE HOSTS
collect.heartbeat | 5.1 | Collect from [heartbeat](#heartbeat).
collect.heartbeat.database | 5.1 | Database from where to collect heartbeat data. (default: heartbeat)
collect.heartbeat.table | 5.1 | Table from where to collect heartbeat data. (default: heartbeat)
collect.heartbeat.utc | 5.1 | Use UTC for timestamps of the current server (`pt-heartbeat` is called with `--utc`). (default: false)
### General Flags
Name | Description
-------------------------------------------|--------------------------------------------------------------------------------------------------
config.my-cnf | Path to .my.cnf file to read MySQL credentials from. (default: `~/.my.cnf`)
log.level | Logging verbosity (default: info)
exporter.lock_wait_timeout | Set a lock_wait_timeout (in seconds) on the connection to avoid long metadata locking. (default: 2)
exporter.log_slow_filter | Add a log_slow_filter to avoid slow query logging of scrapes. NOTE: Not supported by Oracle MySQL.
tls.insecure-skip-verify | Ignore tls verification errors.
web.config.file | Path to a [web configuration file](#tls-and-basic-authentication)
web.listen-address | Address to listen on for web interface and telemetry.
web.telemetry-path | Path under which to expose metrics.
version | Print the version information.
## TLS and basic authentication
The MySQLd Exporter supports TLS and basic authentication.
To use TLS and/or basic authentication, you need to pass a configuration file
using the `--web.config.file` parameter. The format of the file is described
[in the exporter-toolkit repository](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md).
### Setting the MySQL server's data source name
The MySQL server's [data source name](http://en.wikipedia.org/wiki/Data_source_name)
must be set via the `DATA_SOURCE_NAME` environment variable.
The format of this variable is described at https://github.com/go-sql-driver/mysql#dsn-data-source-name.
## Customizing Configuration for a SSL Connection
If The MySQL server supports SSL, you may need to specify a CA truststore to verify the server's chain-of-trust. You may also need to specify a SSL keypair for the client side of the SSL connection. To configure the mysqld exporter to use a custom CA certificate, add the following to the mysql cnf file:
```
ssl-ca=/path/to/ca/file
```
To specify the client SSL keypair, add the following to the cnf.
```
ssl-key=/path/to/ssl/client/key
ssl-cert=/path/to/ssl/client/cert
```
Customizing the SSL configuration is only supported in the mysql cnf file and is not supported if you set the mysql server's data source name in the environment variable DATA_SOURCE_NAME.
## Using Docker
You can deploy this exporter using the [prom/mysqld-exporter](https://registry.hub.docker.com/r/prom/mysqld-exporter/) Docker image.
For example:
```bash
docker network create my-mysql-network
docker pull prom/mysqld-exporter
docker run -d \
-p 9104:9104 \
--network my-mysql-network \
-e DATA_SOURCE_NAME="user:password@(hostname:3306)/" \
prom/mysqld-exporter
```
## heartbeat
With `collect.heartbeat` enabled, mysqld_exporter will scrape replication delay
measured by heartbeat mechanisms. [Pt-heartbeat][pth] is the
reference heartbeat implementation supported.
[pth]:https://www.percona.com/doc/percona-toolkit/2.2/pt-heartbeat.html
## Filtering enabled collectors
The `mysqld_exporter` will expose all metrics from enabled collectors by default. This is the recommended way to collect metrics to avoid errors when comparing metrics of different families.
For advanced use the `mysqld_exporter` can be passed an optional list of collectors to filter metrics. The `collect[]` parameter may be used multiple times. In Prometheus configuration you can use this syntax under the [scrape config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#).
```yaml
params:
collect[]:
- foo
- bar
```
This can be useful for having different Prometheus servers collect specific metrics from targets.
## Example Rules
There is a set of sample rules, alerts and dashboards available in the [mysqld-mixin](mysqld-mixin/)
[circleci]: https://circleci.com/gh/prometheus/mysqld_exporter
[hub]: https://hub.docker.com/r/prom/mysqld-exporter/
[travis]: https://travis-ci.org/prometheus/mysqld_exporter
[quay]: https://quay.io/repository/prometheus/mysqld-exporter
[parsetime]: https://github.com/go-sql-driver/mysql#parsetime