Просмотр логов кластера MySQL®

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

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

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

   yc managed-mysql cluster list-logs --help
   

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

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

   Где:

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

   • --format — формат, в котором будут представлены записи логов (text, yaml, json или json-rest).

   • --service-type — тип сервиса, для которого требуется вывести записи (mysql-error, mysql-general, mysql-slow-query или mysql-audit).

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

     • hostname — имя хоста.
     • id — идентификатор запроса.
     • message — сообщение, которое выводит сервис.
     • status — статус сообщения, например Note или Warning.

     Примечание

     В примере приведены только основные колонки. Список выводимых колонок зависит от выбранного типа сервиса --service-type.

     Для вывода отдельных колонок передайте параметр --format с указанием формата вывода (yaml, json или json-rest). Колонки не поддерживаются для формата вывода text (установлен по умолчанию).

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

   • --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.yandexcloud.kz/managed-mysql/v1/clusters/<идентификатор_кластера>:logs' \
       --url-query serviceType=<тип_сервиса> \
       --url-query columnFilter=<список_колонок> \
       --url-query fromTime=<левая_граница_временного_диапазона> \
       --url-query toTime=<правая_граница_временного_диапазона>
   

   Где:

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

     • MYSQL_ERROR — лог ошибок, связанных с запуском, работой и остановкой инстансов MySQL®.

     • MYSQL_GENERAL — лог клиентских соединений и запросов.

       По умолчанию лог не ведется. Чтобы включить его, измените значение настройки General log при изменении настроек MySQL®.

     • MYSQL_SLOW_QUERY — лог медленных запросов.

       По умолчанию лог не ведется. Чтобы включить его, измените значение настройки Slow query log при изменении настроек MySQL®. См. также настройки Log slow filter, Log slow rate limit, Log slow rate type, Log slow sp statements и Slow query log always write time.

     • MYSQL_AUDIT — лог аудита.

       По умолчанию лог не ведется. Чтобы включить его, измените значение настройки Audit log при изменении настроек MySQL®.

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

     • hostname — имя хоста;
     • id — идентификатор запроса;
     • message — сообщение, которое выводит сервис;
     • status — статус сообщения, например Note или Warning;
     • raw — информация по всем колонкам в необработанном виде.

     Примечание

     В примере приведены только основные колонки. Список выводимых колонок зависит от выбранного типа сервиса serviceType.

   • 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/mysql/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.yandexcloud.kz:443 \
     yandex.cloud.mdb.mysql.v1.ClusterService.ListLogs
   

   Где:

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

     • MYSQL_ERROR — лог ошибок, связанных с запуском, работой и остановкой инстансов MySQL®.

     • MYSQL_GENERAL — лог клиентских соединений и запросов.

       По умолчанию лог не ведется. Чтобы включить его, измените значение настройки General log при изменении настроек MySQL®.

     • MYSQL_SLOW_QUERY — лог медленных запросов.

       По умолчанию лог не ведется. Чтобы включить его, измените значение настройки Slow query log при изменении настроек MySQL®. См. также настройки Log slow filter, Log slow rate limit, Log slow rate type, Log slow sp statements и Slow query log always write time.

     • MYSQL_AUDIT — лог аудита.

       По умолчанию лог не ведется. Чтобы включить его, измените значение настройки Audit log при изменении настроек MySQL®.

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

     • hostname — имя хоста;
     • id — идентификатор запроса;
     • message — сообщение, которое выводит сервис;
     • status — статус сообщения, например Note или Warning;
     • raw — информация по всем колонкам в необработанном виде.

     Примечание

     В примере приведены только основные колонки. Список выводимых колонок зависит от выбранного типа сервиса service_type.

   • 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.yandexcloud.kz/managed-mysql/v1/clusters/<идентификатор_кластера>:stream_logs' \
       --url-query serviceType=<тип_сервиса> \
       --url-query columnFilter=<список_колонок>
   

   Где:

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

     • MYSQL_ERROR — лог ошибок, связанных с запуском, работой и остановкой инстансов MySQL®.

     • MYSQL_GENERAL — лог клиентских соединений и запросов.

       По умолчанию лог не ведется. Чтобы включить его, измените значение настройки General log при изменении настроек MySQL®.

     • MYSQL_SLOW_QUERY — лог медленных запросов.

       По умолчанию лог не ведется. Чтобы включить его, измените значение настройки Slow query log при изменении настроек MySQL®. См. также настройки Log slow filter, Log slow rate limit, Log slow rate type, Log slow sp statements и Slow query log always write time.

     • MYSQL_AUDIT — лог аудита.

       По умолчанию лог не ведется. Чтобы включить его, измените значение настройки Audit log при изменении настроек MySQL®.

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

     • hostname — имя хоста.
     • id — идентификатор запроса.
     • message — сообщение, которое выводит сервис.
     • status — статус сообщения, например Note или Warning.
     • raw — информация по всем колонкам в необработанном виде.

     Примечание

     В примере приведены только основные колонки. Список выводимых колонок зависит от выбранного типа сервиса serviceType.

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

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/mysql/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<идентификатор_кластера>",
             "service_type": "<тип_сервиса>",
             "column_filter": [
               "<колонка_1>", "<колонка_2>", ..., "<колонка_N>"
             ]
           }' \
       mdb.api.yandexcloud.kz:443 \
       yandex.cloud.mdb.mysql.v1.ClusterService.StreamLogs
   

   Где:

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

     • MYSQL_ERROR — лог ошибок, связанных с запуском, работой и остановкой инстансов MySQL®.

     • MYSQL_GENERAL — лог клиентских соединений и запросов.

       По умолчанию лог не ведется. Чтобы включить его, измените значение настройки General log при изменении настроек MySQL®.

     • MYSQL_SLOW_QUERY — лог медленных запросов.

       По умолчанию лог не ведется. Чтобы включить его, измените значение настройки Slow query log при изменении настроек MySQL®. См. также настройки Log slow filter, Log slow rate limit, Log slow rate type, Log slow sp statements и Slow query log always write time.

     • MYSQL_AUDIT — лог аудита.

       По умолчанию лог не ведется. Чтобы включить его, измените значение настройки Audit log при изменении настроек MySQL®.

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

     • hostname — имя хоста.
     • id — идентификатор запроса.
     • message — сообщение, которое выводит сервис.
     • status — статус сообщения, например Note или Warning.
     • raw — информация по всем колонкам в необработанном виде.

     Примечание

     В примере приведены только основные колонки. Список выводимых колонок зависит от выбранного типа сервиса service_type.

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

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

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

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

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