Просмотр логов кластера Sharded PostgreSQL

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

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

1. Просмотрите описание команды CLI для просмотра логов кластера:

   yc managed-sharded-postgresql cluster list-logs --help
   

2. Запустите команду получения логов кластера (в примере приведены не все доступные параметры):

   yc managed-sharded-postgresql cluster list-logs <имя_или_идентификатор_кластера> \
      --limit <ограничение_количества_записей> \
      --service-type <тип_сервиса> \
      --columns <список_колонок_для_вывода_информации> \
      --filter <настройки_фильтрации_записей> \
      --since <левая_граница_временного_диапазона> \
      --until <правая_граница_временного_диапазона>
   

   Где:

   • --limit — ограничение на количество выводимых записей.

   • --service-type — тип сервиса, логи которого нужно получить (infra, router или coordinator).

   • --columns — список колонок для вывода информации:

     • hostname — имя хоста.
     • severity — уровень логирования, например info.
     • message — сообщение, которое выводит компонент.
     • contextual_data — дополнительная информация.

   • --filter — настройки фильтрации записей, например message.hostname='node1.mdb.yandexcloud.net'.

   • --since — левая граница временного диапазона в формате RFC-3339, HH:MM:SS или временного промежутка относительно текущего времени. Примеры: 2006-01-02T15:04:05Z, 15:04:05, 2h, 3h30m ago.

   • --until — правая граница временного диапазона, формат аналогичен --since.

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

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

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

   curl \
     --request GET \
     --header "Authorization: Bearer $IAM_TOKEN" \
     --url 'https://mdb.api.cloud.yandex.net/managed-spqr/v1/clusters/<идентификатор_кластера>:logs' \
     --url-query serviceType=<тип_сервиса> \
     --url-query columnFilter=<колонка_1> \
     --url-query columnFilter=<колонка_2> \
     ... \
     --url-query columnFilter=<колонка_N> \
     --url-query fromTime=<левая_граница_временного_диапазона> \
     --url-query toTime=<правая_граница_временного_диапазона>
   

   Где:

   • serviceType — тип сервиса, логи которого нужно получить:

     • INFRA — операции хостов INFRA, объединяющие роли роутера и координатора;
     • ROUTER — операции роутера;
     • COORDINATOR — операции координатора.

   • columnFilter — название колонки для вывода информации:

     • hostname — имя хоста.
     • severity — уровень логирования, например info.
     • message — сообщение, которое выводит компонент.
     • contextual_data — дополнительная информация.

     В одном параметре columnFilter можно указать только одну колонку. Если необходимо отфильтровать логи по нескольким колонкам, передайте перечень нужных колонок в нескольких параметрах.

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

   • toTime — правая граница временного диапазона, формат аналогичен fromTime.

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

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

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

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

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

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

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

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/spqr/v1/cluster_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d '{
           "cluster_id": "<идентификатор_кластера>",
           "service_type": "<тип_сервиса>",
           "column_filter": [
             "<колонка_1>", "<колонка_2>", ..., "<колонка_N>"
           ],
           "from_time": "<левая_граница_временного_диапазона>",
           "to_time": "<правая_граница_временного_диапазона>"
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.spqr.v1.ClusterService.ListLogs
   

   Где:

   • service_type — тип сервиса, логи которого нужно получить:

     • INFRA — операции хостов INFRA, объединяющие роли роутера и координатора;
     • ROUTER — операции роутера;
     • COORDINATOR — операции координатора.

   • column_filter — список колонок для вывода информации:

     • hostname — имя хоста.
     • severity — уровень логирования, например info.
     • message — сообщение, которое выводит компонент.
     • contextual_data — дополнительная информация.

     В параметре column_filter можно указать несколько колонок, если нужно отфильтровать логи по нескольким колонкам.

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

   • to_time — правая граница временного диапазона, формат аналогичен from_time.

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

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

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

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

   curl \
     --request GET \
     --header "Authorization: Bearer $IAM_TOKEN" \
     --url 'https://mdb.api.cloud.yandex.net/managed-spqr/v1/clusters/<идентификатор_кластера>:stream_logs' \
     --url-query serviceType=<тип_сервиса> \
     --url-query columnFilter=<колонка_1> \
     --url-query columnFilter=<колонка_2> \
     ... \
     --url-query columnFilter=<колонка_N> \
   

   Где:

   • serviceType — тип сервиса, логи которого нужно получить:

     • INFRA — операции хостов INFRA, объединяющие роли роутера и координатора;
     • ROUTER — операции роутера;
     • COORDINATOR — операции координатора.

   • columnFilter — название колонки для вывода информации:

     • hostname — имя хоста.
     • severity — уровень логирования, например info.
     • message — сообщение, которое выводит компонент.
     • contextual_data — дополнительная информация.

     В одном параметре columnFilter можно указать только одну колонку. Если необходимо отфильтровать логи по нескольким колонкам, передайте перечень нужных колонок в нескольких параметрах.

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

   Команда не завершается после отправки. Новые логи отображаются в выводе команды в режиме реального времени.

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

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

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

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

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

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

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/spqr/v1/cluster_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d '{
           "cluster_id": "<идентификатор_кластера>",
           "service_type": "<тип_сервиса>",
           "column_filter": [
             "<колонка_1>", "<колонка_2>", ..., "<колонка_N>"
           ]
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.spqr.v1.ClusterService.StreamLogs
   

   Где:

   • service_type — тип сервиса, логи которого нужно получить:

     • INFRA — операции хостов INFRA, объединяющие роли роутера и координатора;
     • ROUTER — операции роутера;
     • COORDINATOR — операции координатора.

   • column_filter — список колонок для вывода информации:

     • hostname — имя хоста.
     • severity — уровень логирования, например info.
     • message — сообщение, которое выводит компонент.
     • contextual_data — дополнительная информация.

     В параметре column_filter можно указать несколько колонок, если нужно отфильтровать логи по нескольким колонкам.

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

   Команда не завершается после отправки. Новые логи отображаются в выводе команды в режиме реального времени.