---
title: "database_observability.mysql | Grafana Alloy documentation"
description: "Learn about database_observability.mysql"
---

# `database_observability.mysql`

`database_observability.mysql` connects to a MySQL database and collects observability data from the `performance_schema` and `information_schema`. The component collects query details, schema information, explain plans, query samples, and lock information. It forwards this data as log entries to Loki receivers and exports targets for Prometheus scraping.

## Usage

Alloy ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy

```alloy
database_observability.mysql "<LABEL>" {
  data_source_name = <DATA_SOURCE_NAME>
  forward_to       = [<LOKI_RECEIVERS>]
}
```

## Arguments

You can use the following arguments with `database_observability.mysql`:

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      |
| `forward_to`                               | `list(LogsReceiver)` | Where to forward log entries after processing.                                                                                                                |                                                                                                      | yes      |
| `targets`                                  | `list(map(string))`  | List of external targets to scrape.                                                                                                                           |                                                                                                      | no       |
| `disable_collectors`                       | `list(string)`       | A list of collectors to disable from the default set.                                                                                                         |                                                                                                      | no       |
| `enable_collectors`                        | `list(string)`       | A list of collectors to enable on top of the default set.                                                                                                     |                                                                                                      | no       |
| `exclude_schemas`                          | `list(string)`       | A list of schemas to exclude from monitoring.                                                                                                                 | `["alloydbadmin", "alloydbmetadata", "azure_maintenance", "azure_sys", "cloudsqladmin", "rdsadmin"]` | no       |
| `allow_update_performance_schema_settings` | `boolean`            | Whether to allow updates to `performance_schema` settings in any collector. Enable this in conjunction with other collector-specific settings where required. | `false`                                                                                              | no       |

The following collectors are configurable:

Expand table

| Name              | Description                                                  | Enabled by default |
|-------------------|--------------------------------------------------------------|--------------------|
| `query_details`   | Collect queries information.                                 | yes                |
| `schema_details`  | Collect schemas and tables from `information_schema`.        | yes                |
| `query_samples`   | Collect query samples.                                       | yes                |
| `setup_consumers` | Collect enabled `performance_schema.setup_consumers`.        | yes                |
| `setup_actors`    | Check and update `performance_schema.setup_actors` settings. | yes                |
| `locks`           | Collect queries that are waiting/blocking other queries.     | no                 |
| `explain_plans`   | Collect explain plans information.                           | yes                |

## Blocks

You can use the following blocks with `database_observability.mysql`:

No valid configuration blocks found.

### `cloud_provider`

The `cloud_provider` block has no attributes. It contains zero or more \[`aws`]\[aws], \[`azure`]\[azure], or \[`gcp`]\[gcp] blocks. You use the `cloud_provider` block to provide information related to the cloud provider that hosts the database under observation. This information is appended as labels to the collected metrics. The labels make it easier for you to filter and group your metrics.

### `aws`

The `aws` block supplies the [ARN](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html) identifier for the database being monitored.

Expand table

| Name  | Type     | Description                                             | Default | Required |
|-------|----------|---------------------------------------------------------|---------|----------|
| `arn` | `string` | The ARN associated with the database under observation. |         | yes      |

### `azure`

The `azure` block supplies the identifying information for the database being monitored.

Expand table

| Name              | Type     | Description                                          | Default | Required |
|-------------------|----------|------------------------------------------------------|---------|----------|
| `subscription_id` | `string` | The Subscription ID for your Azure account.          |         | yes      |
| `resource_group`  | `string` | The Resource Group that holds the database resource. |         | yes      |
| `server_name`     | `string` | The database server name.                            |         | no       |

### `gcp`

The `gcp` block supplies the identifying information for the GCP Cloud SQL database being monitored.

Expand table

| Name              | Type     | Description                                                                                                                 | Default | Required |
|-------------------|----------|-----------------------------------------------------------------------------------------------------------------------------|---------|----------|
| `connection_name` | `string` | The Cloud SQL instance connection name in the format `project:region:instance`, for example `my-project:us-central1:my-db`. |         | yes      |

### `setup_consumers`

Expand table

| Name               | Type       | Description                                                                                   | Default | Required |
|--------------------|------------|-----------------------------------------------------------------------------------------------|---------|----------|
| `collect_interval` | `duration` | How frequently to collect `performance_schema.setup_consumers` information from the database. | `"1h"`  | no       |

### `query_details`

Expand table

| Name               | Type       | Description                                          | Default | Required |
|--------------------|------------|------------------------------------------------------|---------|----------|
| `collect_interval` | `duration` | How frequently to collect information from database. | `"1m"`  | no       |
| `statements_limit` | `integer`  | Max number of recent queries to collect details for. | `250`   | no       |

### `schema_details`

Expand table

| Name               | Type       | Description                                          | Default | Required |
|--------------------|------------|------------------------------------------------------|---------|----------|
| `collect_interval` | `duration` | How frequently to collect information from database. | `"1m"`  | no       |
| `cache_enabled`    | `boolean`  | Whether to enable caching of table definitions.      | `true`  | no       |
| `cache_size`       | `integer`  | Cache size.                                          | `256`   | no       |
| `cache_ttl`        | `duration` | Cache TTL.                                           | `"10m"` | no       |

### `explain_plans`

Expand table

| Name                | Type       | Description                                                                     | Default | Required |
|---------------------|------------|---------------------------------------------------------------------------------|---------|----------|
| `collect_interval`  | `duration` | How frequently to collect information from database.                            | `"1m"`  | no       |
| `initial_lookback`  | `duration` | How far back to look for explain plan queries on the first collection interval. | `"24h"` | no       |
| `per_collect_ratio` | `float`    | Ratio of explain plan queries to collect per collect interval.                  | `1.0`   | no       |

