OS Manuals

/usr/bin/mysqld_exporter

Prometheus Exporter for MySQL server metrics

From prometheus-mysqld-exporter-fips 0.21.0-r1 (enterprise-packages), captured 2026-11-08 by running mysqld_exporter --help (exit 0). permalink

usage: mysqld_exporter [<flags>]


Flags:
  -h, --[no-]help                Show context-sensitive help (also try --help-long and --help-man).
      --web.telemetry-path="/metrics"
                                 Path under which to expose metrics.
      --timeout-offset=0.25      Offset to subtract from timeout in seconds.
      --config.my-cnf=".my.cnf"  Path to .my.cnf file to read MySQL credentials from.
      --mysqld.address="localhost:3306"
                                 Address to use for connecting to MySQL
      --mysqld.username=MYSQLD.USERNAME
                                 Hostname to use for connecting to MySQL
      --[no-]tls.insecure-skip-verify
                                 Ignore certificate and server verification when using a tls
                                 connection.
      --exporter.lock_wait_timeout=2
                                 Set a lock_wait_timeout (in seconds) on the connection to avoid
                                 long metadata locking.
      --[no-]exporter.enable_lock_wait_timeout
                                 Enable the lock_wait_timeout MySQL connection parameter.
      --[no-]exporter.log_slow_filter
                                 Add a log_slow_filter to avoid slow query logging of scrapes. NOTE:
                                 Not supported by Oracle MySQL.
      --exporter.query_timeout=0
                                 Per-scraper query timeout (in seconds). 0 disables the timeout.
      --exporter.max_open_connections=2
                                 Maximum number of open connections to the database per scrape.
                                 Must be >= 1.
      --collect.heartbeat.database="heartbeat"
                                 Database from where to collect heartbeat data
      --collect.heartbeat.table="heartbeat"
                                 Table from where to collect heartbeat data
      --[no-]collect.heartbeat.utc
                                 Use UTC for timestamps of the current server (`pt-heartbeat` is
                                 called with `--utc`)
      --collect.info_schema.processlist.min_time=0
                                 Minimum time a thread must be in each state to be counted
      --[no-]collect.info_schema.processlist.processes_by_user
                                 Enable collecting the number of processes by user
      --[no-]collect.info_schema.processlist.processes_by_host
                                 Enable collecting the number of processes by host
      --collect.info_schema.tables.databases="*"
                                 The list of databases to collect table stats for, or '*' for all
      --collect.perf_schema.eventsstatements.limit=250
                                 Limit the number of events statements digests by response time
      --collect.perf_schema.eventsstatements.timelimit=86400
                                 Limit how old the 'last_seen' events statements can be, in seconds
      --collect.perf_schema.eventsstatements.digest_text_limit=120
                                 Maximum length of the normalized statement text
      --collect.perf_schema.eventsstatements.exclude_schemas=COLLECT.PERF_SCHEMA.EVENTSSTATEMENTS.EXCLUDE_SCHEMAS ...
                                 Additional schema name to exclude (always excludes mysql,
                                 performance_schema, information_schema). Repeatable
      --collect.perf_schema.file_instances.filter=".*"
                                 RegEx file_name filter for
                                 performance_schema.file_summary_by_instance
      --collect.perf_schema.file_instances.remove_prefix="/var/lib/mysql/"
                                 Remove path prefix in performance_schema.file_summary_by_instance
      --collect.perf_schema.memory_events.remove_prefix="memory/"
                                 Remove instrument prefix in
                                 performance_schema.memory_summary_global_by_event_name
      --[no-]collect.mysql.user.privileges
                                 Enable collecting user privileges from mysql.user
      --[no-]web.systemd-socket  Use systemd socket activation listeners instead of port listeners
                                 (Linux only).
      --web.listen-address=:9104 ...
                                 Addresses on which to expose metrics and web interface. Repeatable
                                 for multiple addresses. Examples: `:9100` or `[::1]:9100` for http,
                                 `vsock://:9100` for vsock
      --web.config.file=""       Path to configuration file that can
                                 enable TLS or authentication. See:
                                 https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md
      --[no-]collect.global_status
                                 Collect from SHOW GLOBAL STATUS
      --[no-]collect.global_variables
                                 Collect from SHOW GLOBAL VARIABLES
      --[no-]collect.slave_status
                                 Collect from SHOW SLAVE STATUS
      --[no-]collect.info_schema.processlist
                                 Collect current thread state counts from the
                                 information_schema.processlist
      --[no-]collect.mysql.user  Collect data from mysql.user
      --[no-]collect.info_schema.tables
                                 Collect metrics from information_schema.tables
      --[no-]collect.info_schema.schema_size
                                 Collect the size of each schema from information_schema.tables
      --[no-]collect.info_schema.innodb_tablespaces
                                 Collect metrics from information_schema.innodb_sys_tablespaces
      --[no-]collect.info_schema.innodb_metrics
                                 Collect metrics from information_schema.innodb_metrics
      --[no-]collect.info_schema.innodb_trx
                                 Collect transaction counts and oldest transaction age from
                                 information_schema.innodb_trx
      --[no-]collect.auto_increment.columns
                                 Collect auto_increment columns and max values from
                                 information_schema
      --[no-]collect.binlog_size
                                 Collect the current size of all registered binlog files
      --[no-]collect.perf_schema.tableiowaits
                                 Collect metrics from
                                 performance_schema.table_io_waits_summary_by_table
      --[no-]collect.perf_schema.indexiowaits
                                 Collect metrics from
                                 performance_schema.table_io_waits_summary_by_index_usage
      --[no-]collect.perf_schema.tablelocks
                                 Collect metrics from
                                 performance_schema.table_lock_waits_summary_by_table
      --[no-]collect.perf_schema.eventsstatements
                                 Collect metrics from
                                 performance_schema.events_statements_summary_by_digest
      --[no-]collect.perf_schema.eventsstatementssum
                                 Collect metrics of grand sums from
                                 performance_schema.events_statements_summary_by_digest
      --[no-]collect.perf_schema.eventswaits
                                 Collect metrics from
                                 performance_schema.events_waits_summary_global_by_event_name
      --[no-]collect.perf_schema.file_events
                                 Collect metrics from performance_schema.file_summary_by_event_name
      --[no-]collect.perf_schema.file_instances
                                 Collect metrics from performance_schema.file_summary_by_instance
      --[no-]collect.perf_schema.memory_events
                                 Collect metrics from
                                 performance_schema.memory_summary_global_by_event_name
      --[no-]collect.perf_schema.replication_group_members
                                 Collect metrics from performance_schema.replication_group_members
      --[no-]collect.perf_schema.replication_group_member_stats
                                 Collect metrics from
                                 performance_schema.replication_group_member_stats
      --[no-]collect.perf_schema.replication_applier_status_by_worker
                                 Collect metrics from
                                 performance_schema.replication_applier_status_by_worker
      --[no-]collect.sys.user_summary
                                 Collect per user metrics from sys.x$user_summary. See
                                 https://dev.mysql.com/doc/refman/5.7/en/sys-user-summary.html for
                                 details
      --[no-]collect.info_schema.userstats
                                 If running with userstat=1, set to true to collect user statistics
      --[no-]collect.info_schema.clientstats
                                 If running with userstat=1, set to true to collect client
                                 statistics
      --[no-]collect.info_schema.tablestats
                                 If running with userstat=1, set to true to collect table statistics
      --[no-]collect.info_schema.schemastats
                                 If running with userstat=1, set to true to collect schema
                                 statistics
      --[no-]collect.info_schema.innodb_cmp
                                 Collect metrics from information_schema.innodb_cmp
      --[no-]collect.info_schema.innodb_cmpmem
                                 Collect metrics from information_schema.innodb_cmpmem
      --[no-]collect.info_schema.query_response_time
                                 Collect query response time distribution if
                                 query_response_time_stats is ON.
      --[no-]collect.engine_tokudb_status
                                 Collect from SHOW ENGINE TOKUDB STATUS
      --[no-]collect.engine_innodb_status
                                 Collect from SHOW ENGINE INNODB STATUS
      --[no-]collect.heartbeat   Collect from heartbeat
      --[no-]collect.slave_hosts
                                 Scrape information from 'SHOW SLAVE HOSTS'
      --[no-]collect.info_schema.replica_host
                                 Collect metrics from information_schema.replica_host_status
      --[no-]collect.info_schema.rocksdb_perf_context
                                 Collect metrics from information_schema.ROCKSDB_PERF_CONTEXT
      --log.level=info           Only log messages with the given severity or above. One of: [debug,
                                 info, warn, error]
      --log.format=logfmt        Output format of log messages. One of: [logfmt, json]
      --[no-]version             Show application version.
