MySQL receiver 🔗

The MySQL receiver queries and retrieves metrics about MySQL’s global status and InnoDB tables. The supported pipeline type is metrics. See Process your data with pipelines for more information.

Prerequisites and requirements 🔗

This receiver supports MySQL version 8.0.

Requirements to collect metrics 🔗

The following applies:

To collect most metrics, you need to be able to execute SHOW GLOBAL STATUS.
Some metrics don’t appear if their corresponding feature is inactive.
To collect optional metrics you must specify them your configuration.

For the full list of available metrics, see Metrics.

Get started 🔗

Follow these steps to configure and activate the component:

Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:

Install the Collector for Linux with the installer script

Install the Collector for Windows with the installer script

Install the Collector for Kubernetes using Helm

Configure the MySQL receiver as described in the next section.
Restart the Collector.

Sample configuration 🔗

To activate the receiver, add mysql to the receivers section of your configuration file:

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

Next, include the receiver in the metrics pipeline of the service section of your configuration file:

service:
  pipelines:
    metrics:
      receivers:
        - mysql

The following settings are optional:

endpoint. localhost:3306 by default.
tls. Defines the TLS configuration to use. If tls is not set, the default is to disable TLS connections.
- insecure. false by default. Set to true to disable TLS connections.
- insecure_skip_verify. false by default. Set to true to enable TLS but not verify the certificate.
- server_name_override. Use this to set the ServerName in the TLSConfig.
username. root by default.
password. The password to the username.
allow_native_passwords. true by default.
database. The database name. If unspecified, metrics are collected for all databases.

collection_interval. 10s by default. Sets the interval this receiver collects metrics on.
- This value must be a string readable by Golang’s time.ParseDuration. Learn more at Go’s official documentation ParseDuration function .
- Valid time units are ns, us (or µs), ms, s, m, h.

initial_delay. 1s by default. Determines how long this receiver waits before collecting metrics for the first time.

transport. tcp by default. Defines the network to use to connect to the server.
statement_events. Additional configuration for the queries that build mysql.statement_events.count and mysql.statement_events.wait.time metrics:
- digest_text_limit. 120 by default. Maximum length of digest_text. Longer text is truncated.
- time_limit. 24h by default. Maximum time from since the statements have been observed last time.
- limit. 250 by default. Limit of records, which is maximum number of generated metrics.

Settings 🔗

The following table shows the configuration options for the MySQL receiver:

Metrics 🔗

The following metrics, resource attributes, and attributes, are available.

Activate or deactivate specific metrics 🔗

You can activate or deactivate specific metrics by setting the enabled field in the metrics section for each metric. For example:

receivers:
  samplereceiver:
    metrics:
      metric-one:
        enabled: true
      metric-two:
        enabled: false

The following is an example of host metrics receiver configuration with activated metrics:

receivers:
  hostmetrics:
    scrapers:
      process:
        metrics:
          process.cpu.utilization:
            enabled: true

Note

Deactivated metrics aren’t sent to Splunk Observability Cloud.

Billing 🔗

If you’re in a MTS-based subscription, all metrics count towards metrics usage.
If you’re in a host-based plan, metrics listed as active (Active: Yes) on this document are considered default and are included free of charge.

Learn more at Infrastructure Monitoring subscription usage (Host and metric plans).

Troubleshooting 🔗

If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.

Available to Splunk Observability Cloud customers

Submit a case in the Splunk Support Portal .
Contact Splunk Support .

Available to prospective customers and free trial users

Ask a question and get answers through community support at Splunk Answers .
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups in the Get Started with Splunk Community manual.

This page was last updated on Dec 12, 2024.

Related Topics