{"repo":"prometheus/client_ruby","free":true,"listed":false,"github":"https://github.com/prometheus/client_ruby","clone":"git clone https://github.com/prometheus/client_ruby.git","description":"Prometheus instrumentation library for Ruby applications","language":"Ruby","stars":559,"topics":["prometheus","ruby-client","ruby","middleware","rack","rack-middleware","prometheus-client-library"],"license":"Apache-2.0","category":"analytics","readme_excerpt":"Prometheus Ruby Client A suite of instrumentation metric primitives for Ruby that can be exposed through a HTTP interface. Intended to be used together with a [Prometheus server][1]. [![Gem Version][4]](http://badge.fury.io/rb/prometheus-client) [![Build Status][3]](https://github.com/prometheus/client ruby/actions/workflows/ci.yml) Usage Installation For a global installation run gem install prometheus-client . If you're using Bundler add gem \"prometheus-client\" to your Gemfile . Make sure to run bundle install afterwards. Overview Rack middleware There are two [Rack][2] middlewares available, one to expose a metrics HTTP endpoint to be scraped by a Prometheus server ([Exporter][9]) and one to trace all HTTP requests ([Collector][10]). It's highly recommended to enable gzip compression for the metrics endpoint, for example by including the Rack::Deflater middleware. Start the server and have a look at the metrics endpoint: http://localhost:5123/metrics. For further instructions and other scripts to get started, have a look at the integrated example application. Pushgateway The Ruby client can also be used to push its collected metrics to a [Pushgateway][8]. This comes in handy with batch jobs or in other scenarios where it's not possible or feasible to let a Prometheus server scrape a Ruby process. TLS and HTTP basic authentication are supported. Basic authentication By design, Prometheus::Client::Push doesn't read credentials for HTTP basic authentication when they are pass","default_branch":null,"files":null,"tree":[],"storefront":"/r/prometheus","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/prometheus/client_ruby/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}