Skip to main content

ClickHouse® cluster logs

The Logs service is used for logging. For details on how the service works and its cost, see the Logs service overview guide. You can check the Logs service availability across locations in the Logs availability by location guide.

To collect cluster logs in the Logs service, enable logging. You can get logs in the control panel, using API requests, or via AWS CLI. If you no longer need to collect logs, you can disable logging.

Logs are stored for 30 days.

For more information about logs in ClickHouse® databases, see the Logs and traces guide in the ClickHouse® documentation.

Enable logging

You can enable logging via the API or in the Control Panel:

Enable logging in an existing cluster

Logging uses part of the cluster's computing resources. To control the amount of resources consumed, monitor cluster node metrics. For details on how to view metrics, see the Monitoring ClickHouse cluster, node groups, and nodes instructions.

  1. In the control panel, in the top menu, click Products and select Managed Databases.
  2. Open the Active tab.
  3. Open the cluster page → Settings tab.
  4. In the Logging block, in the Log service field, click Connect.
  5. Select a log group or create a new group.
  6. If you selected a new group, enter its name.
  7. Click Save.

Get logs

Use the Get logs guide in the Logs section.

For a ClickHouse® cloud database cluster, the following event streams will be created: clickhouse-<node_role>.log-<instance_id>, where <node_role> is the ClickHouse® cluster node role, and <instance_id> is the ClickHouse cluster node ID.

Disable logging

  1. In the control panel, in the top menu, click Products and select Cloud Databases.
  2. Open the Active tab.
  3. Open the cluster page → Settings tab.
  4. In the Logging section, in the Log service field, click .
  5. Clear the Collect cluster technical logs into log service checkbox.
  6. Click Save.

ClickHouse® is a registered trademark of ClickHouse, Inc. https://clickhouse.com.