Class TimeLimiterMetrics

java.lang.Object

io.github.resilience4j.metrics.TimeLimiterMetrics

All Implemented Interfaces:

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

public class TimeLimiterMetrics
extends Object
implements com.codahale.metrics.MetricSet

An adapter which exports TimeLimiter's events as Dropwizard Metrics.

Field Summary

Fields

Modifier and Type	Field	Description
private final com.codahale.metrics.MetricRegistry	metricRegistry

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TimeLimiterMetrics(Iterable<io.github.resilience4j.timelimiter.TimeLimiter> timeLimiters)
private	TimeLimiterMetrics(String prefix, Iterable<io.github.resilience4j.timelimiter.TimeLimiter> timeLimiters, com.codahale.metrics.MetricRegistry metricRegistry)

Method Summary

Modifier and Type	Method	Description
Map<String, com.codahale.metrics.Metric>	getMetrics()
static TimeLimiterMetrics	ofIterable(Iterable<io.github.resilience4j.timelimiter.TimeLimiter> timeLimiters)	Creates a new instance TimeLimiterMetrics with an Iterable of time limiters as a source.
static TimeLimiterMetrics	ofIterable(String prefix, Iterable<io.github.resilience4j.timelimiter.TimeLimiter> timeLimiters)	Creates a new instance TimeLimiterMetrics with an Iterable of time limiters as a source.
static TimeLimiterMetrics	ofTimeLimiter(io.github.resilience4j.timelimiter.TimeLimiter timeLimiter)	Creates a new instance of TimeLimiterMetrics with a time limiter as a source.
static TimeLimiterMetrics	ofTimeLimiterRegistry(io.github.resilience4j.timelimiter.TimeLimiterRegistry timeLimiterRegistry)	Creates a new instance TimeLimiterMetrics with a TimeLimiterRegistry as a source.
static TimeLimiterMetrics	ofTimeLimiterRegistry(io.github.resilience4j.timelimiter.TimeLimiterRegistry timeLimiterRegistry, com.codahale.metrics.MetricRegistry metricRegistry)	Creates a new instance TimeLimiterMetrics with a TimeLimiterRegistry as a source.
static TimeLimiterMetrics	ofTimeLimiterRegistry(String prefix, io.github.resilience4j.timelimiter.TimeLimiterRegistry timeLimiterRegistry)	Creates a new instance TimeLimiterMetrics with specified metrics names prefix and a TimeLimiterRegistry as a source.
static TimeLimiterMetrics	ofTimeLimiterRegistry(String prefix, io.github.resilience4j.timelimiter.TimeLimiterRegistry timeLimiterRegistry, com.codahale.metrics.MetricRegistry metricRegistry)	Creates a new instance TimeLimiterMetrics with specified metrics names prefix and a TimeLimiterRegistry as a source.

Methods inherited from class Object

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

Field Details

metricRegistry

private final com.codahale.metrics.MetricRegistry metricRegistry

Constructor Details

TimeLimiterMetrics

private TimeLimiterMetrics(Iterable<io.github.resilience4j.timelimiter.TimeLimiter> timeLimiters)

TimeLimiterMetrics

private TimeLimiterMetrics(String prefix,
 Iterable<io.github.resilience4j.timelimiter.TimeLimiter> timeLimiters,
 com.codahale.metrics.MetricRegistry metricRegistry)

Method Details

ofTimeLimiterRegistry

public static TimeLimiterMetrics ofTimeLimiterRegistry(String prefix,
 io.github.resilience4j.timelimiter.TimeLimiterRegistry timeLimiterRegistry,
 com.codahale.metrics.MetricRegistry metricRegistry)

Creates a new instance TimeLimiterMetrics with specified metrics names prefix and a TimeLimiterRegistry as a source.

Parameters:

prefix - the prefix of metrics names

timeLimiterRegistry - the registry of time limiters

metricRegistry - the metric registry

ofTimeLimiterRegistry

public static TimeLimiterMetrics ofTimeLimiterRegistry(String prefix,
 io.github.resilience4j.timelimiter.TimeLimiterRegistry timeLimiterRegistry)

Creates a new instance TimeLimiterMetrics with specified metrics names prefix and a TimeLimiterRegistry as a source.

Parameters:

prefix - the prefix of metrics names

timeLimiterRegistry - the registry of time limiters

ofTimeLimiterRegistry

public static TimeLimiterMetrics ofTimeLimiterRegistry(io.github.resilience4j.timelimiter.TimeLimiterRegistry timeLimiterRegistry,
 com.codahale.metrics.MetricRegistry metricRegistry)

Creates a new instance TimeLimiterMetrics with a TimeLimiterRegistry as a source.

Parameters:

timeLimiterRegistry - the registry of time limiters

metricRegistry - the metric registry

ofTimeLimiterRegistry

public static TimeLimiterMetrics ofTimeLimiterRegistry(io.github.resilience4j.timelimiter.TimeLimiterRegistry timeLimiterRegistry)

Creates a new instance TimeLimiterMetrics with a TimeLimiterRegistry as a source.

Parameters:

timeLimiterRegistry - the registry of time limiters

ofIterable

public static TimeLimiterMetrics ofIterable(Iterable<io.github.resilience4j.timelimiter.TimeLimiter> timeLimiters)

Creates a new instance TimeLimiterMetrics with an Iterable of time limiters as a source.

Parameters:

timeLimiters - the time limiters

ofIterable

public static TimeLimiterMetrics ofIterable(String prefix,
 Iterable<io.github.resilience4j.timelimiter.TimeLimiter> timeLimiters)

Creates a new instance TimeLimiterMetrics with an Iterable of time limiters as a source.

Parameters:

timeLimiters - the time limiters

ofTimeLimiter

public static TimeLimiterMetrics ofTimeLimiter(io.github.resilience4j.timelimiter.TimeLimiter timeLimiter)

Creates a new instance of TimeLimiterMetrics with a time limiter as a source.

Parameters:

timeLimiter - the time limiter

getMetrics

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

Specified by:

getMetrics in interface com.codahale.metrics.MetricSet