### `locks`

Expand table

| Name               | Type       | Description                                                                            | Default | Required |
|--------------------|------------|----------------------------------------------------------------------------------------|---------|----------|
| `collect_interval` | `duration` | How frequently to collect information from database.                                   | `"30s"` | no       |
| `threshold`        | `duration` | Threshold for locks to be considered slow. Locks that exceed this duration are logged. | `"1s"`  | no       |

### `query_samples`

Expand table

| Name                             | Type       | Description                                                                                                                                   | Default | Required |
|----------------------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------|----------|
| `collect_interval`               | `duration` | How frequently to collect information from database.                                                                                          | `"10s"` | no       |
| `disable_query_redaction`        | `bool`     | Collect unredacted SQL query text including parameters.                                                                                       | `false` | no       |
| `auto_enable_setup_consumers`    | `boolean`  | Enables specific `performance_schema.setup_consumers` options. You must also enable `allow_update_performance_schema_settings`.               | `false` | no       |
| `setup_consumers_check_interval` | `duration` | How frequently to check if `setup_consumers` are correctly enabled.                                                                           | `"1h"`  | no       |
| `sample_min_duration`            | `duration` | Minimum duration for query samples to be collected. Set to “0s” to disable filtering and collect all samples regardless of their duration.    | `"0s"`  | no       |
| `wait_event_min_duration`        | `duration` | Minimum duration for a wait event to be collected. Set to “0s” to disable filtering and collect all wait events regardless of their duration. | `"1us"` | no       |

### `setup_actors`

Expand table

| Name                       | Type       | Description                                                                                                                     | Default | Required |
|----------------------------|------------|---------------------------------------------------------------------------------------------------------------------------------|---------|----------|
| `auto_update_setup_actors` | `boolean`  | Enables updates to `performance_schema.setup_actors` settings. You must also enable `allow_update_performance_schema_settings`. | `false` | no       |
| `collect_interval`         | `duration` | How frequently to check if `setup_actors` are configured correctly.                                                             | `"1h"`  | no       |

### `health_check`

Expand table

| Name               | Type       | Description                          | Default | Required |
|--------------------|------------|--------------------------------------|---------|----------|
| `collect_interval` | `duration` | How frequently to run health checks. | `"1h"`  | no       |

### `prometheus_exporter`

The `prometheus_exporter` block configures the embedded mysqld\_exporter scrapers. The `data_source_name` is inherited from the parent block.

Refer to [`prometheus.exporter.mysql`](../../prometheus/prometheus.exporter.mysql/) docs for the full list of supported arguments and sub-blocks.

## Example

Alloy ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy

```alloy
database_observability.mysql "orders_db" {
  data_source_name = "user:pass@tcp(mysql:3306)/"
  forward_to       = [loki.relabel.orders_db.receiver]
  targets          = prometheus.exporter.mysql.orders_db.targets

  enable_collectors = ["query_samples", "explain_plans"]

  cloud_provider {
    aws {
      arn = "your-rds-db-arn"
    }
  }
}

prometheus.exporter.mysql "orders_db" {
  data_source_name  = "user:pass@tcp(mysql:3306)/"
  enable_collectors = ["perf_schema.eventsstatements"]
}

loki.relabel "orders_db" {
  forward_to = [loki.write.logs_service.receiver]
  rule {
    target_label = "job"
    replacement  = "integrations/db-o11y"
  }
  rule {
    target_label = "instance"
    replacement  = "orders_db"
  }
}

discovery.relabel "orders_db" {
  targets = database_observability.mysql.orders_db.targets

  rule {
    target_label = "job"
    replacement  = "integrations/db-o11y"
  }
  rule {
    target_label = "instance"
    replacement  = "orders_db"
  }
}

prometheus.scrape "orders_db" {
  targets    = discovery.relabel.orders_db.targets
  job_name   = "integrations/db-o11y"
  forward_to = [prometheus.remote_write.metrics_service.receiver]
}

prometheus.remote_write "metrics_service" {
  endpoint {
    url = sys.env("<GRAFANA_CLOUD_HOSTED_METRICS_URL>")
    basic_auth {
      username = sys.env("<GRAFANA_CLOUD_HOSTED_METRICS_ID>")
      password = sys.env("<GRAFANA_CLOUD_RW_API_KEY>")
    }
  }
}

loki.write "logs_service" {
  endpoint {
    url = sys.env("<GRAFANA_CLOUD_HOSTED_LOGS_URL>")
    basic_auth {
      username = sys.env("<GRAFANA_CLOUD_HOSTED_LOGS_ID>")
      password = sys.env("<GRAFANA_CLOUD_RW_API_KEY>")
    }
  }
}
```

Replace the following:

- *`<GRAFANA_CLOUD_HOSTED_METRICS_URL>`* : The URL for your Grafana Cloud hosted metrics.
- *`<GRAFANA_CLOUD_HOSTED_METRICS_ID>`* : The user ID for your Grafana Cloud hosted metrics.
- *`<GRAFANA_CLOUD_RW_API_KEY>`* : Your Grafana Cloud API key.
- *`<GRAFANA_CLOUD_HOSTED_LOGS_URL>`* : The URL for your Grafana Cloud hosted logs.
- *`<GRAFANA_CLOUD_HOSTED_LOGS_ID>`* : The user ID for your Grafana Cloud hosted logs.

## Compatible components

`database_observability.mysql` can accept arguments from the following components:

- Components that export [Targets](../../../compatibility/#targets-exporters)
- Components that export [Loki `LogsReceiver`](../../../compatibility/#loki-logsreceiver-exporters)

`database_observability.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.