Package io.github.resilience4j.prometheus.collectors

Class CircuitBreakerMetricsCollector

java.lang.Object

io.prometheus.client.Collector

io.github.resilience4j.prometheus.AbstractCircuitBreakerMetrics

io.github.resilience4j.prometheus.collectors.CircuitBreakerMetricsCollector

public class CircuitBreakerMetricsCollector
extends AbstractCircuitBreakerMetrics

Collects circuit breaker exposed CircuitBreaker.Metrics.

Nested Class Summary

Nested classes/interfaces inherited from class io.github.resilience4j.prometheus.AbstractCircuitBreakerMetrics

AbstractCircuitBreakerMetrics.MetricNames, AbstractCircuitBreakerMetrics.MetricOptions

Nested classes/interfaces inherited from class io.prometheus.client.Collector

io.prometheus.client.Collector.Describable, io.prometheus.client.Collector.MetricFamilySamples, io.prometheus.client.Collector.Type

Field Summary

Fields inherited from class io.github.resilience4j.prometheus.AbstractCircuitBreakerMetrics

callsHistogram, collectorRegistry, KIND_FAILED, KIND_IGNORED, KIND_NOT_PERMITTED, KIND_SUCCESSFUL, NAME_AND_STATE, names

Fields inherited from class io.prometheus.client.Collector

MILLISECONDS_PER_SECOND, NANOSECONDS_PER_SECOND

Method Summary

Modifier and Type	Method	Description
java.util.List<io.prometheus.client.Collector.MetricFamilySamples>	collect()
static CircuitBreakerMetricsCollector	ofCircuitBreakerRegistry(io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry)	Creates a new collector using given registry as source of circuit breakers.
static CircuitBreakerMetricsCollector	ofCircuitBreakerRegistry(AbstractCircuitBreakerMetrics.MetricNames names, io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry)	Creates a new collector with custom metric names and using given supplier as source of circuit breakers.
static CircuitBreakerMetricsCollector	ofCircuitBreakerRegistry(AbstractCircuitBreakerMetrics.MetricNames names, AbstractCircuitBreakerMetrics.MetricOptions options, io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry)	Creates a new collector with custom metric names and using given supplier as source of circuit breakers.

Methods inherited from class io.github.resilience4j.prometheus.AbstractCircuitBreakerMetrics

addMetrics, collectGaugeSamples

Methods inherited from class io.prometheus.client.Collector

checkMetricLabelName, checkMetricName, doubleToGoString, register, register, sanitizeMetricName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

ofCircuitBreakerRegistry

public static CircuitBreakerMetricsCollector ofCircuitBreakerRegistry(AbstractCircuitBreakerMetrics.MetricNames names, AbstractCircuitBreakerMetrics.MetricOptions options, io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry)

Creates a new collector with custom metric names and using given supplier as source of circuit breakers.

Parameters:

names - the custom metric names

options - the custom metric options

circuitBreakerRegistry - the source of circuit breakers

ofCircuitBreakerRegistry

public static CircuitBreakerMetricsCollector ofCircuitBreakerRegistry(AbstractCircuitBreakerMetrics.MetricNames names, io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry)

Creates a new collector with custom metric names and using given supplier as source of circuit breakers.

Parameters:

names - the custom metric names

circuitBreakerRegistry - the source of circuit breakers

ofCircuitBreakerRegistry

public static CircuitBreakerMetricsCollector ofCircuitBreakerRegistry(io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry)

Creates a new collector using given registry as source of circuit breakers.

Parameters:

circuitBreakerRegistry - the source of circuit breakers

collect

public java.util.List<io.prometheus.client.Collector.MetricFamilySamples> collect()

Specified by:

collect in class io.prometheus.client.Collector