Skip to content

go-pluto/styx

Repository files navigation

styx

Export Prometheus data as CSV or directly plot with gnuplot & matplotlib.

Installation

go install github.com/go-pluto/styx@latest

If you want to simply export data from Prometheus as CSV then you don't need to install any thing else.

Optional Dependencies

If you want to plot directly with gnuplot, you need to install gnuplot first.

gnuplot

brew install gnuplot # macOS
apt-get install gnuplot # Debian / Ubuntu
pacman -S gnuplot # ArchLinux

matplotlib

pip install matplotlib
pip2 install matplotlib # macOS

Usage

Once you've installed styx you can export data. My recommendation is to actually build the queries in the Prometheus UI only if you've played with the data there and you know which query is best, copy the query and use it to export the data with styx.

CSV

# export the data for the last hour from http://localhost:9090 
styx 'go_goroutines'
styx 'sum(go_goroutines)'
styx 'go_goroutines{job="prometheus"}'
styx 'go_goroutines > 100'
# export the data for the last 6 hours from http://localhost:9090
styx --duration 6h 'sum(go_goroutines)' 
# export the data from a specific prometheus for the last hour.
styx --prometheus http://prom.example.com 'sum(go_goroutines)' 

gnuplot

# plot the data for the last hour from http://localhost:9090
styx gnuplot 'sum(go_goroutines)' > goroutines.gnuplot
# plot the data for the last 6 hours from http://localhost:9090
styx gnuplot --duration 6h 'sum(go_goroutines)' > goroutines.gnuplot 
# plot the data from a specific prometheus for the last hour.
styx gnuplot --prometheus http://prom.example.com 'sum(go_goroutines)' > goroutines.gnuplot

Once you have written the generated content into a file you can use this to edit and plot the graph:

gnuplot -p < test.gnuplot

matplotlib

# plot the data for the last hour from http://localhost:9090
styx matplotlib 'sum(go_goroutines)' > goroutines.py
# plot the data for the last 6 hours from http://localhost:9090
styx matplotlib --duration 6h 'sum(go_goroutines)' > goroutines.py 
# plot the data from a specific prometheus for the last hour.
styx matplotlib --prometheus http://prom.example.com 'sum(go_goroutines)' > goroutines.py

Once you have written the generated content into a file you can use this to edit and plot the graph:

python goroutines.py