Performance diagnostics in Managed Service for MySQL®

Written by

Updated at November 18, 2024

Enabling statistics collection
Getting session statistics
Getting query statistics

Managed Service for MySQL® has a built-in tool for collecting session and query statistics. These metrics can be useful when analyzing the performance and optimizing the settings of a cluster.

Enabling statistics collection

Management console

CLI

Terraform

REST API

gRPC API

When creating a cluster or updating its settings:

Enable Statistics sampling (disabled by default).
Configure Sessions sampling interval and Statements sampling interval. The value range is from 1 to 86400 seconds.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To enable and configure statistics collection, specify the --performance-diagnostics parameter in the update cluster command:

yc managed-mysql cluster update <cluster_name_or_ID> \
   ...
   --performance-diagnostics enabled=true,`
                            `sessions-sampling-interval=<session_sampling_interval>,`
                            `statements-sampling-interval=<statement_sampling_interval> \
    ...

For sessions-sampling-interval and statements-sampling-interval, possible values range from 1 to 86400 seconds.

Open the current Terraform configuration file with an infrastructure plan.

For more information about creating this file, see Creating clusters.

To enable and configure statistics collection, add the performance_diagnostics section to the cluster configuration:

resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
  ...
  performance_diagnostics {
    enabled = true
    sessions_sampling_interval = <session_sampling_interval>
    statements_sampling_interval = <statement_sampling_interval>
  }
  ...
}

For sessions_sampling_interval and statements_sampling_interval, possible values range from 1 to 86400 seconds.

Make sure the settings are correct.
1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.
2. Run the command:
```
terraform validate
```
  If there are errors in the configuration files, Terraform will point to them.
Confirm updating the resources.
1. Run the command to view planned changes:
```
terraform plan
```
  If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.
2. If you are happy with the planned changes, apply them:
  1. Run the command:
```
terraform apply
```
  2. Confirm the update of resources.
  3. Wait for the operation to complete.

Time limits

A Terraform provider sets the timeout for Managed Service for MySQL® cluster operations:

Creating a cluster, including by restoring one from a backup: 15 minutes.
Editing a cluster, including the MySQL® version update: 60 minutes.
Deleting a cluster: 15 minutes.

Operations exceeding the set timeout are interrupted.

How do I change these limits?

Add the timeouts block to the cluster description, for example:

resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

Get an IAM token for API authentication and put it into the environment variable:
```
export IAM_TOKEN="<IAM_token>"
```

To enable statistics collection when creating a cluster:

Use the Cluster.create method and add the configSpec.performanceDiagnostics parameter to the cURL command for cluster creation:

curl \
    --request POST \
    --header "Authorization: Bearer $IAM_TOKEN" \
    --header "Content-Type: application/json" \
    --url 'https://mdb.api.cloud.yandex.net/managed-mysql/v1/clusters' \
    --data '{
              "configSpec": {
                "performanceDiagnostics": {
                  "enabled": <activate_statistics_collection:_true_or_false>,
                  "sessionsSamplingInterval": "<session_sampling_interval>",
                  "statementsSamplingInterval": "<statement_sampling_interval>"
                },
                ...
              },
              ...
            }'

Where configSpec.performanceDiagnostics represents the statistics collection settings:

enabled: Enables statistics collection.
sessionsSamplingInterval: Session sampling interval, 1 to 86400 seconds.
statementsSamplingInterval: Statement sampling interval, 60 to 86400 seconds.

View the server response to make sure the request was successful.

To enable statistics collection when updating an existing cluster:
1. Use the Cluster.update method and make a request, e.g., via cURL:
  
  Warning
  
  The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.
```
curl \
    --request PATCH \
    --header "Authorization: Bearer $IAM_TOKEN" \
    --header "Content-Type: application/json" \
    --url 'https://mdb.api.cloud.yandex.net/managed-mysql/v1/clusters/<cluster_ID>' \
    --data '{
              "updateMask": "configSpec.performanceDiagnostics",
              "configSpec": {
                "performanceDiagnostics": {
                  "enabled": <activate_statistics_collection:_true_or_false>,
                  "sessionsSamplingInterval": "<session_sampling_interval>",
                  "statementsSamplingInterval": "<statement_sampling_interval>"
                }
              }
            }'
```
  Where configSpec.performanceDiagnostics represents the statistics collection settings:
  - enabled: Enables statistics collection.
  - sessionsSamplingInterval: Session sampling interval, 1 to 86400 seconds.
  - statementsSamplingInterval: Statement sampling interval, 60 to 86400 seconds.
