MariaDB

The MariaDB 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 MariaDB, see the MariaDB documentation.

Prerequisites

To collect MariaDB telemetry, you must install the Ops Agent:

  • For metrics, install version 2.37.0 or higher.
  • For logs, install version 2.37.0 or higher.

This integration supports MariaDB versions 10.1.X through 10.7.X.

Configure your MariaDB instance

MariaDB is a community-developed, commercially supported fork of the MySQL relational database management system (RDBMS). To collect logs and metrics for MariaDB, use the mysql receivers.

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

The mysql_error logging receiver collects logs from the default file paths shown in the following table. On some platforms, MariaDB logs to journald by default instead of to file. To configure MariaDB to log to a file instead, set the log_error option in the MariaDB configuration. For more information about log_error configuration, see Writing the Error Log to a File.

Configure the Ops Agent for MariaDB

Following the guide to Configure the Ops Agent, add the required elements to collect telemetry from MariaDB instances, and restart the agent.

Example configuration

The following commands create the configuration to collect and ingest telemetry for MariaDB and restart the Ops Agent.

# 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
  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

Configure logs collection

To ingest logs from MariaDB, you must create a receiver for the logs that MariaDB produces and then create a pipeline for the new receiver.

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

Field Default Description
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, /run/mysqld/mysqld.err, /var/lib/mysql/${HOSTNAME}.err] 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:

Field Default Description
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:

Field Default Description
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:

Field Type Description
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:

Field Type Description
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:

Field Type Description
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.createdTmpTableSizes   number The number of bytes used by internal temporary tables created by the server
jsonPayload.database string Database where the query was executed
jsonPayload.filesort   boolean The statement used filesort
jsonPayload.filesortOnDisk   boolean The statement used filesort that needed temporary tables on disk
jsonPayload.fullJoin   boolean The statement didn't use an index to join tables
jsonPayload.fullScan   boolean The statement used a full table scan
jsonPayload.host string Host name the client connected from
jsonPayload.ipAddress string IP address the client connected from
jsonPayload.lockTime number The time to acquire locks in seconds
jsonPayload.message string Full text of the query
jsonPayload.priorityQueue   boolean The statement used a priority queue filesort
jsonPayload.queryCacheHit boolean The statement was served from the query cache
jsonPayload.queryTime number The statement execution time in seconds
jsonPayload.rowsAffected integer The number of rows affected by the statement
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.storedRoutine string The name of the stored routine currently being executed
jsonPayload.tid number Thread ID where the query was logged
jsonPayload.user string Authenticated user that executed the query
severity string (LogSeverity) Log entry level (translated).

 These fields are only provided if the log_slow_verbosity system variable contains 'query_plan'.

Configure metrics collection

To ingest metrics from MariaDB, you must create a receiver for the metrics that MariaDB 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:

Field Default Description
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 MariaDB 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 MariaDB instance.

Metric type 
Kind, Type
Monitored resources
Labels
workload.googleapis.com/mysql.buffer_pool_data_pages
GAUGEINT64
gce_instance
status
workload.googleapis.com/mysql.buffer_pool_limit
GAUGEINT64
gce_instance
 
workload.googleapis.com/mysql.buffer_pool_operations
CUMULATIVEINT64
gce_instance
operation
workload.googleapis.com/mysql.buffer_pool_page_flushes
CUMULATIVEINT64
gce_instance
 
workload.googleapis.com/mysql.buffer_pool_pages
GAUGEDOUBLE
gce_instance
kind
workload.googleapis.com/mysql.buffer_pool_size
GAUGEDOUBLE
gce_instance
kind
workload.googleapis.com/mysql.commands
CUMULATIVEINT64
gce_instance
command
workload.googleapis.com/mysql.double_writes
CUMULATIVEINT64
gce_instance
kind
workload.googleapis.com/mysql.handlers
CUMULATIVEINT64
gce_instance
kind
workload.googleapis.com/mysql.locks
CUMULATIVEINT64
gce_instance
kind
workload.googleapis.com/mysql.log_operations
CUMULATIVEINT64
gce_instance
operation
workload.googleapis.com/mysql.operations
CUMULATIVEINT64
gce_instance
operation
workload.googleapis.com/mysql.page_operations
CUMULATIVEINT64
gce_instance
operation
workload.googleapis.com/mysql.replica.sql_delay
GAUGEINT64
gce_instance
 
workload.googleapis.com/mysql.replica.time_behind_source
GAUGEINT64
gce_instance
 
workload.googleapis.com/mysql.row_locks
CUMULATIVEINT64
gce_instance
kind
workload.googleapis.com/mysql.row_operations
CUMULATIVEINT64
gce_instance
operation
workload.googleapis.com/mysql.sorts
CUMULATIVEINT64
gce_instance
kind
workload.googleapis.com/mysql.threads
GAUGEDOUBLE
gce_instance
kind

Verify the configuration

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

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

  1. In the Google Cloud console, go to the Logs Explorer page:

    Go to Logs Explorer

    If you use the search bar to find this page, then select the result whose subheading is Logging.

  2. 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 MariaDB metrics are being sent to Cloud Monitoring, do the following:

  1. In the Google Cloud console, go to the  Metrics explorer page:

    Go to Metrics explorer

    If you use the search bar to find this page, then select the result whose subheading is Monitoring.

  2. In the toolbar of the query-builder pane, select the button whose name is either  MQL or  PromQL.
  3. Verify that MQL is selected in the Language toggle. The language toggle is in the same toolbar that lets you format your query.
  4. Enter the following query in the editor, and then click Run query:
    fetch gce_instance
    | metric 'workload.googleapis.com/mysql.threads'
    | every 1m
    

View dashboard

To view your MariaDB metrics, you must have a chart or dashboard configured. MariaDB uses the same dashboards as MySQL. 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:

  1. In the Google Cloud console, go to the  Dashboards page:

    Go to Dashboards

    If you use the search bar to find this page, then select the result whose subheading is Monitoring.

  2. Select the Dashboard List tab, and then choose the Integrations category.
  3. Click the name of the dashboard you want to view. MariaDB uses the same dashboards as MySQL.

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:

  1. In the Google Cloud console, go to the  Integrations page:

    Go to Integrations

    If you use the search bar to find this page, then select the result whose subheading is Monitoring.

  2. Click the Compute Engine deployment-platform filter.
  3. Locate the entry for MySQL and click View Details. MariaDB uses the same dashboards as MySQL.
  4. 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. MariaDB uses the same alerting policies as MySQL. 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:

  1. In the Google Cloud console, go to the  Integrations page:

    Go to Integrations

    If you use the search bar to find this page, then select the result whose subheading is Monitoring.

  2. Locate the entry for MySQL and click View Details. MariaDB uses the same alerting policies as MySQL.
  3. Select the Alerts tab. This tab provides descriptions of available alerting policies and provides an interface for installing them.
  4. 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.