Диагностика производительности в Managed Service for PostgreSQL

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id. Если вы обращаетесь к ресурсу по имени, поиск будет выполнен в каталоге по умолчанию. Если вы обращаетесь к ресурсу по идентификатору, поиск будет выполнен глобально — во всех каталогах с учетом прав доступа.

Чтобы включить сбор статистики, передайте параметр --performance-diagnostics в команде изменения кластера:

yc managed-postgresql cluster update <имя_или_идентификатор_кластера> \
    ...
    --performance-diagnostics enabled=true,`
                             `sessions-sampling-interval=<интервал_сбора_сессий>,`
                             `statements-sampling-interval=<интервал_сбора_запросов> \
    ...

Допустимые значения параметров:

• sessions-sampling-interval — от 5 до 86400 секунд.
• statements-sampling-interval — от 60 до 86400 секунд.

1. Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.

   О том, как создать такой файл, см. в разделе Создание кластера.

   Полный список доступных для изменения полей конфигурации кластера Managed Service for PostgreSQL см. в документации провайдера Terraform.

2. Чтобы настроить сбор статистики, добавьте в блок config блок performance_diagnostics:

   resource "yandex_mdb_postgresql_cluster" "<имя_кластера>" {
     ...
     config {
       ...
       performance_diagnostics {
         enabled                      = <активация_сбора_статистики>
         sessions_sampling_interval   = <интервал_сбора_сессий>
         statements_sampling_interval = <интервал_сбора_запросов>
       }
       ...
     }
     ...
   }
   

   Где:

   • enabled — активация сбора статистики: true или false.
   • sessions_sampling_interval — интервал сбора сессий от 5 до 86400 секунд.
   • statements_sampling_interval — интервал сбора запросов от 60 до 86400 секунд.

3. Проверьте корректность настроек.

   1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.

   2. Выполните команду:

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

4. Подтвердите изменение ресурсов.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

      1. Выполните команду:

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

   Ограничения по времени

   Провайдер Terraform ограничивает время на выполнение операций с кластером Managed Service for PostgreSQL:

   • создание, в том числе путем восстановления из резервной копии, — 30 минут;
   • изменение — 60 минут;
   • удаление — 15 минут.

   Операции, длящиеся дольше указанного времени, прерываются.

   Как изменить эти ограничения?

   Добавьте к описанию кластера блок timeouts, например:

   resource "yandex_mdb_postgresql_cluster" "<имя_кластера>" {
     ...
     timeouts {
       create = "1h30m" # Полтора часа
       update = "2h"    # 2 часа
       delete = "30m"   # 30 минут
     }
   }
   

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Чтобы включить сбор статистики при создании кластера:

   1. Воспользуйтесь методом Cluster.Create и добавьте параметр configSpec.performanceDiagnostics в команду cURL по созданию кластера:

      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": <активировать_сбор_статистики>,
                      "sessionsSamplingInterval": "<интервал_сбора_сессий>",
                      "statementsSamplingInterval": "<интервал_сбора_запросов>"
                    },
                    ...
                  },
                  ...
                }'
      

      Где configSpec.performanceDiagnostics — настройки сбора статистики:

      • enabled — активация сбора статистики: true или false.
      • sessionsSamplingInterval — интервал сбора сессий. Допустимые значения — от 5 до 86400 секунд.
      • statementsSamplingInterval — интервал сбора запросов. Допустимые значения — от 60 до 86400 секунд.

   2. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

