Prometheus Metrics for Opossum Circuit Breaker
This module provides Prometheus metrics for
opossum circuit breakers. To use
it with your circuit breakers, just pass them in to the PrometheusMetrics
constructor.
Example:
const CircuitBreaker = require('opossum');
const PrometheusMetrics = require('opossum-prometheus');
// create a couple of circuit breakers
const c1 = new CircuitBreaker(someFunction);
const c2 = new CircuitBreaker(someOtherfunction);
// Provide them to the constructor
const prometheus = new PrometheusMetrics([c1, c2]);
//...
// Provide other circuit breaker later
const c3 = new CircuitBreaker(someOtherfunction3);
prometheus.add([C3]);
// Write metrics to the console
console.log(prometheus.metrics);
This module would typically be used in an application that can provide an endpoint for the Prometheus server to monitor.
The prometheusRegistry
constructor parameter allows you to provide an existing
prom-client registry.
The metrics about the circuit will be added to the provided registry instead
of the global registry.
The default metrics
will not be added to the provided registry.
const CircuitBreaker = require('opossum');
const PrometheusMetrics = require('opossum-prometheus');
const { Registry } = require('prom-client');
// Create a registry
const registry = new Registry();
// create a circuit
const circuit = new CircuitBreaker(functionThatMightFail);
const metrics = new PrometheusMetrics(circuit, registry)