Skip to content

Latest commit

 

History

History
260 lines (201 loc) · 13.4 KB

database_observability.mysql.md

File metadata and controls

260 lines (201 loc) · 13.4 KB
canonical description title labels
Learn about database_observability.mysql
database_observability.mysql
stage products
public-preview
oss

database_observability.mysql

{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}

Usage

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

Arguments

You can use the following arguments with database_observability.mysql:

Name Type Description Default Required
data_source_name secret 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 targets to scrape. yes
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
allow_update_performance_schema_settings boolean Whether to allow updates to performance_schema settings in any collector. false no

The following collectors are configurable:

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:

Block Description Required
cloud_provider Provide Cloud Provider information. no
cloud_provider > aws Provide AWS database host information. no
setup_consumers Configure the setup_consumers collector. no
setup_actors Configure the setup_actors collector. no
query_details Configure the queries collector. no
schema_details Configure the schema and table details collector. no
explain_plans Configure the explain plans collector. no
locks Configure the locks collector. no
query_samples Configure the query samples collector. no
health_check Configure the health check collector. no

The > symbol indicates deeper levels of nesting. For example, cloud_provider > aws refers to a aws block defined inside an cloud_provider block.

cloud_provider

The cloud_provider block has no attributes. It contains zero or more aws 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 identifier for the database being monitored.

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

setup_consumers

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

query_details

Name Type Description Default Required
collect_interval duration How frequently to collect information from database. "1m" no

schema_details

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

Name Type Description Default Required
collect_interval duration How frequently to collect information from database. "1m" no
explain_plan_exclude_schemas list(string) List of schemas to exclude from explain plan collection. 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

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

query_samples

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 Whether to enable some specific performance_schema.setup_consumers settings. false no
setup_consumers_check_interval duration How frequently to check if setup_consumers are correctly enabled. "1h" no

setup_actors

Name Type Description Default Required
auto_update_setup_actors boolean Whether to enable updating performance_schema.setup_actors settings. false no
collect_interval duration How frequently to check if setup_actors are configured correctly. "1h" no

health_checks

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

Example

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:

database_observability.mysql has exports that can be consumed by the following components:

{{< admonition type="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. {{< /admonition >}}