Options (24)
OptionDescriptionSource
-hShow context-sensitive help (also try --help-long and --help-man).help
--web.telemetry-path "/metrics"Path under which to expose metrics.help
--timeout-offset 0.25Offset to subtract from timeout in seconds.help
--config.my-cnf ".my.cnf"Path to .my.cnf file to read MySQL credentials from.help
--mysqld.address "localhost:3306"Address to use for connecting to MySQLhelp
--mysqld.username MYSQLD.USERNAMEHostname to use for connecting to MySQLhelp
--exporter.lock_wait_timeout 2Set a lock_wait_timeout (in seconds) on the connection to avoid long metadata locking.help
--exporter.query_timeout 0Per-scraper query timeout (in seconds).help
--exporter.max_open_connections 2Maximum number of open connections to the database per scrape.help
--collect.heartbeat.database "heartbeat"Database from where to collect heartbeat datahelp
--collect.heartbeat.table "heartbeat"Table from where to collect heartbeat datahelp
--collect.info_schema.processlist.min_time 0Minimum time a thread must be in each state to be countedhelp
--collect.info_schema.tables.databases "*"The list of databases to collect table stats for, or '*' for allhelp
--collect.perf_schema.eventsstatements.limit 250Limit the number of events statements digests by response timehelp
--collect.perf_schema.eventsstatements.timelimit 86400Limit how old the 'last_seen' events statements can be, in secondshelp
--collect.perf_schema.eventsstatements.digest_text_limit 120Maximum length of the normalized statement texthelp
--collect.perf_schema.eventsstatements.exclude_schemasAdditional schema name to exclude (always excludes mysql, performance_schema, information_schema).help
--collect.perf_schema.file_instances.filter ".*"RegEx file_name filter for performance_schema.file_summary_by_instancehelp
--collect.perf_schema.file_instances.remove_prefix "/var/lib/mysql/"Remove path prefix in performance_schema.file_summary_by_instancehelp
--collect.perf_schema.memory_events.remove_prefix "memory/"Remove instrument prefix in performance_schema.memory_summary_global_by_event_namehelp
--web.listen-address :9104Addresses on which to expose metrics and web interface.help
--web.config.file ""Path to configuration file that can enable TLS or authentication.help
--log.level infoOnly log messages with the given severity or above.help
--log.format logfmtOutput format of log messages.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.