Package io.github.resilience4j.micrometer.tagged

Class TaggedCircuitBreakerMetrics

java.lang.Object

io.github.resilience4j.micrometer.tagged.TaggedCircuitBreakerMetrics

All Implemented Interfaces:

io.micrometer.core.instrument.binder.MeterBinder

public class TaggedCircuitBreakerMetrics
extends java.lang.Object
implements io.micrometer.core.instrument.binder.MeterBinder

A micrometer binder that is used to register CircuitBreaker exposed metrics.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.concurrent.ConcurrentMap<java.lang.String,java.util.Set<io.micrometer.core.instrument.Meter.Id>>	meterIdMap
protected CircuitBreakerMetricNames	names

Method Summary

Modifier and Type	Method	Description
protected void	addMetrics(io.micrometer.core.instrument.MeterRegistry meterRegistry, io.github.resilience4j.circuitbreaker.CircuitBreaker circuitBreaker)
void	bindTo(io.micrometer.core.instrument.MeterRegistry registry)
static TaggedCircuitBreakerMetrics	ofCircuitBreakerRegistry(io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry)	Creates a new binder that uses given registry as source of circuit breakers.
static TaggedCircuitBreakerMetrics	ofCircuitBreakerRegistry(io.github.resilience4j.micrometer.tagged.AbstractCircuitBreakerMetrics.MetricNames circuitBreakerMetricNames, io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry)	Deprecated. Use ofCircuitBreakerRegistry(CircuitBreakerMetricNames, CircuitBreakerRegistry) instead
static TaggedCircuitBreakerMetrics	ofCircuitBreakerRegistry(CircuitBreakerMetricNames circuitBreakerMetricNames, io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry)	Creates a new binder that uses given registry as source of circuit breakers.

Methods inherited from class java.lang.Object

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

Field Detail

names

protected final CircuitBreakerMetricNames names

meterIdMap

protected java.util.concurrent.ConcurrentMap<java.lang.String,java.util.Set<io.micrometer.core.instrument.Meter.Id>> meterIdMap

Method Detail

ofCircuitBreakerRegistry

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

Creates a new binder that uses given registry as source of circuit breakers.

Parameters:

circuitBreakerRegistry - the source of circuit breakers

Returns:

The TaggedCircuitBreakerMetrics instance.

ofCircuitBreakerRegistry

public static TaggedCircuitBreakerMetrics ofCircuitBreakerRegistry(CircuitBreakerMetricNames circuitBreakerMetricNames,
                                                                   io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry)

Creates a new binder that uses given registry as source of circuit breakers.

Parameters:

circuitBreakerMetricNames - custom metric names

circuitBreakerRegistry - the source of circuit breakers

Returns:

The TaggedCircuitBreakerMetrics instance.

ofCircuitBreakerRegistry

@Deprecated
public static TaggedCircuitBreakerMetrics ofCircuitBreakerRegistry(io.github.resilience4j.micrometer.tagged.AbstractCircuitBreakerMetrics.MetricNames circuitBreakerMetricNames,
                                                                   io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry)

Deprecated.

Use ofCircuitBreakerRegistry(CircuitBreakerMetricNames, CircuitBreakerRegistry) instead

Creates a new binder that uses given registry as source of circuit breakers.

Parameters:

circuitBreakerMetricNames - custom metric names

circuitBreakerRegistry - the source of circuit breakers

Returns:

The TaggedCircuitBreakerMetrics instance.

bindTo

public void bindTo(io.micrometer.core.instrument.MeterRegistry registry)

Specified by:

bindTo in interface io.micrometer.core.instrument.binder.MeterBinder

addMetrics

protected void addMetrics(io.micrometer.core.instrument.MeterRegistry meterRegistry,
                          io.github.resilience4j.circuitbreaker.CircuitBreaker circuitBreaker)