MySQL Integration

Prerequisites

• The Middleware Host Agent is installed on the machine that will collect metrics. See the Installation Guide.

File-Based Authentication

1 Create Database Credentials

Create a .yaml file with your database credentials. If the DB isn’t password-protected, omit username/password.

Docker users: place the credentials file inside /var/log on the Agent host.

Example: /home/ubuntu/mysql-creds.yaml

1mysql:
2  endpoint: localhost:3306
3  username: <YOUR_USERNAME_FOR_MYSQL>
4  password: <YOUR_PASSWORD_FOR_MYSQL>

If you are using MariaDB, specify in the yaml like below:

1mysql/mariadb:
2  endpoint: localhost:3306
3  username: <YOUR_USERNAME_FOR_MARIADB>
4  password: <YOUR_PASSWORD_FOR_MARIADB>

Quick verify (optional): From the Agent host, confirm the DB is reachable with your creds:

1mysql -h <db-host> -P 3306 -u <user> -p'<pass>' -e "SELECT 1" && echo OK || echo FAIL

2 Access Integrations

In Middleware, go to Installations → All Integrations → MySQL.

3 Enable Integration

Select the host (where the Host Agent is running), paste the credential file path from Step 1, and Save.

User-Based Authentication

MySQL metrics are gathered from performance_schema, sys_schema, and server status variables. Create a non-root user with the required permissions.

1CREATE USER 'mw'@'%' IDENTIFIED BY '<PASSWORD>';
2-- or restrict to a specific host:
3-- CREATE USER 'mw'@'<hostaddr>' IDENTIFIED BY '<PASSWORD>';

1mysql -u mw --password='<PASSWORD>' -e "SHOW STATUS" | grep Uptime \
2&& echo "MySQL user - OK" || echo "Cannot connect to MySQL"

1GRANT REPLICATION CLIENT ON *.* TO 'mw'@'%';
2ALTER USER 'mw'@'%' WITH MAX_USER_CONNECTIONS 5;
3GRANT PROCESS ON *.* TO 'mw'@'%';
4GRANT SELECT ON performance_schema.* TO 'mw'@'%';

1GRANT SLAVE MONITOR ON *.* TO 'mw'@'%';

1mysql -u mw --password='<PASSWORD>' -e "SHOW SLAVE STATUS" \
2&& echo "MySQL grant - OK" || echo "Missing REPLICATION CLIENT grant"

Visualize Analytics

• Default MySQL Dashboard: A ready-to-use dashboard appears in Dashboard Builder after you enable the integration.
• Create MySQL Widget: In any dashboard, choose Add New Widget → mysql to see the full list of available metrics.

Alerts

Create alerts on any MySQL metric: choose Detection Method: Database, Database Type: MySQL, then pick a metric and set thresholds (e.g., slow queries, replica lag, handler errors).

Metrics Collected

Troubleshooting

Integrations menu is missing:

• Your account likely lacks Installation permissions. Ask an admin to grant the Installation permission in Settings.

Host Agent can’t read the credentials file (Docker)

• Ensure the YAML is inside /var/log on the Agent host and reference that exact path in Step 3.

Connection/authentication failures:

Test from the Agent host with the same creds:

1mysql -h <db-host> -P 3306 -u <user> -p'<pass>' -e "SELECT 1"

• Fix DNS/firewall/port or credentials if it fails.

User-based auth: grants incomplete

• Re-run the Check permissions command. If it prints “Missing REPLICATION CLIENT grant,” apply the grants in Step 2, and for MariaDB, also apply GRANT SLAVE MONITOR.

Only one node appears (replica setups)

• Add each instance you want to monitor (or ensure your endpoint points at the intended node). Metrics are collected per instance.