​

Mysql Receiver

​

Supported Telemetry

​

Overview

​

Prerequisites

​

Supported database versions

GRANT SELECT ON performance_schema.* TO <your-user>@'%';

GRANT SELECT ON performance_schema.* TO '<your-user>'@'%';
GRANT BACKUP_ADMIN ON *.* TO '<your-user>'@'%';

​

Configuration

• endpoint: (default = localhost:3306)
• tls: Defines the TLS configuration to use. If tls is not set, the default is to disable TLS connections.
  • insecure: (default = false) Set this to true to disable TLS connections.
  • insecure_skip_verify: (default = false) Set this to true to enable TLS but not verify the certificate.
  • server_name_override: This sets the ServerName in the TLSConfig.
• username: (default = root)
• password: A static MySQL password.
• db_auth: Component ID of a dbauth provider extension (for example aws_iam_db_auth). Mutually exclusive with password. Requires TLS (tls.insecure: false). RDS MySQL/Aurora MySQL only. Cleartext password auth (mysql_clear_password) is enabled automatically for IAM tokens over TLS.

extensions:
  aws_iam_db_auth:
    region: us-east-2

receivers:
  mysql:
    endpoint: my-database.example.com:3306
    username: monitor
    db_auth: aws_iam_db_auth
    tls:
      insecure: false

service:
  extensions: [aws_iam_db_auth]

• allow_native_passwords: (default = true)
• database: The database name. If not specified, metrics will be collected for all databases.
• collection_interval (default = 10s): This receiver collects metrics on an interval. This value must be a string readable by Golang’s time.ParseDuration. Valid time units are ns, us (or µs), ms, s, m, h.
• initial_delay (default = 1s): defines how long this receiver waits before starting.
• transport: (default = tcp): Defines the network to use for connecting to the server.
• statement_events: Additional configuration for query to build mysql.statement_events.count and mysql.statement_events.wait.time metrics:
  • digest_text_limit - maximum length of digest_text. Longer text will be truncated (default=120)
  • time_limit - maximum time from since the statements have been observed last time (default=24h)
  • limit - limit of records, which is maximum number of generated metrics (default=250)
• query_sample_collection: Additional configuration for query sample collection(db.server.query_sample event):
  • max_rows_per_query - maximum number of rows to collect per scrape (default=100)
• top_query_collection: Additional configuration for top queries collection (db.server.top_query event):
  • lookback_time (optional, example = 60, default = 2 * collection_interval): The time window (in seconds) in which to query for top queries.
    • Queries that finished execution outside the lookback window are not included in the collection. Increasing the lookback window will be useful for capturing long-running queries.
  • max_query_sample_count (optional, example = 5000, default = 1000): The maximum number of records to fetch in a single run.
  • top_query_count: (optional, example = 100, default = 200): The maximum number of active queries to report (to the next consumer) in a single run.
  • collection_interval: (optional, default = 60s): The interval at which top queries should be emitted by this receiver.
    • This value can only guarantee that the top queries are collected at most once in this interval.
      • For instance, you have global collection_interval set to 10s and top_query_collection.collection_interval set to 60s.
        • In this case, the default receiver scraper will still run every 10 seconds.
        • However, the top queries collection will only run after 60 seconds have passed since the last collection.
      • For instance, you have global collection_interval set to 10s and top_query_collection.collection_interval set to 5s.
        • In this case, top_query_collection.collection_interval will have no impact on the collection frequency, which will run every 10s.
  • query_plan_cache_size: (optional, default = 1000). The query plan cache size. Once we got query plan results from explain queries, we will store them in the cache. This defines the cache’s size for query plan.
  • query_plan_cache_ttl: (optional, example = 1m, default = 1h). How long until a query plan expires in the cache. The receiver will run an explain query to MySQL to get the query plan after it expires.

​

Example Configuration

receivers:
  mysql:
    endpoint: localhost:3306
    username: otel
    password: ${env:MYSQL_PASSWORD}
    database: otel
    collection_interval: 10s
    initial_delay: 1s
    statement_events:
      digest_text_limit: 120
      time_limit: 24h
      limit: 250

​

Resource attributes

receivers:
  mysql:
    resource_attributes:
      server.address:
        enabled: false
      server.port:
        enabled: false

​

Metrics

​

Logs

Note: MySQL stores user variable names in lowercase in performance_schema.user_variables_by_thread regardless of how the client spelled them. The JOIN condition VARIABLE_NAME = 'traceparent' therefore matches any case variation the client used (e.g. SET @TraceParent = '...' works identically to SET @traceparent = '...').

​

Query plan availability by version

​

Splitting the execution plan onto its own event

events:
  db.server.top_query:
    enabled: true
  db.server.query_sample:
    enabled: true
  db.server.query_plan:   # both events above lose their mysql.query_plan
    enabled: true

• One digest executed in several databases produces one record per database, since the plan is collected per database. performance_schema.events_statements_summary_by_digest is keyed on schema and digest, so such a digest also produces one db.server.top_query record per database, and db.namespace is what pairs each of those with its own plan.
• db.server.top_query reports the database as the schema_name the statement was summarized under, while db.server.query_sample reports the session’s current database. For one statement these can differ, so the same plan can appear under two db.namespace values across the two events.

​

MySQL Requirements to enable log collection

​

Enabling events_waits_current for lock-wait duration

​

Required privilege

GRANT SELECT ON performance_schema.* TO '<your-user>'@'%';
GRANT UPDATE ON performance_schema.setup_consumers TO '<your-user>'@'%';

​

Enabling the consumer

performance-schema-consumer-events-waits-current=ON

UPDATE performance_schema.setup_consumers
SET ENABLED = 'YES'
WHERE NAME = 'events_waits_current';

​

Metrics

​

Attributes

​

Resource Attributes

​

Configuration

​

Example Configuration

mysql:
  endpoint: localhost:3306
  username: otel
  password: ${env:MYSQL_PASSWORD}
  database: otel
  collection_interval: 10s
mysql/default_tls:
  endpoint: localhost:3306
  username: otel
  password: ${env:MYSQL_PASSWORD}
  database: otel
  collection_interval: 10s
  tls: # specified, but use default values
    server_name_override: localhost