Skip to content

System Log Introspection

DataStoria provides powerful system log introspection tools that allow you to analyze ClickHouse system tables in detail. These tools help you understand query patterns, identify performance issues, debug errors, and monitor data part operations across your cluster.

Overview

Currently these system tables are supported:

You can access these introspection tools from the side bar icon button as shown below:

system-table-introspection-1

Available System Tables

system.opentelemetry_span_log

The OpenTelemetry Span Log Introspection tool analyzes spans in system.opentelemetry_span_log. View trace span distribution by time and kind, filter by hostname (FQDN) and span kind, and open individual traces via trace ID links for distributed tracing and observability.

Learn more about system.opentelemetry_span_log →

system.query_log

The Query Log Introspection tool provides deep insights into all queries executed on your ClickHouse cluster. It includes comprehensive filtering, distribution charts, and AI-powered optimization suggestions.

Learn more about system.query_log →

system.query_views_log

The Query Views Log Introspection tool provides insights into all query view executions on your ClickHouse cluster. It tracks how materialized views, live views, and other view types are being executed, including their performance metrics, read/write patterns, and error information.

Learn more about system.query_views_log →

system.part_log

The Part Log Introspection tool tracks all part-level operations in your ClickHouse cluster, including merges, mutations, downloads, and removals. Monitor merge activity, track part creation, and identify mutation patterns.

Learn more about system.part_log →

system.ddl_distribution_queue

The DDL Distribution Queue Introspection tool provides insights into distributed DDL operations across your ClickHouse cluster. It tracks how DDL statements (CREATE, ALTER, DROP, etc.) are distributed and executed across cluster nodes, helping you monitor DDL operation status, identify failures, and track execution progress.

Learn more about system.ddl_distribution_queue →

system.zookeeper

The ZooKeeper Introspection tool provides a tree-table interface to browse and inspect ZooKeeper data used by your ClickHouse cluster. Explore the hierarchical structure of znodes, view node values, and inspect metadata such as creation time, modification time, and child counts.

Learn more about system.zookeeper →

Common Features

All system log introspection tools share common features:

  • Time-based Filtering: Flexible time range selection for historical analysis
  • Multi-dimensional Filtering: Filter by hostname, database, table, and more
  • Visual Analytics: Charts and tables for pattern recognition
  • Server-side Sorting: Sort by any column for efficient data exploration
  • Pagination: Navigate through large result sets efficiently
  • AI Integration: Get optimization suggestions and error explanations

Best Practices

Regular Monitoring

  1. Daily Review: Check query and part logs daily
  2. Set Baselines: Establish normal operation patterns
  3. Alert on Anomalies: Identify unusual patterns
  4. Track Trends: Monitor metrics over time

Performance Optimization

  1. Identify Slow Operations: Sort by duration
  2. Use AI Features: Leverage AI optimization and error explanation
  3. Compare Time Periods: Use time range selector to compare performance
  4. Filter Strategically: Use filters to focus on relevant data

Troubleshooting

  1. Start Broad: Begin with wide time ranges
  2. Narrow Down: Use filters to focus on specific issues
  3. Use AI: Get AI-powered insights for complex problems
  4. Cross-reference: Use Query ID links to connect query and part logs

Security and Compliance

  1. User Auditing: Filter by user to track access patterns
  2. Table Access: Monitor which tables are accessed
  3. Error Review: Regularly review exception logs
  4. Export Logs: Use table features for compliance reporting

Limitations

  • System Table Access: Requires read access to system tables
  • Log Retention: Data availability depends on ClickHouse log retention settings
  • Performance: Querying large time ranges may be slow
  • Version Compatibility: Some features may vary by ClickHouse version
  • Cluster Mode: Some filters are only available in cluster mode

Next Steps

Released under the Apache License 2.0