2. View the server response to make sure the request was successful.

Get an IAM token for API authentication and put it into the environment variable:
```
export IAM_TOKEN="<IAM_token>"
```
Clone the cloudapi repository:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

To enable statistics collection when creating a cluster:

Use the ClusterService/Create method and add the config_spec.performance_diagnostics parameter to the gRPCurl cluster creation command:

grpcurl \
    -format json \
    -import-path ~/cloudapi/ \
    -import-path ~/cloudapi/third_party/googleapis/ \
    -proto ~/cloudapi/yandex/cloud/mdb/mysql/v1/cluster_service.proto \
    -rpc-header "Authorization: Bearer $IAM_TOKEN" \
    -d '{
          "config_spec": {
            "performance_diagnostics": {
              "enabled": <activate_statistics_collection:_true_or_false>,
              "sessions_sampling_interval": "<session_sampling_interval>",
              "statements_sampling_interval": "<statement_sampling_interval>"
            },
            ...
          },
          ...
        }' \
    mdb.api.cloud.yandex.net:443 \
    yandex.cloud.mdb.mysql.v1.ClusterService.Create

Where config_spec.performance_diagnostics represents the statistics collection settings:

enabled: Enables statistics collection.
sessions_sampling_interval: Session sampling interval, 1 to 86400 seconds.
statements_sampling_interval: Statement sampling interval, 60 to 86400 seconds.

View the server response to make sure the request was successful.

To enable statistics collection when updating an existing cluster:

Use the ClusterService/Update call and make a request, e.g., via gRPCurl:

Warning

The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

Format for listing settings

"update_mask": {
    "paths": [
        "<setting_1>",
        "<setting_2>",
        ...
        "<setting_N>"
    ]
}

grpcurl \
    -format json \
    -import-path ~/cloudapi/ \
    -import-path ~/cloudapi/third_party/googleapis/ \
    -proto ~/cloudapi/yandex/cloud/mdb/mysql/v1/cluster_service.proto \
    -rpc-header "Authorization: Bearer $IAM_TOKEN" \
    -d '{
          "cluster_id": "<cluster_ID>",
          "update_mask": {
            "paths": [
              "config_spec.performance_diagnostics"
            ]
          },
          "config_spec": {
            "performance_diagnostics": {
              "enabled": <activate_statistics_collection:_true_or_false>,
              "sessions_sampling_interval": "<session_sampling_interval>",
              "statements_sampling_interval": "<statement_sampling_interval>"
            }
          }
        }' \
    mdb.api.cloud.yandex.net:443 \
    yandex.cloud.mdb.mysql.v1.ClusterService.Update

Where config_spec.performance_diagnostics represents the statistics collection settings:

enabled: Enables statistics collection.
sessions_sampling_interval: Session sampling interval, 1 to 86400 seconds.
statements_sampling_interval: Statement sampling interval, 60 to 86400 seconds.

View the server response to make sure the request was successful.

Getting session statistics

In the management console, go to the folder page and select Managed Service for MySQL.
Click the cluster name and select the Performance diagnostics → Sessions tab.

To view session statistics or the history of queries executed within a session, select the appropriate tab.
Statistics

History
To view session statistics:
1. Specify the required time interval.
2. (Optional) Set filters.
3. Select the required data segment.
To show or hide individual categories, click the category name in the chart legend.
To view the history of queries run during a session:
1. Specify the required time interval.
2. (Optional) Set filters.

Getting query statistics

In the management console, go to the folder page and select Managed Service for MySQL.
Click the cluster name and select the Performance diagnostics → Queries tab.

To view query statistics or compare them in two time intervals, select the appropriate tab.
Interval

Two intervals
To view query statistics:
1. Select the time interval you need.
2. (Optional) Set filters.
To get information about the relative change in the query statistics:
1. In the Interval 1 field, select the time interval to be used as a calculation basis for statistics.
2. In the Interval 2 field, select the time interval to compare the statistics for interval 1 with.
3. (Optional) Set filters.
Let’s assume, 10 SELECT * FROM cities queries were made in the first interval and 20 in the second. When comparing statistics, the difference by the number of queries metric (the Calls column in the table) will be +100%.

For more information about the displayed information, see the MySQL® documentation.

Performance diagnostics in Managed Service for MySQL®

Enabling statistics collectionEnabling statistics collection

Getting session statisticsGetting session statistics

Getting query statisticsGetting query statistics

Was the article helpful?

Enabling statistics collection

Getting session statistics

Getting query statistics