Performance diagnostics in Managed Service for PostgreSQL

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

The folder used by default is the one specified when creating the CLI 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 options.

To enable statistics collection, add the --performance-diagnostics option to the cluster update command:

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

Allowed values:

• sessions-sampling-interval: From 5 to 86400 seconds.
• statements-sampling-interval: From 60 to 86400 seconds.

1. Open the current Terraform configuration file describing your infrastructure.

   For more on how to create this file, see Creating a cluster.

   For a complete list of configurable Managed Service for PostgreSQL cluster fields, see this Terraform provider guide.

2. To set up statistics collection, add the performance_diagnostics block to the config section:

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     config {
       ...
       performance_diagnostics {
         enabled                      = <activate_statistics_collection>
         sessions_sampling_interval   = <session_sampling_interval>
         statements_sampling_interval = <statement_sampling_interval>
       }
       ...
     }
     ...
   }
   

   Where:

   • enabled: Enables statistics collection, true or false.
   • sessions_sampling_interval: Session sampling interval, from 5 to 86400 seconds.
   • statements_sampling_interval: Statement sampling interval, from 60 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.

   Timeouts

   The Terraform provider sets the following timeouts for Managed Service for PostgreSQL cluster operations:

   • Creating a cluster, including restoration from a backup: 30 minutes.
   • Updating a cluster: 60 minutes.
   • Deleting a cluster: 15 minutes.

   Operations exceeding the timeout are aborted.

   How can I change these timeouts?

   Add a timeouts section to the cluster description, e.g.:

   resource "yandex_mdb_postgresql_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 an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. To enable the collection of statistics when creating a cluster:

   1. Include configSpec.performanceDiagnostics option to the cURL command implementing the Cluster.Create method:

      curl \
        --request POST \
        --header "Authorization: Bearer $IAM_TOKEN" \
        --header "Content-Type: application/json" \
        --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/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. Allowed values range from 5 to 86400.
      • statementsSamplingInterval: Statement sampling interval. Allowed values range from 60 to 86400.

   2. Check the server response to make sure your request was successful.

3. To enable the collection of statistics when updating an existing cluster:

   1. Call the Cluster.Update method, e.g., via the following cURL request:

      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-postgresql/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. Allowed values range from 5 to 86400.
      • statementsSamplingInterval: Statement sampling interval. Allowed values range from 60 to 86400.

   2. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and put it into an 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 that the repository contents reside in the ~/cloudapi/ directory.

3. To enable the collection of statistics when creating a cluster:

   1. Include the config_spec.performance_diagnostics option to the grpcurl command implementing the ClusterService.Create method:

      grpcurl \
        -format json \
        -import-path ~/cloudapi/ \
        -import-path ~/cloudapi/third_party/googleapis/ \
        -proto ~/cloudapi/yandex/cloud/mdb/postgresql/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.postgresql.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. Allowed values range from 5 to 86400.
      • statements_sampling_interval: Statement sampling interval. Allowed values range from 60 to 86400.

   2. Check the server response to make sure your request was successful.

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

   1. Call the ClusterService.Update method, e.g., via the following gRPCurl request:

      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/postgresql/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.postgresql.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. Allowed values range from 5 to 86400.
      • statements_sampling_interval: Statement sampling interval. Allowed values range from 60 to 86400.

   2. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and put it into an 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 that the repository contents reside in the ~/cloudapi/ directory.

3. Call the PerformanceDiagnosticsService.ListRawSessionStates method, e.g., via the following gRPCurl request:

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/postgresql/v1/perf_diag_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d '{
           "cluster_id": "<cluster_ID>",
           "from_time": "<time_range_left_boundary>",
           "to_time": "<time_range_right_boundary>"
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.postgresql.v1.PerformanceDiagnosticsService.ListRawSessionStates
   

   Where:

   • from_time: Start of the time range in RFC-3339 format, e.g., 2024-09-18T15:04:05Z.
   • to_time: End of the time range in the same format as from_time.

   You can get the cluster ID with the list of clusters in the folder.

4. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and put it into an 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 that the repository contents reside in the ~/cloudapi/ directory.

3. Call the PerformanceDiagnosticsService.ListRawStatements method, e.g., via the following gRPCurl request:

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/postgresql/v1/perf_diag_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d '{
           "cluster_id": "<cluster_ID>",
           "from_time": "<time_range_left_boundary>",
           "to_time": "<time_range_right_boundary>"
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.postgresql.v1.PerformanceDiagnosticsService.ListRawStatements
   

   Where:

   • from_time: Start of the time range in RFC-3339 format, e.g., 2024-09-18T15:04:05Z.
   • to_time: End of the time range in the same format as from_time.

   You can request the cluster ID with the list of clusters in the folder.

4. Check the server response to make sure your request was successful.