Prometheus Ruby Client
Usage
require 'prometheus/client'
# returns a default registry
prometheus = Prometheus::Client.registry
# create a new counter metric
http_requests = Prometheus::Client::Counter.new
# register the metric
prometheus.register(:http_requests, 'A counter of the total number of HTTP requests made', http_requests)
# start using the counter
http_requests.increment
Metrics
The following metric types are currently supported.
Counter
A Counter is a metric that exposes merely a sum or tally of things.
Gauge
A Gauge is a metric that exposes merely an instantaneous value or some snapshot thereof.
Todo
- add histogram support
- add push support to a vanilla prometheus exporter
- add tests for Rack middlewares
- use a more performant JSON library
Tests
Install necessary development gems with bundle install
and run tests with
rspec:
rspec