MySQL

The MySQL integration collects performance metrics related to InnoDB, the buffer pool, and various other operations. It also collects general, error, and slow-query logs and parses them into a JSON payload. Error logs are parsed for their error code and subsystem. Slow-query logs are parsed into key-value pairs that describe the performance of a query, including query time and rows examined.

For more information about MySQL, see mysql.com .

Prerequisites

To collect MySQL telemetry, you must install Ops Agent version 2.8.0 or higher.

This receiver supports MySQL versions 5.7 and 8.0.

Configure your MySQL instance

The mysql receiver connects by default to a local MySQL server using a Unix socket and Unix authentication as the root user.

Configure the Ops Agent for MySQL

Following the guide for Configuring the Ops Agent, add the required elements to collect logs and metrics from your MySQL instances, and restart the agent.

Example configuration

The following commands create the configuration file to collect and ingest logs and metrics for MySQL and restarts the Ops Agent on Linux.

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    mysql:
      type: mysql
      username: root
      password: Ss123%321
  service:
    pipelines:
      mysql:
        receivers:
        - mysql
logging:
  receivers:
    mysql_error:
      type: mysql_error
    mysql_general:
      type: mysql_general
    mysql_slow:
      type: mysql_slow
  service:
    pipelines:
      mysql:
        receivers:
          - mysql_error
          - mysql_general
          - mysql_slow
EOF

sudo service google-cloud-ops-agent restart
sleep 60

To connect to your MySQL instance using a TCP connection with a username and password, specify the username and password in your metrics receiver. For example:

metrics:
  receivers:
    mysql:
      type: mysql
      endpoint: localhost:3306
      password: pwd
      username: usr
  service:
    pipelines:
      mysql:
        receivers:
          - mysql

Configure logs collection

To ingest logs from MySQL, you must create receivers for the logs MySQL produces and then create a pipeline for the new receivers.

To configure a receiver for your mysql_error logs, specify the following fields:

Field	Default	Description
`type`		This value must be `mysql_error`.
`include_paths`	`[/var/log/mysqld.log, /var/log/mysql/mysqld.log, /var/log/mysql/error.log]`	A list of filesystem paths to read by tailing each file. A wild card (``) can be used in the paths; for example, `/var/log/mysql/.log`.
`exclude_paths`	`[]`	A list of filesystem path patterns to exclude from the set matched by `include_paths`.
`record_log_file_path`	`false`	If set to `true`, then the path to the specific file from which the log record was obtained appears in the output log entry as the value of the `agent.googleapis.com/log_file_path` label. When using a wildcard, only the path of the file from which the record was obtained is recorded.
`wildcard_refresh_interval`	`60s`	The interval at which wildcard file paths in `include_paths` are refreshed. Given as a time duration, for example `30s` or `2m`. This property might be useful under high logging throughputs where log files are rotated faster than the default interval.

To configure a receiver for your mysql_general logs, specify the following fields:

Field	Default	Description
`type`		This value must be `mysql_general`.
`include_paths`	`[/var/lib/mysql/${HOSTNAME}.log]`	The log files to read.
`exclude_paths`	`[]`	A list of filesystem path patterns to exclude from the set matched by `include_paths`.
`record_log_file_path`	`false`	If set to `true`, then the path to the specific file from which the log record was obtained appears in the output log entry as the value of the `agent.googleapis.com/log_file_path` label. When using a wildcard, only the path of the file from which the record was obtained is recorded.
`wildcard_refresh_interval`	`60s`	The interval at which wildcard file paths in `include_paths` are refreshed. Given as a time duration, for example `30s` or `2m`. This property might be useful under high logging throughputs where log files are rotated faster than the default interval.

To configure a receiver for your mysql_slow logs, specify the following fields:

Field	Default	Description
`type`		This value must be `mysql_slow`.
`include_paths`	`[/var/lib/mysql/${HOSTNAME}-slow.log]`	The log files to read.
`exclude_paths`	`[]`	A list of filesystem path patterns to exclude from the set matched by `include_paths`.
`record_log_file_path`	`false`	If set to `true`, then the path to the specific file from which the log record was obtained appears in the output log entry as the value of the `agent.googleapis.com/log_file_path` label. When using a wildcard, only the path of the file from which the record was obtained is recorded.
`wildcard_refresh_interval`	`60s`	The interval at which wildcard file paths in `include_paths` are refreshed. Given as a time duration, for example `30s` or `2m`. This property might be useful under high logging throughputs where log files are rotated faster than the default interval.

What is logged

The logName of the mysql_error, mysql_general, and mysql_slow logs are derived from the receiver IDs specified in the configuration.

Depending on your MySQL version, mysql_error logs might contain the following fields inside the LogEntry:

