Performance diagnostics in Managed Service for MySQL®

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To enable and configure statistics collection, provide 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.

1. Open the current Terraform configuration file that defines your infrastructure.

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

2. 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.

3. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

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

1. Get an IAM token for API authentication and put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. To enable statistics collection when creating a cluster:

   1. 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": <enable_statistics_collection>,
                        "sessionsSamplingInterval": "<session_sampling_interval>",
                        "statementsSamplingInterval": "<statement_sampling_interval>"
                      },
                      ...
                    },
                    ...
                  }'
      

      Where configSpec.performanceDiagnostics represents the statistics collection settings:

      • enabled: Enables statistics collection, true or false.
      • sessionsSamplingInterval: Session sampling interval, from 1 to 86400 seconds.
      • statementsSamplingInterval: Statement sampling interval, from 60 to 86400 seconds.

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

3. 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": <enable_statistics_collection>,
                        "sessionsSamplingInterval": "<session_sampling_interval>",
                        "statementsSamplingInterval": "<statement_sampling_interval>"
                      }
                    }
                  }'
      

      Where configSpec.performanceDiagnostics represents the statistics collection settings:

      • enabled: Enables statistics collection, true or false.
      • sessionsSamplingInterval: Session sampling interval, from 1 to 86400 seconds.
      • statementsSamplingInterval: Statement sampling interval, from 60 to 86400 seconds.

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

1. Get an IAM token for API authentication and put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. 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.

3. To enable statistics collection when creating a cluster:

   1. 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": <enable_statistics_collection>,
                    "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, true or false.
      • sessions_sampling_interval: Session sampling interval, from 1 to 86400 seconds.
      • statements_sampling_interval: Statement sampling interval, from 60 to 86400 seconds.

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

4. To enable statistics collection when updating an existing cluster:

   1. Use the ClusterService/Update call and send the following 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": <enable_statistics_collection>,
                    "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, true or false.
      • sessions_sampling_interval: Session sampling interval, from 1 to 86400 seconds.
      • statements_sampling_interval: Statement sampling interval, from 60 to 86400 seconds.

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