Contact UsGet started

Viewing ClickHouse® cluster logs

Written by
Updated at November 18, 2024

Managed Service for ClickHouse® allows you to get a cluster log snippet for the selected period and view logs in real time.

Note

Cluster logs are kept for 30 days.

Getting cluster logs

  1. Go to the folder page and select Managed Service for ClickHouse.
  2. Click the name of the cluster you need and select the Logs tab.
  3. Specify the time period you want the log info for: enter it manually or select in the calendar using the date input field.
  4. Specify the hosts and logging level in the line with the date input field if needed.

A list of log entries for the selected time period will be displayed. To view detailed information about an event, click the respective entry in the list.

If there are too many records and not all of them are displayed, click Load more at the end of the list.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

  1. View the description of the CLI command to view cluster logs:

    yc managed-clickhouse cluster list-logs --help

  2. Run this command to get cluster logs:

    yc managed-clickhouse cluster list-logs <cluster_name_or_ID> \
   --limit <entry_number_limit> \
   --columns <list_of_columns_for_data_output> \
   --filter <entry_filtration_settings> \
   --since <time_range_left_boundary> \
   --until <time_range_right_boundary>

    Where:

    • --limit: limits on the number of entries to output.

    • --columns: List of columns for data output:
      • hostname: Host name.
      • component: Type of component to log, e.g., HTTP-Session.
      • message: Message output by the component.
      • query_id: Request ID.
      • severity: Logging level, e.g., Debug.
      • thread: ID of the thread involved in query handling.

    • --filter: record filter settings, for example, message.hostname='node1.mdb.yandexcloud.net'.

    • --since: Left boundary of a time range in RFC-3339, HH:MM:SS format or a time interval relative to the current time. Examples: 2006-01-02T15:04:05Z, 15:04:05, 2h, 3h30m ago.

    • --until: right boundary of a time range, the format is similar to that of --since.

You can request the cluster name and ID with a list of clusters in the folder.

To get cluster logs, use the listLogs REST API method for the Cluster resource or the ClusterService/ListLogs gRPC API call, and provide the following in the request:

Getting a cluster log stream

This method allows you to get cluster logs in real time.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To view cluster logs as they become available, run this command:

yc managed-clickhouse cluster list-logs <cluster_name_or_ID> --follow

You can request the cluster name and ID with a list of clusters in the folder.

To get a cluster log stream, use the streamLogs REST API method for the Cluster resource or the ClusterService/StreamLogs gRPC API call, and provide in the request:

ClickHouse® is a registered trademark of ClickHouse, Inc.

Previous
Managing shard groups
Next
Monitoring the state of clusters and hosts