[WIP] textual-prometheus

Simple tool to query prometheus/thanos API and plot query results in the terminal.

Features

• Simple configuration
• All fields use textual-autocomplete
• graphs generated thanks to plotext
• Instance and metric fields are dynamic and are updated based on what's available on the api
• Simple history of previous graphs
• As long as there are not too many outputs, supports promql regex syntax for both instance and metric fields

Limitations

• Timeframe is currently hardcoded to the last 30d with a bucket size of 1h
• Will currently auto-update only once every 60s

Installation

Since this package is still in development and not ready for release, the simplest way to install it is with pipx.

pipx install git+https://github.com/UmBsublime/textual-prometheus.git

Configuration

You can find an example configuration here. Simply rename the file to config.toml and edit the values.

The tool will look for a config file in the following order, first found, first used:

• ./config.toml
• ~/.config/tprom/config.toml
• /etc/tprom/config.toml

Usage

Once installed with pipx you will have the tprom cli added to ~/.local/bin/. Assuming ~/.local/bin/ is part of your PATH variable you can simply run tprom in your terminal.

TODO

Non-exhaustive list of features I might implement one day.

• Date picker for the query
• Ensure fields are generated in a thread (non-blocking)
• Ability to write the graph to a file
• Allow for the refresh-rate to be configurable