> For the complete documentation index, see [llms.txt](https://docs.substreams.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.substreams.dev/how-to-guides/sinks/community-sinks/prometheus.md). # Prometheus [![github](https://img.shields.io/badge/Github-substreams.prometheus-8da0cb?style=for-the-badge\&logo=github)](https://github.com/pinax-network/substreams-sink-prometheus) [![crates.io](https://img.shields.io/crates/v/substreams-sink-prometheus.svg?style=for-the-badge\&color=fc8d62\&logo=rust)](https://crates.io/crates/substreams-sink-prometheus) [![npm](https://img.shields.io/npm/v/substreams-sink-prometheus.svg?style=for-the-badge\&color=CB0001\&logo=npm)](https://www.npmjs.com/package/substreams-sink-prometheus) [![docs.rs](https://img.shields.io/badge/docs.rs-substreams.prometheus-66c2a5?style=for-the-badge\&labelColor=555555\&logo=docs.rs)](https://docs.rs/substreams-sink-prometheus) [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/pinax-network/substreams-sink-prometheus/ci.yml?branch=main\&style=for-the-badge)](https://github.com/pinax-network/substreams-sink-prometheus/actions?query=branch%3Amain) > `substreams-sink-prometheus` is a tool that allows developers to pipe data extracted metrics from a blockchain into a Prometheus time series database. ## 📖 Documentation ### ### Further resources * [Substreams documentation](/getting-started.md) * [Prometheus documentation](https://prometheus.io) ## CLI [**Use pre-built binaries**](https://github.com/pinax-network/substreams-sink-prometheus/releases) * [x] MacOS * [x] Linux * [x] Windows **Install** globally via npm ``` $ npm install -g substreams-sink-prometheus ``` **Run** ``` $ substreams-sink-prometheus run [options] ``` > Open the browser at ## 🛠 Feature Roadmap ### [Gauge Metric](https://pkg.go.dev/github.com/prometheus/client_golang/prometheus#Gauge) * [x] Set * [x] Inc * [x] Dec * [x] Add * [x] Sub * [x] SetToCurrentTime * [x] Remove * [x] Reset ### [Counter Metric](https://pkg.go.dev/github.com/prometheus/client_golang/prometheus#Counter) * [x] Inc * [x] Add * [x] Remove * [x] Reset ### [Histogram Metric](https://pkg.go.dev/github.com/prometheus/client_golang/prometheus#Histogram) * [ ] Observe * [ ] buckets * [ ] zero ### [Summary Metric](https://pkg.go.dev/github.com/prometheus/client_golang/prometheus#Summary) > Summaries calculate percentiles of observed values. * [ ] Observe * [ ] percentiles * [ ] maxAgeSeconds * [ ] ageBuckets * [ ] startTimer ### [Registry](https://pkg.go.dev/github.com/prometheus/client_golang/prometheus#Registry) * [ ] Clear * [ ] SetDefaultLabels * [ ] RemoveSingleMetric ## Install ```bash $ cargo add substreams-sink-prometheus ``` ## Quickstart **Cargo.toml** ```toml [dependencies] substreams = "0.5" substreams-sink-prometheus = "0.1" ``` **src/lib.rs** ```rust use std::collections::HashMap; use substreams::prelude::*; use substreams::errors::Error; use substreams_sink_prometheus::{PrometheusOperations, Counter, Gauge}; #[substreams::handlers::map] fn prom_out( ... some stores ... ) -> Result { // Initialize Prometheus Operations container let mut prom_ops: PrometheusOperations = Default::default(); // Counter Metric // ============== // Initialize Gauge with a name & labels let mut counter = Counter::from("counter_name"); // Increments the Counter by 1. prom_ops.push(counter.inc()); // Adds an arbitrary value to a Counter. (Returns an error if the value is < 0.) prom_ops.push(counter.add(123.456)); // Labels // ====== // Create a HashMap of labels // Labels represents a collection of label name -> value mappings. let labels1 = HashMap::from([("label1".to_string(), "value1".to_string())]); let mut labels2 = HashMap::new(); labels2.insert("label2".to_string(), "value2".to_string()); // Gauge Metric // ============ // Initialize Gauge let mut gauge = Gauge::from("gauge_name").with(labels1); // Sets the Gauge to an arbitrary value. prom_ops.push(gauge.set(88.8)); // Increments the Gauge by 1. prom_ops.push(gauge.inc()); // Decrements the Gauge by 1. prom_ops.push(gauge.dec()); // Adds an arbitrary value to a Gauge. (The value can be negative, resulting in a rease of the Gauge.) prom_ops.push(gauge.add(50.0)); prom_ops.push(gauge.add(-10.0)); // Subtracts arbitrary value from the Gauge. (The value can be negative, resulting in an rease of the Gauge.) prom_ops.push(gauge.sub(25.0)); prom_ops.push(gauge.sub(-5.0)); // Set Gauge to the current Unix time in seconds. prom_ops.push(gauge.set_to_current_time()); // Remove metrics for the given label values prom_ops.push(gauge.remove(labels2)); // Reset gauge values prom_ops.push(gauge.reset()); Ok(prom_ops) } ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.substreams.dev/how-to-guides/sinks/community-sinks/prometheus.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.