Docs » Available host and application monitors » Configure application receivers for databases » MySQL

MySQL 🔗

The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the MySQL monitor type to retrieve metrics and logs from MySQL.

This monitor connects to a MySQL instance and reports on the values returned by a SHOW STATUS command, which include the following:

  • Number of commands processed

  • Table and row operations (handlers)

  • State of the query cache

  • Status of MySQL threads

  • Network traffic

This integration is only available on Kubernetes and Linux.

Benefits 🔗

After you configure the integration, you can access these features:

  • View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Observability Cloud.

  • View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Splunk Infrastructure Monitoring navigators.

  • Access the Metric Finder and search for metrics sent by the monitor. For information, see Use the Metric Finder.

Installation 🔗

Follow these steps to deploy this integration:

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

  2. Configure the monitor, as described in the Configuration section.

  3. Restart the Splunk Distribution of OpenTelemetry Collector.

Creating a MySQL user for this monitor 🔗

To create a MySQL user for this monitor, run the following commands:

 CREATE USER '<username>'@'localhost' IDENTIFIED BY '<password>';
 -- Give appropriate permissions
 -- ("GRANT USAGE" is synonymous to "no privileges")
 GRANT USAGE ON *.* TO '<username>'@'localhost';
 -- Permissions for the stats options
 GRANT REPLICATION CLIENT ON *.* TO '<username>'@'localhost';

The new user only has enough privileges to connect to the database. Additional privileges are not required.

Considerations on localhost 🔗

For connections to localhost, MySQL programs attempt to connect to the local server by using a Unix socket file. To ensure that the client makes a TCP/IP connection to the local server specify a host name value of 127.0.0.1, or the IP address or name of the local server.

Configuration 🔗

To use this integration of a Smart Agent monitor with the Collector:

  1. Include the Smart Agent receiver in your configuration file.

  2. Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.

Example 🔗

To activate this integration, add the following to your Collector configuration:

receivers:
  smartagent/mysql:
    type: collectd/mysql
    host: 127.0.0.1
    port: 3306
    username: <global-username-for-all-db>
    password: <global-password-for-all-db>
    databases:
      - name: <name-of-db>
        username: <username> #Overrides global username
        password: <password> #Overrides global password

The following is a sample YAML configuration that shows how to connect multiple MySQL databases:

receivers:
  smartagent/mysql:
    type: collectd/mysql
    host: 127.0.0.1
    port: 3306
    databases:
      - name: <name>
        username: <username>
        password: <password>
      - name: <name>
        username: <username>
        password: <password>

Next, add the monitor to the service > pipelines > metrics > receivers section of your configuration file:

service:
  pipelines:
    metrics:
      receivers: [smartagent/mysql]
    logs:
      receivers: [smartagent/mysql]

Configuration settings 🔗

The following table shows the configuration options for this monitor:

Option

Required

Type

Description

host

Yes

string

Hostname or IP address of the MySQL instance. For example, 127.0.0.1.

port

Yes

integer

The port of the MySQL instance. For example, 3306.

databases

Yes

list of objects

A list of databases along with optional authentication credentials.

username

No

string

Username for all databases. You can override it by defining each username in the databases object.

password

No

string

Password for all databases. You can override it by defining each username in the databases object.

reportHost

No

bool

When set to true, the host dimension is set to the name of the MySQL database host. When false, the monitor uses the global hostname configuration instead. The default value is false. When disableHostDimensions is set to true, the host name in which the agent or monitor is running is not used for the host metric dimension value.

innodbStats

No

bool

Collects InnoDB statistics. Before activating InnoDB metrics make sure that you granted the PROCESS privilege to your user. The default value is false.

The nested databases configuration object has the following fields:

Option

Required

Type

Description

name

Yes

string

Name of the database.

username

No

string

Username of the database.

password

No

string

Password of the database.

Metrics 🔗

The following metrics are available for this integration:

Notes 🔗

  • Learn more about the available metric types in Observability Cloud.

  • Default metrics are those metrics included in host-based subscriptions in Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See more about metric categories.

  • To add additional metrics, see how to configure extraMetrics using the Collector.

Troubleshooting 🔗

If you are not able to see your data in Splunk Observability Cloud, try these tips:

To learn about even more support options, see Splunk Customer Success.