Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pinax-network/substreams-sink-prometheus.rs
Substreams Prometheus sink module
https://github.com/pinax-network/substreams-sink-prometheus.rs
firehose pinax streamingfast substreams thegraph
Last synced: about 15 hours ago
JSON representation
Substreams Prometheus sink module
- Host: GitHub
- URL: https://github.com/pinax-network/substreams-sink-prometheus.rs
- Owner: pinax-network
- License: apache-2.0
- Created: 2023-01-31T11:29:20.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-02T20:52:29.000Z (3 months ago)
- Last Synced: 2024-08-03T23:18:08.637Z (3 months ago)
- Topics: firehose, pinax, streamingfast, substreams, thegraph
- Language: Rust
- Homepage: https://docs.rs/substreams-sink-prometheus
- Size: 239 KB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
- awesome-substreams - PrometheusOperations - [`sf.substreams.sink.prometheus.v1`](https://github.com/pinax-network/substreams-sink-prometheus.rs/blob/main/proto/substreams/sink/prometheus/v1/prometheus.proto) (Protobuf / Sinks)
README
# [`Substreams`](https://substreams.streamingfast.io/) [Prometheus](https://prometheus.io/) sink module (**Rust**)
[
](https://github.com/pinax-network/substreams-sink-prometheus.rs)
[
](https://crates.io/crates/substreams-sink-prometheus)
[
](https://docs.rs/substreams-sink-prometheus)
[
](https://github.com/pinax-network/substreams-sink-prometheus.rs/actions?query=branch%3Amain)
> `pinax.substreams.sink.prometheus.v1` protobuf module for [`Substreams`](https://substreams.streamingfast.io/) Rust implementation.
## 📖 Documentation
### https://docs.rs/substreams-sink-prometheus
### Further resources
- [**Substreams** documentation](https://substreams.streamingfast.io)
- [**Prometheus** documentation](https://prometheus.io)
- [**Substreams Sink Prometheus** CLI `Node.js`](https://github.com/pinax-network/substreams-sink-prometheus)
## 🛠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)
- [x] Observe
- [ ] buckets
- [x] Zero
### [Summary Metric](https://pkg.go.dev/github.com/prometheus/client_golang/prometheus#Summary)
> Summaries calculate percentiles of observed values.
- [x] Observe
- [ ] percentiles
- [ ] maxAgeSeconds
- [ ] ageBuckets
- [ ] compressCount
- [x] 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, Summary, Histogram};
#[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 decrease 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 increase 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());
// Summary Metric
// ==============
// Initialize Summary
let mut summary = Summary::from("summary_name");
/// Observe adds a single observation to the summary.
/// Observations are usually positive or zero.
/// Negative observations are accepted but prevent current versions of Prometheus from properly detecting counter resets in the sum of observations
prom_ops.push(summary.observe(88.8));
// Start a timer. Calling the returned function will observe the duration in seconds in the summary.
prom_ops.push(summary.start_timer());
// Histogram Metric
// ==============
// Initialize Summary
let mut histogram = Histogram::from("histogram_name");
/// Observe adds a single observation to the histogram.
/// Observations are usually positive or zero.
/// Negative observations are accepted but prevent current versions of Prometheus from properly detecting counter resets in the sum of observations
prom_ops.push(histogram.observe(88.8));
// Start a timer. Calling the returned function will observe the duration in seconds in the histogram.
prom_ops.push(histogram.start_timer());
// Initialize the metrics for the given combination of labels to zero
prom_ops.push(histogram.zero(HashMap::from([("label1".to_string(), "value1".to_string())])));
Ok(prom_ops)
}
```