aecolley / client_bash

Client Bash library for talking to the Prometheus pushgateway

Typical usage:

io::prometheus::NewGauge name=start_time help='When the run began'
start_time set "$(date +%s)"
io::prometheus::PushAdd job=cronjob instance='' gateway=:9091

: main cron job code goes here

io::prometheus::NewGauge name=end_time help='When the run ended'
end_time set "$(date +%s)"
io::prometheus::PushAdd job=cronjob instance='' gateway=:9091

This is a library to help you push metrics from your Bash script to a Prometheus pushgateway server.

It's written to use GNU Bash's features, mainly because the basic POSIX shell doesn't support the local keyword.

The library is still missing some essential features such as documentation and non-gauge metrics.

client_bash's Issues

Losing label assign causes gauge push failed.

NewGauge step with multiple labels

io::prometheus::NewGauge name=sample_count help='' labels=path,path2

set one and push

#record1
sample_count -path=/path/any set 1 
#record2
sample_count -path=/path/any -path2=/path/any2 set 2 
#io::prometheus::PushAdd  ......

result

the first record will fail to be pushed into the gateway
the second record will suc

`io::prometheus::DiscardAllMetrics': not a valid identifier

sh +x test_promethesu.bash
./prometheus.bash: line 91: `io::prometheus::DiscardAllMetrics': not a valid identifier