https://github.com/chhetripradeep/chtop

💻 ClickHouse Top
https://github.com/chhetripradeep/chtop

clickhouse golang monitoring tui

Last synced: about 1 month ago
JSON representation

💻 ClickHouse Top

• Host: GitHub
• URL: https://github.com/chhetripradeep/chtop
• Owner: chhetripradeep
• Created: 2022-12-27T16:30:12.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-24T12:55:49.000Z (8 months ago)
• Last Synced: 2024-11-12T21:22:54.780Z (2 months ago)
• Topics: clickhouse, golang, monitoring, tui
• Language: Go
• Homepage:
• Size: 104 KB
• Stars: 34
• Watchers: 3
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• charm-in-the-wild - chtop - Monitor your ClickHouse node without leaving the terminal. (_built with Bubble Tea_) (Applications / Database Tools)

README

        
# ClickHouse Top

Show live statistics for monitoring your ClickHouse node.

## Build

```

❯ make build

```

## Usage

It can populate graphs either by pulling metrics from the prometheus exporter 

endpoint of ClickHouse or by running sql queries on ClickHouse native protocol endpoint.

To enable prometheus exporter endpoint for ClickHouse, you will need to add following

ClickHouse server configuration:

```

    

        /metrics

        9363

        true

        true

        true

        true

    

```

```

❯ chtop --help

Monitor your ClickHouse clusters without ever leaving your terminal

Usage:

  chtop [flags]

Flags:

  -c, --config string             path of the config file (default: $HOME/.chtop.yaml)

  -h, --help                      help for chtop

  -m, --metrics-url string        clickhouse url for pulling metrics in prometheus exposition format

  -d, --queries-database string   clickhouse database for connecting from clickhouse client (default "system")

  -p, --queries-password string   clickhouse password of the provided clickhouse user for running clickhouse queries

  -q, --queries-url string        clickhouse endpoint for running clickhouse queries via native protocol

  -u, --queries-username string   clickhouse username for running clickhouse queries (default "default")

```

Run chtop pointing to prometheus stats endpoint & http endpoint of ClickHouse.

Sample Run:

```

❯ chtop --metrics-url http://localhost:9363/metrics --queries-url localhost:9000 --config chtop.yaml

```

## Themes

You can configure the theme (default path: $HOME/.chtop.yaml) 

```

theme:

  graph:

    color: red

    height: 10

    precision: 1

```

## Metrics

You can configure the metrics to plot (default path: $HOME/.chtop.yaml)

```

clickhousemetrics:

  metrics:

    - alias: Total Queries

      name: ClickHouseProfileEvents_Query

    - alias: Total Select Queries

      name: ClickHouseProfileEvents_SelectQuery

    - alias: Total Insert Queries

      name: ClickHouseProfileEvents_InsertQuery

    - alias: Number of Active Parts

      name: ClickHouseMetrics_PartsActive

    - alias: Number of TCP Connections

      name: ClickHouseMetrics_TCPConnection

    - alias: Number of Open File Descriptors

      name: ClickHouseProfileEvents_FileOpen

```

You can configure to run sql queries to populate metrics to plot (default path: $HOME/.chtop.yaml)

```

clickhousequeries:

  queries:

    - name: Number of Running Queries

      sql: "select count(*) from system.processes"

    - name: Number of Databases

      sql: "select count(*) from system.databases"

    - name: Number of Tables

      sql: "select count(*) from system.tables"

    - name: Number of Parts

      sql: "select count(*) from system.parts"

```

## Sample Output



## Thank you

This tool is built using [BubbleTea](https://github.com/charmbracelet/bubbletea), a very neat TUI Framework.

## Todos

- Introduce more panel types.

- Allow to monitor CH clusters.