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

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

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

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

   yc managed-clickhouse cluster list-logs --help
   

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

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

   Где:

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

   • --columns — список колонок для вывода информации:
     • hostname — имя хоста.
     • component — тип компонента, который попадет в лог. Например, HTTP-Session.
     • message — сообщение, которое выводит компонент.
     • query_id — идентификатор запроса.
     • severity — уровень логирования, например, Debug.
     • thread — идентификатор потока, участвующего в обработке запросов.

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

   Где:

   • serviceType — тип сервиса, для которого нужно запросить логи. Допустимо только значение CLICKHOUSE.

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

     • hostname — имя хоста.
     • component — тип компонента, который попадет в лог. Например, HTTP-Session.
     • message — сообщение, которое выводит компонент.
     • query_id — идентификатор запроса.
     • severity — уровень логирования, например, Debug.
     • thread — идентификатор потока, участвующего в обработке запросов.

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

   • fromTime — левая граница временного диапазона в формате RFC-3339. Пример: 2006-01-02T15: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/clickhouse/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
               "cluster_id": "<идентификатор_кластера>",
               "service_type" : "CLICKHOUSE",
               "column_filter": [<список_колонок_для_вывода_информации>],
               "from_time": "<левая_граница_временного_диапазона>" \
               "to_time": "<правая_граница_временного_диапазона>"
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.clickhouse.v1.ClusterService.ListLogs
   

   Где:

   • service_type — тип сервиса, для которого нужно запросить логи. Допустимо только значение CLICKHOUSE.

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

     • hostname — имя хоста.
     • component — тип компонента, который попадет в лог. Например, HTTP-Session.
     • message — сообщение, которое выводит компонент.
     • query_id — идентификатор запроса.
     • severity — уровень логирования, например, Debug.
     • thread — идентификатор потока, участвующего в обработке запросов.

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

   • from_time — левая граница временного диапазона в формате RFC-3339. Пример: 2006-01-02T15: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-clickhouse/v1/clusters/<идентификатор_кластера>:stream_logs' \
       --url-query serviceType=CLICKHOUSE \
       --url-query columnFilter=<список_колонок_для_вывода_информации> \
       --url-query fromTime=<левая_граница_временного_диапазона> \
       --url-query toTime=<правая_граница_временного_диапазона> \
       --url-query filter=<фильтр_логов>
   

   Где:

   • serviceType — тип сервиса, для которого нужно запросить логи. Допустимо только значение CLICKHOUSE.

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

     • hostname — имя хоста.
     • component — тип компонента, который попадет в лог. Например, HTTP-Session.
     • message — сообщение, которое выводит компонент.
     • query_id — идентификатор запроса.
     • severity — уровень логирования, например, Debug.
     • thread — идентификатор потока, участвующего в обработке запросов.

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

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

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

     Если не указывать этот параметр, то в поток логов будут отсылаться новые логи по мере их появления. Это поведение семантически эквивалентно tail -f.

   • filter — фильтр логов. Можно отфильтровать логи так, чтобы поток логов содержал только нужные логи.

     Подробнее о фильтрах и их синтаксисе см. в справочнике API.

     Совет

     Фильтр может содержать в себе кавычки и другие символы. Экранируйте их, если это необходимо.

     Поддерживаемые фильтры:

     • message.hostname — фильтрация по имени хоста.
     • message.severity — фильтрация по уровню логирования.

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

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/clickhouse/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
               "cluster_id": "<идентификатор_кластера>",
               "service_type" : "CLICKHOUSE",
               "column_filter": [<список_колонок_для_вывода_информации>],
               "from_time": "<левая_граница_временного_диапазона>",
               "to_time": "<правая_граница_временного_диапазона>",
               "filter": "<фильтр_логов>"
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.clickhouse.v1.ClusterService.StreamLogs
   

   Где:

   • service_type — тип сервиса, для которого нужно запросить логи. Допустимо только значение CLICKHOUSE.

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

     • hostname — имя хоста.
     • component — тип компонента, который попадет в лог. Например, HTTP-Session.
     • message — сообщение, которое выводит компонент.
     • query_id — идентификатор запроса.
     • severity — уровень логирования, например, Debug.
     • thread — идентификатор потока, участвующего в обработке запросов.

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

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

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

     Если не указывать этот параметр, то в поток логов будут отсылаться новые логи по мере их появления. Это поведение семантически эквивалентно tail -f.

   • filter — фильтр логов. Можно отфильтровать логи так, чтобы поток логов содержал только нужные логи.

     Совет

     Фильтр может содержать в себе кавычки и другие символы. Экранируйте их, если это необходимо.

     Поддерживаемые фильтры:

     • message.hostname — фильтрация по имени хоста.
     • message.severity — фильтрация по уровню логирования.

     Подробнее о фильтрах и их синтаксисе см. в справочнике API.

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

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