Field	Type	Description
`jsonPayload.level`	string	Log entry level
`jsonPayload.tid`	number	Thread ID where the log originated
`jsonPayload.errorCode`	string	MySQL error code associated with the log
`jsonPayload.subsystem`	string	MySQL subsystem where the log originated
`jsonPayload.message`	string	Log message
`severity`	string (`LogSeverity`)	Log entry level (translated)
`timestamp`	string (`Timestamp`)	Time the request was received

Any fields that are blank or missing will not be present in the log entry.

mysql_general logs contain the following fields in the LogEntry:

Field	Type	Description
`jsonPayload.tid`	number	Thread ID where the log originated
`jsonPayload.command`	string	Type of database action being logged
`jsonPayload.message`	string	Log of the database action
`timestamp`	string (`Timestamp`)	Time the entry was logged

mysql_slow logs contain the following fields in the LogEntry:

Field	Type	Description
`jsonPayload.user`	string	User that executed the query
`jsonPayload.database`	string	Database where the query was executed
`jsonPayload.host`	string	Host of the database instance
`jsonPayload.ipAddress`	string	Address of the database instance
`jsonPayload.tid`	number	Thread ID where the query was logged
`jsonPayload.queryTime`	number	The statement execution time in seconds
`jsonPayload.lockTime`	number	The time to acquire locks in seconds
`jsonPayload.rowsSent`	number	The number of rows sent to the client
`jsonPayload.rowsExamined`	number	The number of rows examined by the server layer
`jsonPayload.errorNumber`^†	number	The statement error number, or 0 if no error occurred
`jsonPayload.killed`^†	number	If the statement was terminated, the error number indicating why, or 0 if the statement terminated normally
`jsonPayload.bytesReceived`^†	number	The number of bytes received from all clients
`jsonPayload.bytesSent`^†	number	The number of bytes sent to all clients
`jsonPayload.readFirst`^†	number	The number of times the first entry in an index was read
`jsonPayload.readLast`^†	number	The number of requests to read the last key in an index
`jsonPayload.readKey`^†	number	The number of requests to read a row based on a key
`jsonPayload.readNext`^†	number	The number of requests to read the next row in key order
`jsonPayload.readPrev`^†	number	The number of requests to read the previous row in key order
`jsonPayload.readRnd`^†	number	The number of requests to read a row based on a fixed position
`jsonPayload.readRndNext`^†	number	The number of requests to read the next row in the data file
`jsonPayload.sortMergePasses`^†	number	The number of merge passes that the sort algorithm has had to do
`jsonPayload.sortRangeCount`^†	number	The number of sorts that were done using ranges
`jsonPayload.sortRows`^†	number	The number of sorted rows
`jsonPayload.sortScanCount`^†	number	The number of sorts that were done by scanning the table
`jsonPayload.createdTmpDiskTables`^†	number	The number of internal on-disk temporary tables created by the server
`jsonPayload.createdTmpTables`^†	number	The number of internal temporary tables created by the server
`jsonPayload.startTime`^†	string	The statement execution start time
`jsonPayload.endTime`^†	string	The statement execution end time
`jsonPayload.message`	string	Full text of the query
`timestamp`	string (`Timestamp`)	Time the entry was logged

^† These fields are only provided if the log_slow_extra system variable is set to 'ON'. This variable is available as of MySQL 8.0.14.

For information about these fields, refer to the MySQL documentation.

Configure metrics collection

To collect metrics from MySQL, you must create a receiver for MySQL metrics and then create a pipeline for the new receiver.

This receiver does not support the use of multiple instances in the configuration, for example, to monitor multiple endpoints. All such instances write to the same time series, and Cloud Monitoring has no way to distinguish among them.

To configure a receiver for your MySQL metrics, specify the following fields:

Field	Default	Description
`type`		The value must be `mysql`.
`endpoint`	`localhost:3306`	The url exposed by MySQL.
`collection_interval`	`60s`	A time.Duration value, such as `30s` or `5m`.
`username`	`root`	The username used to connect to the server.
`password`		The password used to connect to the server.

What is monitored

The following table provides the list of metrics that the Ops Agent collects from the MySQL instance.