3. Чтобы включить сбор статистики при изменении существующего кластера:

   1. Воспользуйтесь методом Cluster.Update и выполните запрос, например, с помощью cURL:

      Важно

      Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре updateMask (одной строкой через запятую).

      curl \
        --request PATCH \
        --header "Authorization: Bearer $IAM_TOKEN" \
        --header "Content-Type: application/json" \
        --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/<идентификатор_кластера>' \
        --data '{
                  "updateMask": "configSpec.performanceDiagnostics",
                  "configSpec": {
                    "performanceDiagnostics": {
                      "enabled": <активировать_сбор_статистики>,
                      "sessionsSamplingInterval": "<интервал_сбора_сессий>",
                      "statementsSamplingInterval": "<интервал_сбора_запросов>"
                    }
                  }
                }'
      

      Где configSpec.performanceDiagnostics — настройки сбора статистики:

      • enabled — активация сбора статистики: true или false.
      • sessionsSamplingInterval — интервал сбора сессий. Допустимые значения — от 5 до 86400 секунд.
      • statementsSamplingInterval — интервал сбора запросов. Допустимые значения — от 60 до 86400 секунд.

   2. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Чтобы включить сбор статистики при создании кластера:

   1. Воспользуйтесь методом ClusterService.Create и добавьте параметр config_spec.performance_diagnostics в команду grpcurl по созданию кластера:

      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": <активировать_сбор_статистики>,
                  "sessions_sampling_interval": "<интервал_сбора_сессий>",
                  "statements_sampling_interval": "<интервал_сбора_запросов>"
                },
                ...
              },
              ...
            }' \
        mdb.api.cloud.yandex.net:443 \
        yandex.cloud.mdb.postgresql.v1.ClusterService.Create
      

      Где config_spec.performance_diagnostics — настройки сбора статистики:

      • enabled — активация сбора статистики: true или false.
      • sessions_sampling_interval — интервал сбора сессий. Допустимые значения — от 5 до 86400 секунд.
      • statements_sampling_interval — интервал сбора запросов. Допустимые значения — от 60 до 86400 секунд.

   2. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

4. Чтобы включить сбор статистики при изменении существующего кластера:

   1. Воспользуйтесь вызовом ClusterService.Update и выполните запрос, например, с помощью gRPCurl:

      Важно

      Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре update_mask (в виде массива строк paths[]).

      Формат перечисления настроек

      "update_mask": {
          "paths": [
              "<настройка_1>",
              "<настройка_2>",
              ...
              "<настройка_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": "<идентификатор_кластера>",
              "update_mask": {
                "paths": [
                  "config_spec.performance_diagnostics"
                ]
              },
              "config_spec": {
                "performance_diagnostics": {
                  "enabled": <активировать_сбор_статистики>,
                  "sessions_sampling_interval": "<интервал_сбора_сессий>",
                  "statements_sampling_interval": "<интервал_сбора_запросов>"
                }
              }
            }' \
        mdb.api.cloud.yandex.net:443 \
        yandex.cloud.mdb.postgresql.v1.ClusterService.Update
      

      Где config_spec.performance_diagnostics — настройки сбора статистики:

      • enabled — активация сбора статистики: true или false.
      • sessions_sampling_interval — интервал сбора сессий. Допустимые значения — от 5 до 86400 секунд.
      • statements_sampling_interval — интервал сбора запросов. Допустимые значения — от 60 до 86400 секунд.

   2. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом PerformanceDiagnosticsService.ListRawSessionStates и выполните запрос, например, с помощью gRPCurl:

   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": "<идентификатор_кластера>",
           "from_time": "<левая_граница_временного_диапазона>",
           "to_time": "<правая_граница_временного_диапазона>"
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.postgresql.v1.PerformanceDiagnosticsService.ListRawSessionStates
   

   Где:

   • from_time — левая граница временного диапазона в формате RFC-3339. Пример: 2024-09-18T15:04:05Z.
   • to_time — правая граница временного диапазона, формат аналогичен from_time.

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом PerformanceDiagnosticsService.ListRawStatements и выполните запрос, например, с помощью gRPCurl:

   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": "<идентификатор_кластера>",
           "from_time": "<левая_граница_временного_диапазона>",
           "to_time": "<правая_граница_временного_диапазона>"
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.postgresql.v1.PerformanceDiagnosticsService.ListRawStatements
   

   Где:

   • from_time — левая граница временного диапазона в формате RFC-3339. Пример: 2024-09-18T15:04:05Z.
   • to_time — правая граница временного диапазона, формат аналогичен from_time.

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.