/usr/bin/chdig

Dig into ClickHouse with TUI interface

Usage: chdig [OPTIONS] [COMMAND]

Commands:
  queries                       Show now running queries (from system.processes)
  last-queries                  Show last running queries (from system.query_log)
  slow-queries                  Show slow (slower then 1 second, ordered by duration) queries (from system.query_log)
  query-patterns                Show queries grouped by normalized_query_hash with duration distribution (from system.query_log)
  merges                        Show merges for MergeTree engine (system.merges)
  s3-queue                      Show S3 Queue (system.s3queue_metadata_cache)
  azure-queue                   Show Azure Queue (system.azure_queue_metadata_cache)
  mutations                     Show mutations for MergeTree engine (system.mutations)
  replication-queue             Show replication queue for ReplicatedMergeTree engine (system.replication_queue)
  replicated-fetches            Show fetches for ReplicatedMergeTree engine (system.replicated_fetches)
  replicas                      Show information about replicas (system.replicas)
  tables                        Tables
  errors                        Show all errors that happened in a server since start (system.errors)
  error-log                     Show errors over time (system.error_log)
  backups                       Show information about backups (system.backups)
  dictionaries                  Show information about dictionaries (system.dictionaries)
  server-logs                   Show server logs (system.text_log)
  loggers                       Show loggers (system.text_log)
  background-schedule-pool      Show background schedule pool tasks (system.background_schedule_pool)
  background-schedule-pool-log  Show background schedule pool logs (system.background_schedule_pool_log)
  table-parts                   Show table parts (system.parts)
  asynchronous-inserts          Show asynchronous inserts (system.asynchronous_inserts)
  part-log                      Show part log (system.part_log)
  metric-log                    Show metrics with average per-second rates (system.metric_log)
  asynchronous-metric-log       Show asynchronous metrics with average values (system.asynchronous_metric_log)
  client                        Spawn client inside chdig
  export                        Export data in various formats
  help                          Print this message or the help of the given subcommand(s)

Options:
  -u, --url <URL>
          [env: CHDIG_URL=]
      --host <HOST>
          Overrides host in --url (for clickhouse-client compatibility) [env: CLICKHOUSE_HOST=]
      --port <PORT>
          Overrides port in --url (for clickhouse-client compatibility)
      --user <USER>
          Overrides user in --url (for clickhouse-client compatibility) [env: CLICKHOUSE_USER=]
      --password <PASSWORD>
          Overrides password in --url (for clickhouse-client compatibility) [env: CLICKHOUSE_PASSWORD=]
      --secure
          Overrides secure=1 in --url (for clickhouse-client compatibility)
  -k, --accept-invalid-certificate
          Do not verify the server TLS certificate (overrides skip_verify=1 in --url, for clickhouse-client compatibility) [aliases: --skip-verify, --insecure]
      --config <CONFIG>
          ClickHouse like config (with some advanced features) [env: CLICKHOUSE_CONFIG=]
  -C, --connection <CONNECTION>

  -c, --cluster <CLUSTER>

      --database <DATABASE>
          Database with the system tables, e.g. a preserved copy; overrides database in --url (for clickhouse-client compatibility; default: system) [env: CLICKHOUSE_DATABASE=]
      --history
          Aggregate system.*_log historical data, using merge()
      --no-history

      --internal-queries
          Do not hide internal (spawned by chdig) queries
      --no-internal-queries

      --limit <LIMIT>
          Limit for logs [default: 1000000]
      --logs-order <LOGS_ORDER>
          Sort order for logs (desc returns the newest --limit rows, useful for long backups) [default: asc] [possible values: asc, desc]
      --skip-unavailable-shards
          Skip unavailable shards in distributed queries
  -d, --delay-interval <DELAY_INTERVAL>
          [default: 30000]
  -g, --group-by
          Grouping distributed queries (turned on by default in --cluster mode)
  -G, --no-group-by

      --no-subqueries
          Do not accumulate metrics for subqueries in the initial query
  -b, --start <START>
          Use short option -b, like atop(1) has Begin of the time interval to look at [default: 1hour]
  -e, --end <END>
          End of the time interval [default: ""]
      --wrap
          Wrap long lines
      --no-strip-hostname-suffix
          Disable stripping common hostname prefix and suffix in queries and logs views
      --no-color
          Disable relative log-scale row coloring (e.g. query duration coloring in the query patterns view)
      --queries-limit <QUERIES_LIMIT>
          Limit for number of queries to render in queries views [default: 10000]
      --query-id <QUERY_ID>
          Specified query_id for commands that support it
  -o, --output <PATH>
          Output path for CLI export (derived automatically when omitted)
      --completion <COMPLETION>
          [possible values: bash, elvish, fish, powershell, zsh]
      --log <LOG>
          Log (for debugging chdig itself)
      --pastila-clickhouse-host <PASTILA_CLICKHOUSE_HOST>
          Pastila ClickHouse backend for uploading and sharing flamegraphs [default: https://uzg8q0g12h.eu-central-1.aws.clickhouse.cloud/?user=paste]
      --pastila-url <PASTILA_URL>
          pastila.nl URL (only to show direct link to pastila in logs) [default: https://pastila.nl/]
      --chdig-config <CHDIG_CONFIG>
          Path to chdig config file (YAML) [env: CHDIG_CONFIG=]
  -h, --help
          Print help
  -V, --version
          Print version