[Документация Yandex Cloud](../../index.md) > [Yandex Managed Service for ClickHouse®](../index.md) > [Пошаговые инструкции](index.md) > Логи и мониторинг > Просмотр логов кластера # Просмотр логов кластера ClickHouse® Managed Service for ClickHouse® позволяет [получить фрагмент логов кластера](#get-log) за выбранный период и [просматривать логи в реальном времени](#get-log-stream). {% note info %} Логи кластера хранятся 45 дней. {% endnote %} ## Получить логи кластера {#get-log} {% list tabs group=instructions %} - Консоль управления {#console} 1. В [консоли управления](https://kz.console.yandex.cloud) выберите каталог, в котором находится кластер. 1. Перейдите в сервис **Managed Service for ClickHouse**. 1. Нажмите на имя нужного кластера и выберите вкладку ![image](../../_assets/console-icons/receipt.svg) **Логи**. 1. Укажите период времени, за который нужно отобразить логи: введите его вручную или выберите в календаре, нажав на поле ввода дат. 1. При необходимости укажите хосты и уровень логирования в строке с полем ввода дат. Будет отображен список записей в логе за выбранный период времени. Чтобы посмотреть подробную информацию о событии, нажмите на интересующую запись в списке. Если записей слишком много и отображается только часть из них, нажмите на кнопку **Загрузить еще** в конце списка. - CLI {#cli} Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), [установите и инициализируйте его](../../cli/quickstart.md#install). По умолчанию используется каталог, указанный при [создании](../../cli/operations/profile/profile-create.md) профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду `yc config set folder-id <идентификатор_каталога>`. Также для любой команды вы можете указать другой каталог с помощью параметров `--folder-name` или `--folder-id`. Если вы обращаетесь к ресурсу по имени, поиск будет выполнен в каталоге по умолчанию. Если вы обращаетесь к ресурсу по идентификатору, поиск будет выполнен глобально — во всех каталогах с учетом прав доступа. 1. Просмотрите описание команды CLI для просмотра логов кластера: ```bash yc managed-clickhouse cluster list-logs --help ``` 1. Запустите команду получения логов кластера: ```bash yc managed-clickhouse cluster list-logs <имя_или_идентификатор_кластера> \ --limit <ограничение_количества_записей> \ --columns <список_колонок_для_вывода_информации> \ --filter <настройки_фильтрации_записей> \ --since <левая_граница_временного_диапазона> \ --until <правая_граница_временного_диапазона> ``` Где: * `--limit` — ограничение на количество выводимых записей. * `--columns` — список колонок для вывода информации: * `hostname` — [имя хоста](hosts.md#list-hosts). * `component` — тип компонента, который попадет в лог. Например, `HTTP-Session`. * `message` — сообщение, которое выводит компонент. * `query_id` — идентификатор запроса. * `severity` — уровень логирования, например, `Debug`. * `thread` — идентификатор потока, участвующего в обработке запросов. * `--filter` — настройки фильтрации записей, например `message.hostname='node1.mdb.yandexcloud.kz'`. * `--since` — левая граница временного диапазона в формате [RFC-3339](https://www.ietf.org/rfc/rfc3339.html), `HH:MM:SS` или временного промежутка относительно текущего времени. Примеры: `2006-01-02T15:04:05Z`, `15:04:05`, `2h`, `3h30m ago`. * `--until` — правая граница временного диапазона, формат аналогичен `--since`. Имя и идентификатор кластера можно запросить со [списком кластеров в каталоге](cluster-list.md#list-clusters). - REST API {#api} 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: ```bash export IAM_TOKEN="" ``` 1. Воспользуйтесь методом [Cluster.ListLogs](../api-ref/Cluster/listLogs.md) и выполните запрос, например, с помощью [cURL](https://curl.se/): ```bash curl \ --request GET \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://mdb.api.yandexcloud.kz/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](https://www.ietf.org/rfc/rfc3339.html). Пример: `2006-01-02T15:04:05Z`. * `toTime` — правая граница временного диапазона, формат аналогичен `fromTime`. Идентификатор кластера можно запросить со [списком кластеров в каталоге](cluster-list.md#list-clusters). 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/listLogs.md#responses). - gRPC API {#grpc-api} 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: ```bash export IAM_TOKEN="" ``` 1. Клонируйте репозиторий [cloudapi](https://github.com/yandex-cloud/cloudapi): ```bash cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi ``` Далее предполагается, что содержимое репозитория находится в директории `~/cloudapi/`. 1. Воспользуйтесь вызовом [ClusterService.ListLogs](../api-ref/grpc/Cluster/listLogs.md) и выполните запрос, например, с помощью [gRPCurl](https://github.com/fullstorydev/grpcurl): ```bash 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.yandexcloud.kz: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](https://www.ietf.org/rfc/rfc3339.html). Пример: `2006-01-02T15:04:05Z`. * `to_time` — правая граница временного диапазона, формат аналогичен `from_time`. Идентификатор кластера можно запросить со [списком кластеров в каталоге](cluster-list.md#list-clusters). 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/listLogs.md#yandex.cloud.mdb.clickhouse.v1.ListClusterLogsResponse). {% endlist %} ## Получить поток логов кластера {#get-log-stream} Этот способ позволяет получать логи кластера в реальном времени. {% list tabs group=instructions %} - CLI {#cli} Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), [установите и инициализируйте его](../../cli/quickstart.md#install). По умолчанию используется каталог, указанный при [создании](../../cli/operations/profile/profile-create.md) профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду `yc config set folder-id <идентификатор_каталога>`. Также для любой команды вы можете указать другой каталог с помощью параметров `--folder-name` или `--folder-id`. Если вы обращаетесь к ресурсу по имени, поиск будет выполнен в каталоге по умолчанию. Если вы обращаетесь к ресурсу по идентификатору, поиск будет выполнен глобально — во всех каталогах с учетом прав доступа. Для просмотра логов кластера по мере их поступления выполните команду: ```bash yc managed-clickhouse cluster list-logs <имя_или_идентификатор_кластера> --follow ``` Имя и идентификатор кластера можно запросить со [списком кластеров в каталоге](cluster-list.md#list-clusters). - REST API {#api} 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: ```bash export IAM_TOKEN="" ``` 1. Воспользуйтесь методом [Cluster.StreamLogs](../api-ref/Cluster/streamLogs.md) и выполните запрос, например, с помощью [cURL](https://curl.se/): ```bash curl \ --request GET \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://mdb.api.yandexcloud.kz/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](https://www.ietf.org/rfc/rfc3339.html). Пример: `2006-01-02T15:04:05Z`. * `toTime` — правая граница временного диапазона, формат аналогичен `fromTime`. Если не указывать этот параметр, то в поток логов будут отсылаться новые логи по мере их появления. Это поведение семантически эквивалентно `tail -f`. * `filter` — фильтр логов. Можно отфильтровать логи так, чтобы поток логов содержал только нужные логи. Подробнее о фильтрах и их синтаксисе в [справочнике API](../api-ref/Cluster/streamLogs.md#query_params). {% note tip %} Фильтр может содержать в себе кавычки и другие символы. Экранируйте их, если это необходимо. {% endnote %} Поддерживаемые фильтры: * `message.hostname` — фильтрация по имени хоста. * `message.severity` — фильтрация по уровню логирования. Идентификатор кластера можно запросить со [списком кластеров в каталоге](cluster-list.md#list-clusters). 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/Cluster/streamLogs.md#responses). - gRPC API {#grpc-api} 1. [Получите IAM-токен для аутентификации в API](../api-ref/authentication.md) и поместите токен в переменную среды окружения: ```bash export IAM_TOKEN="" ``` 1. Клонируйте репозиторий [cloudapi](https://github.com/yandex-cloud/cloudapi): ```bash cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi ``` Далее предполагается, что содержимое репозитория находится в директории `~/cloudapi/`. 1. Воспользуйтесь вызовом [ClusterService.StreamLogs](../api-ref/grpc/Cluster/streamLogs.md) и выполните запрос, например, с помощью [gRPCurl](https://github.com/fullstorydev/grpcurl): ```bash 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.yandexcloud.kz: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](https://www.ietf.org/rfc/rfc3339.html). Пример: `2006-01-02T15:04:05Z`. * `to_time` — правая граница временного диапазона, формат аналогичен `from_time`. Если не указывать этот параметр, то в поток логов будут отсылаться новые логи по мере их появления. Это поведение семантически эквивалентно `tail -f`. * `filter` — фильтр логов. Можно отфильтровать логи так, чтобы поток логов содержал только нужные логи. {% note tip %} Фильтр может содержать в себе кавычки и другие символы. Экранируйте их, если это необходимо. {% endnote %} Поддерживаемые фильтры: * `message.hostname` — фильтрация по имени хоста. * `message.severity` — фильтрация по уровню логирования. Подробнее о фильтрах и их синтаксисе в [справочнике API](../api-ref/grpc/Cluster/streamLogs.md). Идентификатор кластера можно запросить со [списком кластеров в каталоге](cluster-list.md#list-clusters). 1. Убедитесь, что запрос был выполнен успешно, изучив [ответ сервера](../api-ref/grpc/Cluster/streamLogs.md#yandex.cloud.mdb.clickhouse.v1.StreamLogRecord). {% endlist %} _ClickHouse® является зарегистрированным товарным знаком [ClickHouse, Inc](https://clickhouse.com)._