MySQL's integration configuration settings

The MySQL integration is open source software. That means you can browse its source code and send improvements, or create your own fork and build it.

MySQL instance settings

The MySQL integration collects both Metrics and Inventory information. In the table, use the Applies to column for the settings available to each collection:

Setting

Description

Default

Applies to

HOSTNAME

Hostname or IP where MySQL is running.

localhost

Metrics/Inventory

PORT

Port on which MySQL server is listening.

3306

Metrics/Inventory

USERNAME

Username for accessing the MySQL server.

N/A

Metrics/Inventory

PASSWORD

Password for the given user.

N/A

Metrics/Inventory

SOCKET

Path to Unix socket file on which MySQL server is listening. Use this instead of Hostname/Port.

N/A

Metrics/Inventory

DATABASE

Name of the database to be monitored. If omitted all databases will be monitored.

N/A

Metrics/Inventory

ENABLE_TLS

Use TLS when communicating with the MySQL server.

false

Metrics/Inventory

INSECURE_SKIP_VERIFY

Disable server name verification when connecting over TLS.

false

Metrics/Inventory

OLD_PASSWORDS

Use old password hashing method.

false

Metrics/Inventory

EXTRA_CONNECTION_URL_ARGS

Specify extra connection parameters as attr1=val1&attr2=val2.

N/A

Metrics/Inventory

EXTENDED_METRICS

Captures an extended set of metrics. This also enables the capture of slave metrics.

false

Metrics

EXTENDED_INNODB_METRICS

Captures additional innodb metrics.

false

Metrics

EXTENDED_MY_ISAM_METRICS

Captures additional MyISAM metrics.

false

Metrics

REMOTE_MONITORING

Enable multi-tenancy monitoring.

Read more about remote monitoring.

true

Metrics/Inventory

METRICS

Set to true to enable metrics-only collection.

false

INVENTORY

Set to true to enable inventory-only collection.

false

The values for these settings can be defined in several ways:

  • Adding the value directly in the config file. This is the most common way.

  • Replacing the values from environment variables using the {{ }} notation. Read more about using environment variable passthroughs with on-host integrations or see the example for environment variables replacement.

    Important

    This requires infrastructure agent v1.14.0+.

  • Using secrets management. Use this to protect sensitive information, such as passwords that would be exposed in plain text on the configuration file. For more information, see secrets management.

Inventory

The MySQL integration captures the configuration parameters of the MySQL node returned by SHOW GLOBAL VARIABLES. The data is available on the Infrastructure inventory page, under the config/mysql source.

System metadata

The MySQL integration collects the following metadata attributes about your MySQL system:

Name

Description

software.edition

software.edition takes the value of the MySQL version_comment variable.

software.version

The MySQL server version.

cluster.nodeType

Either master or slave, depending on the role of the MySQL node being monitored.