cockatiel-prometheus - Prometheus metrics for cockatiel circuit breakers

What is cockatiel-prometheus ?

This module provides Prometheus metrics for cockatiel circuit breakers.

How to Use it ?

Create an instance of CockatielPrometheus like below:

export const cockatielPrometheus = new CockatielPrometheus({ application: 'your-service-name' })

and then add your circuit breaker through its add method like below:

cockatielPrometheus.add('async-function-name', you-cockatiel-circuit-breaker-policy)

Note: Please pass the circuit breaker policy to add method provided by cockatiel library

and to expose the metrics, you can use the following code:

await cockatielPrometheus.metrics()

That's it. You are done. Now you can see the metrics in your Prometheus server.

Example

1import CockatielPrometheus from "./index";
2import { circuitBreaker, retry, wrap } from 'cockatiel'
3
4const yourServiceCircuitBreakerPolicy = circuitBreaker(handleAll, {
5  halfOpenAfter: 5 * 1000,
6  breaker: new ConsecutiveBreaker(3),
7})
8
9const yourServiceRetryPolicy = retry(handleAll, { maxAttempts: 10, backoff: new ExponentialBackoff() })
10
11let cockatielPrometheus = new CockatielPrometheus({application: 'your-service-name'});
12
13cockatielPrometheus.add('async-method-name', yourServiceCircuitBreakerPolicy);
14const yourServiceCB = wrap(yourServiceRetryPolicy, yourServiceCircuitBreakerPolicy)
15
16await yourServiceCB.execute(() => {
17// your async method
18})