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 the MySQL documentation.
PrerequisitesTo collect MySQL telemetry, you must install the Ops Agent:
This integration supports MySQL versions 5.7 and 8.0.
Configure your MySQL instanceThe mysql
receiver connects by default to a local MySQL server using a Unix socket and Unix authentication as the root
user.
Following the guide to Configure the Ops Agent, add the required elements to collect telemetry from MySQL instances, and restart the agent.
Example configurationThe following commands create the configuration to collect and ingest telemetry for MySQL:
For these changes to take effect, you must restart the Ops Agent:
Linuxsudo systemctl restart google-cloud-ops-agent
sudo systemctl status "google-cloud-ops-agent*"
Restart-Service google-cloud-ops-agent -Force
Get-Service google-cloud-ops-agent*
To ingest logs from MySQL, you must create a receiver for the logs that MySQL produces and then create a pipeline for the new receiver.
To configure a receiver for your mysql_error
logs, specify the following fields:
exclude_paths
A list of filesystem path patterns to exclude from the set matched by include_paths
. 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
. 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. type
This value must be mysql_error
. 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:
exclude_paths
A list of filesystem path patterns to exclude from the set matched by include_paths
. include_paths
[/var/lib/mysql/${HOSTNAME}.log]
A list of filesystem paths to read by tailing each file. A wild card (*
) can be used in the 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. type
This value must be mysql_general
. 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:
exclude_paths
A list of filesystem path patterns to exclude from the set matched by include_paths
. include_paths
[/var/lib/mysql/${HOSTNAME}-slow.log]
A list of filesystem paths to read by tailing each file. A wild card (*
) can be used in the 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. type
This value must be mysql_slow
. 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
is derived from the receiver IDs specified in the configuration. Detailed fields inside the LogEntry
are as follows.
The mysql_error
logs contain the following fields in the LogEntry
:
jsonPayload.errorCode
string MySQL error code associated with the log jsonPayload.level
string Log entry level jsonPayload.message
string Log message jsonPayload.subsystem
string MySQL subsystem where the log originated jsonPayload.tid
number Thread ID where the log originated severity
string (LogSeverity
) Log entry level (translated).
The mysql_general
logs contain the following fields in the LogEntry
:
jsonPayload.command
string Type of database action being logged jsonPayload.message
string Log of the database action jsonPayload.tid
number Thread ID where the log originated severity
string (LogSeverity
) Log entry level (translated).
The mysql_slow
logs contain the following fields in the LogEntry
:
jsonPayload.bytesReceived
† number The number of bytes received from all clients jsonPayload.bytesSent
† number The number of bytes sent to all clients 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.database
string Database where the query was executed jsonPayload.endTime
† string The statement execution end time jsonPayload.errorNumber
† number The statement error number, or 0 if no error occurred jsonPayload.host
string Host of the database instance jsonPayload.ipAddress
string Address of the database instance jsonPayload.killed
† number If the statement was terminated, the error number indicating why, or 0 if the statement terminated normally jsonPayload.level
string Log entry level jsonPayload.lockTime
number The time to acquire locks in seconds jsonPayload.message
string Full text of the query jsonPayload.queryTime
number The statement execution time in seconds jsonPayload.readFirst
† number The number of times the first entry in an index was read jsonPayload.readKey
† number The number of requests to read a row based on a key jsonPayload.readLast
† number The number of requests to read the last key in an index 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.rowsExamined
number The number of rows examined by the server layer jsonPayload.rowsSent
number The number of rows sent to the client 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.startTime
† string The statement execution start time jsonPayload.tid
number Thread ID where the query was logged jsonPayload.user
string User that executed the query severity
string (LogSeverity
) Log entry level (translated).
† 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 collectionTo ingest metrics from MySQL, you must create a receiver for the metrics that MySQL produces 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:
collection_interval
60s
A time duration value, such as 30s
or 5m
. endpoint
/var/run/mysqld/mysqld.sock
The hostname:port
or Unix socket path starting with /
used to connect to the MySQL server. password
The password used to connect to the server. type
This value must be mysql
. username
root
The username 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, Typeworkload.googleapis.com/mysql.buffer_pool_data_pages
GAUGE
, INT64
status
workload.googleapis.com/mysql.buffer_pool_limit
GAUGE
, INT64
workload.googleapis.com/mysql.buffer_pool_operations
CUMULATIVE
, INT64
operation
workload.googleapis.com/mysql.buffer_pool_page_flushes
CUMULATIVE
, INT64
workload.googleapis.com/mysql.buffer_pool_pages
GAUGE
, DOUBLE
kind
workload.googleapis.com/mysql.buffer_pool_size
GAUGE
, DOUBLE
kind
workload.googleapis.com/mysql.commands
CUMULATIVE
, INT64
command
workload.googleapis.com/mysql.double_writes
CUMULATIVE
, INT64
kind
workload.googleapis.com/mysql.handlers
CUMULATIVE
, INT64
kind
workload.googleapis.com/mysql.locks
CUMULATIVE
, INT64
kind
workload.googleapis.com/mysql.log_operations
CUMULATIVE
, INT64
operation
workload.googleapis.com/mysql.operations
CUMULATIVE
, INT64
operation
workload.googleapis.com/mysql.page_operations
CUMULATIVE
, INT64
operation
workload.googleapis.com/mysql.replica.sql_delay
GAUGE
, INT64
workload.googleapis.com/mysql.replica.time_behind_source
GAUGE
, INT64
workload.googleapis.com/mysql.row_locks
CUMULATIVE
, INT64
kind
workload.googleapis.com/mysql.row_operations
CUMULATIVE
, INT64
operation
workload.googleapis.com/mysql.sorts
CUMULATIVE
, INT64
kind
workload.googleapis.com/mysql.threads
GAUGE
, DOUBLE
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 Google Cloud console, go to the Logs Explorer page:
If you use the search bar to find this page, then select the result whose subheading is Logging.
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 Google Cloud console, go to the leaderboard Metrics explorer page:
If you use the search bar to find this page, then select the result whose subheading is Monitoring.
{"workload.googleapis.com/mysql.threads", monitored_resource="gce_instance"}
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 Google Cloud console, go to the Dashboards page:
If you use the search bar to find this page, then select the result whose subheading is Monitoring.
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 Google Cloud console, go to the Integrations page:
If you use the search bar to find this page, then select the result whose subheading is Monitoring.
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 policiesAlerting 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 Google Cloud console, go to the Integrations page:
If you use the search bar to find this page, then select the result whose subheading is Monitoring.
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.
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 nextFor 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.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4