io.github.resilience4j.metrics

Class CircuitBreakerMetrics

java.lang.Object

io.github.resilience4j.metrics.CircuitBreakerMetrics

All Implemented Interfaces:

com.codahale.metrics.Metric, com.codahale.metrics.MetricSet

public class CircuitBreakerMetrics
extends java.lang.Object
implements com.codahale.metrics.MetricSet

An adapter which exports CircuitBreaker.Metrics as Dropwizard Metrics Gauges.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,com.codahale.metrics.Metric>	getMetrics()
static CircuitBreakerMetrics	ofCircuitBreaker(io.github.resilience4j.circuitbreaker.CircuitBreaker circuitBreaker) Creates a new instance of CircuitBreakerMetrics CircuitBreakerMetrics with a circuit breaker as a source.
static CircuitBreakerMetrics	ofCircuitBreakerRegistry(io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry) Creates a new instance CircuitBreakerMetrics CircuitBreakerMetrics with a CircuitBreakerRegistry as a source.
static CircuitBreakerMetrics	ofCircuitBreakerRegistry(io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry, com.codahale.metrics.MetricRegistry metricRegistry) Creates a new instance CircuitBreakerMetrics CircuitBreakerMetrics with a CircuitBreakerRegistry as a source.
static CircuitBreakerMetrics	ofCircuitBreakerRegistry(java.lang.String prefix, io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry) Creates a new instance CircuitBreakerMetrics CircuitBreakerMetrics with specified metrics names prefix and a CircuitBreakerRegistry as a source.
static CircuitBreakerMetrics	ofCircuitBreakerRegistry(java.lang.String prefix, io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry, com.codahale.metrics.MetricRegistry metricRegistry) Creates a new instance CircuitBreakerMetrics CircuitBreakerMetrics with specified metrics names prefix and a CircuitBreakerRegistry as a source.
static CircuitBreakerMetrics	ofIterable(java.lang.Iterable<io.github.resilience4j.circuitbreaker.CircuitBreaker> circuitBreakers) Creates a new instance CircuitBreakerMetrics CircuitBreakerMetrics with an Iterable of circuit breakers as a source.
static CircuitBreakerMetrics	ofIterable(java.lang.String prefix, java.lang.Iterable<io.github.resilience4j.circuitbreaker.CircuitBreaker> circuitBreakers) Creates a new instance CircuitBreakerMetrics CircuitBreakerMetrics with an Iterable of circuit breakers as a source.

Methods inherited from class java.lang.Object

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

Method Detail

ofCircuitBreakerRegistry

public static CircuitBreakerMetrics ofCircuitBreakerRegistry(java.lang.String prefix,
                                                             io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry,
                                                             com.codahale.metrics.MetricRegistry metricRegistry)

Creates a new instance CircuitBreakerMetrics CircuitBreakerMetrics with specified metrics names prefix and a CircuitBreakerRegistry as a source.

Parameters:

prefix - the prefix of metrics names

circuitBreakerRegistry - the registry of circuit breakers

ofCircuitBreakerRegistry

public static CircuitBreakerMetrics ofCircuitBreakerRegistry(java.lang.String prefix,
                                                             io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry)

Creates a new instance CircuitBreakerMetrics CircuitBreakerMetrics with specified metrics names prefix and a CircuitBreakerRegistry as a source.

Parameters:

prefix - the prefix of metrics names

circuitBreakerRegistry - the registry of circuit breakers

ofCircuitBreakerRegistry

public static CircuitBreakerMetrics ofCircuitBreakerRegistry(io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry,
                                                             com.codahale.metrics.MetricRegistry metricRegistry)

Creates a new instance CircuitBreakerMetrics CircuitBreakerMetrics with a CircuitBreakerRegistry as a source.

Parameters:

circuitBreakerRegistry - the registry of circuit breakers

ofCircuitBreakerRegistry

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

Creates a new instance CircuitBreakerMetrics CircuitBreakerMetrics with a CircuitBreakerRegistry as a source.

Parameters:

circuitBreakerRegistry - the registry of circuit breakers

ofIterable

public static CircuitBreakerMetrics ofIterable(java.lang.Iterable<io.github.resilience4j.circuitbreaker.CircuitBreaker> circuitBreakers)

Creates a new instance CircuitBreakerMetrics CircuitBreakerMetrics with an Iterable of circuit breakers as a source.

Parameters:

circuitBreakers - the circuit breakers

ofIterable

public static CircuitBreakerMetrics ofIterable(java.lang.String prefix,
                                               java.lang.Iterable<io.github.resilience4j.circuitbreaker.CircuitBreaker> circuitBreakers)

Creates a new instance CircuitBreakerMetrics CircuitBreakerMetrics with an Iterable of circuit breakers as a source.

Parameters:

circuitBreakers - the circuit breakers

ofCircuitBreaker

public static CircuitBreakerMetrics ofCircuitBreaker(io.github.resilience4j.circuitbreaker.CircuitBreaker circuitBreaker)

Creates a new instance of CircuitBreakerMetrics CircuitBreakerMetrics with a circuit breaker as a source.

Parameters:

circuitBreaker - the circuit breaker

getMetrics

public java.util.Map<java.lang.String,com.codahale.metrics.Metric> getMetrics()

Specified by:

getMetrics in interface com.codahale.metrics.MetricSet