https://github.com/umbsublime/textual-prometheus
Terminal prometheus query tool build with textual
https://github.com/umbsublime/textual-prometheus
prometheus textual tui
Last synced: 6 months ago
JSON representation
Terminal prometheus query tool build with textual
- Host: GitHub
- URL: https://github.com/umbsublime/textual-prometheus
- Owner: UmBsublime
- Created: 2023-02-27T18:29:59.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-01T17:46:34.000Z (over 2 years ago)
- Last Synced: 2025-03-28T20:38:56.834Z (6 months ago)
- Topics: prometheus, textual, tui
- Language: Python
- Homepage:
- Size: 897 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [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](https://github.com/darrenburns/textual-autocomplete)
- graphs generated thanks to [plotext](https://github.com/piccolomo/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.
```bash
pipx install git+https://github.com/UmBsublime/textual-prometheus.git
```
## Configuration
You can find an example configuration [here](./config.toml.example).
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