Metric type
Kind, Type Monitored resources	Labels
`workload.googleapis.com/mysql.buffer_pool_operations`
`CUMULATIVE`, `INT64` gce_instance	`operation`
`workload.googleapis.com/mysql.buffer_pool_pages`
`GAUGE`, `DOUBLE` gce_instance	`kind`
`workload.googleapis.com/mysql.buffer_pool_size`
`GAUGE`, `DOUBLE` gce_instance	`kind`
`workload.googleapis.com/mysql.commands`
`CUMULATIVE`, `INT64` gce_instance	`command`
`workload.googleapis.com/mysql.double_writes`
`CUMULATIVE`, `INT64` gce_instance	`kind`
`workload.googleapis.com/mysql.handlers`
`CUMULATIVE`, `INT64` gce_instance	`kind`
`workload.googleapis.com/mysql.locks`
`CUMULATIVE`, `INT64` gce_instance	`kind`
`workload.googleapis.com/mysql.log_operations`
`CUMULATIVE`, `INT64` gce_instance	`operation`
`workload.googleapis.com/mysql.operations`
`CUMULATIVE`, `INT64` gce_instance	`operation`
`workload.googleapis.com/mysql.page_operations`
`CUMULATIVE`, `INT64` gce_instance	`operation`
`workload.googleapis.com/mysql.row_locks`
`CUMULATIVE`, `INT64` gce_instance	`kind`
`workload.googleapis.com/mysql.row_operations`
`CUMULATIVE`, `INT64` gce_instance	`operation`
`workload.googleapis.com/mysql.sorts`
`CUMULATIVE`, `INT64` gce_instance	`kind`
`workload.googleapis.com/mysql.threads`
`GAUGE`, `DOUBLE` gce_instance	`kind`

Verify the configuration

This section describes how to verify that you correctly configured the MySQL receiver. It might take one or two minutes for the Ops Agent to begin collecting telemetry.

To verify that MySQL logs are being sent to Cloud Logging, do the following:

In the navigation panel of the Google Cloud console, select Logging, and then select Logs Explorer:
Go to Logs Explorer

Enter the following query in the editor, and then click Run query:

resource.type="gce_instance"
(log_id("mysql_error") OR log_id("mysql_general") OR log_id("mysql_slow"))

To verify that MySQL metrics are being sent to Cloud Monitoring, do the following:

In the navigation panel of the Google Cloud console, select Monitoring, and then select Metrics explorer:
Go to Metrics explorer
In the toolbar of the query-builder pane, select the button whose name is either MQL or PromQL.
Verify that MQL is selected in the Language toggle. The language toggle is in the same toolbar that lets you format your query.

Enter the following query in the editor, and then click Run query:

fetch gce_instance
| metric 'workload.googleapis.com/mysql.commands'
| align rate(1m)
| every 1m

View dashboard

To view your MySQL metrics, you must have a chart or dashboard configured. The MySQL integration includes one or more dashboards for you. Any dashboards are automatically installed after you configure the integration and the Ops Agent has begun collecting metric data.

You can also view static previews of dashboards without installing the integration.

To view an installed dashboard, do the following:

In the navigation panel of the Google Cloud console, select Monitoring, and then select Dashboards:
Go to Dashboards
Select the Dashboard List tab, and then choose the Integrations category.
Click the name of the dashboard you want to view.

If you have configured an integration but the dashboard has not been installed, then check that the Ops Agent is running. When there is no metric data for a chart in the dashboard, installation of the dashboard fails. After the Ops Agent begins collecting metrics, the dashboard is installed for you.

To view a static preview of the dashboard, do the following:

In the navigation panel of the Google Cloud console, select Monitoring, and then select Integrations:
Go to Integrations
Click the Compute Engine deployment-platform filter.
Locate the entry for MySQL and click View Details.
Select the Dashboards tab to see a static preview. If the dashboard is installed, then you can navigate to it by clicking View dashboard.

For more information about dashboards in Cloud Monitoring, see Dashboards and charts.

For more information about using the Integrations page, see Manage integrations.

Install alerting policies

Alerting policies instruct Cloud Monitoring to notify you when specified conditions occur. The MySQL integration includes one or more alerting policies for you to use. You can view and install these alerting policies from the Integrations page in Monitoring.

To view the descriptions of available alerting policies and install them, do the following:

In the navigation panel of the Google Cloud console, select Monitoring, and then select Integrations:
Go to Integrations
Locate the entry for MySQL and click View Details.
Select the Alerts tab. This tab provides descriptions of available alerting policies and provides an interface for installing them.
Install alerting policies. Alerting policies need to know where to send notifications that the alert has been triggered, so they require information from you for installation. To install alerting policies, do the following:
1. From the list of available alerting policies, select those that you want to install.
2. In the Configure notifications section, select one or more notification channels. You have the option to disable the use of notification channels, but if you do, then your alerting policies fire silently. You can check their status in Monitoring, but you receive no notifications.
  
  For more information about notification channels, see Manage notification channels.
3. Click Create Policies.

For more information about alerting policies in Cloud Monitoring, see Introduction to alerting.

For more information about using the Integrations page, see Manage integrations.

What's next

For a walkthrough on how to use Ansible to install the Ops Agent, configure a third-party application, and install a sample dashboard, see the Install the Ops Agent to troubleshoot third-party applications video.