--- title: "prometheus.exporter.mysql | Grafana Agent documentation" description: "Learn about prometheus.exporter.mysql" --- > For a curated documentation index, see [llms.txt](/llms.txt). For the complete documentation index, see [llms-full.txt](/llms-full.txt). # prometheus.exporter.mysql The `prometheus.exporter.mysql` component embeds [mysqld\_exporter](https://github.com/prometheus/mysqld_exporter) for collecting stats from a MySQL server. ## Usage Alloy ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy ```alloy prometheus.exporter.mysql "LABEL" { data_source_name = DATA_SOURCE_NAME } ``` ## Arguments The following arguments can be used to configure the exporter’s behavior. All arguments are optional. Omitted fields take their default values. Expand table | Name | Type | Description | Default | Required | |----------------------|----------------|---------------------------------------------------------------------------------------------------------------------|---------|----------| | `data_source_name` | `secret` | [Data Source Name](https://github.com/go-sql-driver/mysql#dsn-data-source-name) for the MySQL server to connect to. | | yes | | `enable_collectors` | `list(string)` | A list of [collectors](#supported-collectors) to enable on top of the default set. | | no | | `disable_collectors` | `list(string)` | A list of [collectors](#supported-collectors) to disable from the default set. | | no | | `set_collectors` | `list(string)` | A list of [collectors](#supported-collectors) to run. Fully overrides the default set. | | no | | `lock_wait_timeout` | `int` | Timeout, in seconds, to acquire a metadata lock. | `2` | no | | `log_slow_filter` | `bool` | Used to avoid queries from scrapes being logged in the slow query log. | `false` | no | Set a `lock_wait_timeout` on the connection to avoid potentially long wait times for metadata locks. View more detailed documentation on `lock_wait_timeout` [in the MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_lock_wait_timeout). > **NOTE**: `log_slow_filter` is not supported by Oracle MySQL. ## Blocks The following blocks are supported inside the definition of `prometheus.exporter.mysql` to configure collector-specific options: Expand table | Hierarchy | Name | Description | Required | |-------------------------------|---------------------------------------------------------------------|----------------------------------------------------------|----------| | info\_schema.processlist | [info\_schema.processlist](#info_schemaprocesslist-block) | Configures the `info_schema.processlist` collector. | no | | info\_schema.tables | [info\_schema.tables](#info_schematables-block) | Configures the `info_schema.tables` collector. | no | | perf\_schema.eventsstatements | [perf\_schema.eventsstatements](#perf_schemaeventsstatements-block) | Configures the `perf_schema.eventsstatements` collector. | no | | perf\_schema.file\_instances | [perf\_schema.file\_instances](#perf_schemafile_instances-block) | Configures the `perf_schema.file_instances` collector. | no | | perf\_schema.memory\_events | [perf\_schema.memory\_events](#perf_schemamemory_events-block) | Configures the `perf_schema.memory_events` collector. | no | | heartbeat | [heartbeat](#heartbeat-block) | Configures the `heartbeat` collector. | no | | mysql.user | [mysql.user](#mysqluser-block) | Configures the `mysql.user` collector. | no | ### info\_schema.processlist block Expand table | Name | Type | Description | Default | Required | |---------------------|--------|------------------------------------------------------------|---------|----------| | `min_time` | `int` | Minimum time a thread must be in each state to be counted. | `0` | no | | `processes_by_user` | `bool` | Enable collecting the number of processes by user. | `true` | no | | `processes_by_host` | `bool` | Enable collecting the number of processes by host. | `true` | no | ### info\_schema.tables block Expand table | Name | Type | Description | Default | Required | |--------------------------------|----------|-------------------------------------------------------------------|---------|----------| | `info_schema_tables_databases` | `string` | Regular expression to match databases to collect table stats for. | `"*"` | no | ### perf\_schema.eventsstatements block Expand table | Name | Type | Description | Default | Required | |--------------|-------|------------------------------------------------------------------------------------|---------|----------| | `limit` | `int` | Limit the number of events statements digests, in descending order by `last_seen`. | `250` | no | | `time_limit` | `int` | Limit how old, in seconds, the `last_seen` events statements can be. | `86400` | no | | `text_limit` | `int` | Maximum length of the normalized statement text. | `120` | no | ### perf\_schema.file\_instances block Expand table | Name | Type | Description | Default | Required | |-----------------|----------|-------------------------------------------------------------------------------------|--------------------|----------| | `filter` | `string` | Regular expression to select rows in `performance_schema.file_summary_by_instance`. | `".*"` | no | | `remove_prefix` | `string` | Prefix to trim away from `file_name`. | `"/var/lib/mysql"` | no | View more detailed documentation on the tables used in `perf_schema_file_instances_filter` and `perf_schema_file_instances_remove_prefix` [in the MySQL documentation](https://dev.mysql.com/doc/mysql-perfschema-excerpt/8.0/en/performance-schema-file-summary-tables.html). ### perf\_schema.memory\_events block Expand table | Name | Type | Description | Default | Required | |-----------------|----------|------------------------------------------------------------------------------------|-------------|----------| | `remove_prefix` | `string` | Prefix to trim away from `performance_schema.memory_summary_global_by_event_name`. | `"memory/"` | no | ### heartbeat block Expand table | Name | Type | Description | Default | Required | |------------|----------|---------------------------------------------------------------------------------------|---------------|----------| | `database` | `string` | Database to collect heartbeat data from. | `"heartbeat"` | no | | `table` | `string` | Table to collect heartbeat data from. | `"heartbeat"` | no | | `utc` | `bool` | Use UTC for timestamps of the current server (`pt-heartbeat` is called with `--utc`). | `false` | no | ### mysql.user block Expand table | Name | Type | Description | Default | Required | |--------------|--------|------------------------------------------------------|---------|----------| | `privileges` | `bool` | Enable collecting user privileges from `mysql.user`. | `false` | no | ### Supported Collectors The full list of supported collectors is: Expand table | Name | Description | Enabled by default | |-------------------------------------------------------|----------------------------------------------------------------------------------------------|--------------------| | auto\_increment.columns | Collect `auto_increment` columns and max values from `information_schema`. | no | | binlog\_size | Collect the current size of all registered `binlog` files. | no | | engine\_innodb\_status | Collect metrics from `SHOW ENGINE INNODB STATUS`. | no | | engine\_tokudb\_status | Collect metrics from `SHOW ENGINE TOKUDB STATUS`. | no | | global\_status | Collect metrics from `SHOW GLOBAL STATUS`. | yes | | global\_variables | Collect metrics from `SHOW GLOBAL VARIABLES`. | yes | | heartbeat | Collect metrics from heartbeat database and tables. | no | | info\_schema.clientstats | If running with userstat=1, enable to collect client statistics. | no | | info\_schema.innodb\_cmpmem | Collect metrics from `information_schema.innodb_cmpmem`. | yes | | info\_schema.innodb\_metrics | Collect metrics from `information_schema.innodb_metrics`. | yes | | info\_schema.innodb\_tablespaces | Collect metrics from `information_schema.innodb_sys_tablespaces`. | no | | info\_schema.processlist | Collect current thread state counts from the `information_schema.processlist`. | no | | info\_schema.query\_response\_time | Collect query response time distribution if `query_response_time_stats` is ON. | yes | | info\_schema.replica\_host | Collect metrics from `information_schema.replica_host_status`. | no | | info\_schema.schemastats | If running with userstat=1, enable to collect schema statistics. | no | | info\_schema.tables | Collect metrics from `information_schema.tables`. | no | | info\_schema.tablestats | If running with userstat=1, enable to collect table statistics. | no | | info\_schema.userstats | If running with userstat=1, enable to collect user statistics. | no | | mysql.user | Collect data from `mysql.user`. | no | | perf\_schema.eventsstatements | Collect metrics from `performance_schema.events_statements_summary_by_digest`. | no | | perf\_schema.eventsstatementssum | Collect metrics of grand sums from `performance_schema.events_statements_summary_by_digest`. | no | | perf\_schema.eventswaits | Collect metrics from `performance_schema.events_waits_summary_global_by_event_name`. | no | | perf\_schema.file\_events | Collect metrics from `performance_schema.file_summary_by_event_name`. | no | | perf\_schema.file\_instances | Collect metrics from `performance_schema.file_summary_by_instance`. | no | | perf\_schema.indexiowaits | Collect metrics from `performance_schema.table_io_waits_summary_by_index_usage`. | no | | perf\_schema.memory\_events | Collect metrics from `performance_schema.memory_summary_global_by_event_name`. | no | | perf\_schema.replication\_applier\_status\_by\_worker | Collect metrics from `performance_schema.replication_applier_status_by_worker`. | no | | perf\_schema.replication\_group\_member\_stats | Collect metrics from `performance_schema.replication_group_member_stats`. | no | | perf\_schema.replication\_group\_members | Collect metrics from `performance_schema.replication_group_members`. | no | | perf\_schema.tableiowaits | Collect metrics from `performance_schema.table_io_waits_summary_by_table`. | no | | perf\_schema.tablelocks | Collect metrics from `performance_schema.table_lock_waits_summary_by_table`. | no | | slave\_hosts | Scrape information from `SHOW SLAVE HOSTS`. | no | | slave\_status | Scrape information from `SHOW SLAVE STATUS`. | yes | ## Exported fields The following fields are exported and can be referenced by other components. Expand table | Name | Type | Description | |-----------|---------------------|-----------------------------------------------------------| | `targets` | `list(map(string))` | The targets that can be used to collect exporter metrics. | For example, the `targets` can either be passed to a `discovery.relabel` component to rewrite the targets’ label sets or to a `prometheus.scrape` component that collects the exposed metrics. The exported targets use the configured [in-memory traffic](/docs/agent/latest/flow/concepts/component_controller/#in-memory-traffic) address specified by the [run command](/docs/agent/latest/flow/reference/cli/run/). ## Component health `prometheus.exporter.mysql` is only reported as unhealthy if given an invalid configuration. In those cases, exported fields retain their last healthy values. ## Debug information `prometheus.exporter.mysql` does not expose any component-specific debug information. ## Debug metrics `prometheus.exporter.mysql` does not expose any component-specific debug metrics. ## Example This example uses a [`prometheus.scrape` component](../prometheus.scrape/) to collect metrics from `prometheus.exporter.mysql`: Alloy ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy ```alloy prometheus.exporter.mysql "example" { data_source_name = "root@(server-a:3306)/" enable_collectors = ["heartbeat", "mysql.user"] } // Configure a prometheus.scrape component to collect mysql metrics. prometheus.scrape "demo" { targets = prometheus.exporter.mysql.example.targets forward_to = [prometheus.remote_write.demo.receiver] } prometheus.remote_write "demo" { endpoint { url = PROMETHEUS_REMOTE_WRITE_URL basic_auth { username = USERNAME password = PASSWORD } } } ``` Replace the following: - `PROMETHEUS_REMOTE_WRITE_URL`: The URL of the Prometheus remote\_write-compatible server to send metrics to. - `USERNAME`: The username to use for authentication to the remote\_write API. - `PASSWORD`: The password to use for authentication to the remote\_write API. ## Compatible components `prometheus.exporter.mysql` has exports that can be consumed by the following components: - Components that consume [Targets](../../compatibility/#targets-consumers) > Note > > Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details.