Class RateLimiterMetrics

java.lang.Object

io.github.resilience4j.metrics.RateLimiterMetrics

All Implemented Interfaces:

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	ITERABLE_NULL
private final com.codahale.metrics.MetricRegistry	metricRegistry
private static final String	PREFIX_NULL

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RateLimiterMetrics(Iterable<io.github.resilience4j.ratelimiter.RateLimiter> rateLimiters)
private	RateLimiterMetrics(String prefix, Iterable<io.github.resilience4j.ratelimiter.RateLimiter> rateLimiters, com.codahale.metrics.MetricRegistry metricRegistry)

Method Summary

Modifier and Type	Method	Description
Map<String, com.codahale.metrics.Metric>	getMetrics()
static RateLimiterMetrics	ofIterable(Iterable<io.github.resilience4j.ratelimiter.RateLimiter> rateLimiters)	Creates a new instance RateLimiterMetrics with an Iterable of rate limiters as a source.
static RateLimiterMetrics	ofIterable(String prefix, Iterable<io.github.resilience4j.ratelimiter.RateLimiter> rateLimiters)	Creates a new instance RateLimiterMetrics with an Iterable of rate limiters as a source.
static RateLimiterMetrics	ofRateLimiter(io.github.resilience4j.ratelimiter.RateLimiter rateLimiter)	Creates a new instance of RateLimiterMetrics with a rate limiter as a source.
static RateLimiterMetrics	ofRateLimiterRegistry(io.github.resilience4j.ratelimiter.RateLimiterRegistry rateLimiterRegistry)	Creates a new instance RateLimiterMetrics with a RateLimiterRegistry as a source.
static RateLimiterMetrics	ofRateLimiterRegistry(io.github.resilience4j.ratelimiter.RateLimiterRegistry rateLimiterRegistry, com.codahale.metrics.MetricRegistry metricRegistry)	Creates a new instance RateLimiterMetrics with a RateLimiterRegistry as a source.
static RateLimiterMetrics	ofRateLimiterRegistry(String prefix, io.github.resilience4j.ratelimiter.RateLimiterRegistry rateLimiterRegistry)	Creates a new instance RateLimiterMetrics with specified metrics names prefix and a RateLimiterRegistry as a source.
static RateLimiterMetrics	ofRateLimiterRegistry(String prefix, io.github.resilience4j.ratelimiter.RateLimiterRegistry rateLimiterRegistry, com.codahale.metrics.MetricRegistry metricRegistry)	Creates a new instance RateLimiterMetrics with specified metrics names prefix and a RateLimiterRegistry as a source.

Methods inherited from class Object

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

Field Details

PREFIX_NULL

private static final String PREFIX_NULL

See Also:

• Constant Field Values

ITERABLE_NULL

private static final String ITERABLE_NULL

See Also:

• Constant Field Values

metricRegistry

private final com.codahale.metrics.MetricRegistry metricRegistry

Constructor Details

RateLimiterMetrics

private RateLimiterMetrics(Iterable<io.github.resilience4j.ratelimiter.RateLimiter> rateLimiters)

RateLimiterMetrics

private RateLimiterMetrics(String prefix,
 Iterable<io.github.resilience4j.ratelimiter.RateLimiter> rateLimiters,
 com.codahale.metrics.MetricRegistry metricRegistry)

Method Details

ofRateLimiterRegistry

public static RateLimiterMetrics ofRateLimiterRegistry(String prefix,
 io.github.resilience4j.ratelimiter.RateLimiterRegistry rateLimiterRegistry,
 com.codahale.metrics.MetricRegistry metricRegistry)

Creates a new instance RateLimiterMetrics with specified metrics names prefix and a RateLimiterRegistry as a source.

Parameters:

prefix - the prefix of metrics names

rateLimiterRegistry - the registry of rate limiters

metricRegistry - the metric registry

ofRateLimiterRegistry

public static RateLimiterMetrics ofRateLimiterRegistry(String prefix,
 io.github.resilience4j.ratelimiter.RateLimiterRegistry rateLimiterRegistry)

Creates a new instance RateLimiterMetrics with specified metrics names prefix and a RateLimiterRegistry as a source.

Parameters:

prefix - the prefix of metrics names

rateLimiterRegistry - the registry of rate limiters

ofRateLimiterRegistry

public static RateLimiterMetrics ofRateLimiterRegistry(io.github.resilience4j.ratelimiter.RateLimiterRegistry rateLimiterRegistry,
 com.codahale.metrics.MetricRegistry metricRegistry)

Creates a new instance RateLimiterMetrics with a RateLimiterRegistry as a source.

Parameters:

rateLimiterRegistry - the registry of rate limiters

metricRegistry - the metric registry

ofRateLimiterRegistry

public static RateLimiterMetrics ofRateLimiterRegistry(io.github.resilience4j.ratelimiter.RateLimiterRegistry rateLimiterRegistry)

Creates a new instance RateLimiterMetrics with a RateLimiterRegistry as a source.

Parameters:

rateLimiterRegistry - the registry of rate limiters

ofIterable

public static RateLimiterMetrics ofIterable(Iterable<io.github.resilience4j.ratelimiter.RateLimiter> rateLimiters)

Creates a new instance RateLimiterMetrics with an Iterable of rate limiters as a source.

Parameters:

rateLimiters - the rate limiters

ofIterable

public static RateLimiterMetrics ofIterable(String prefix,
 Iterable<io.github.resilience4j.ratelimiter.RateLimiter> rateLimiters)

Creates a new instance RateLimiterMetrics with an Iterable of rate limiters as a source.

Parameters:

rateLimiters - the rate limiters

ofRateLimiter

public static RateLimiterMetrics ofRateLimiter(io.github.resilience4j.ratelimiter.RateLimiter rateLimiter)

Creates a new instance of RateLimiterMetrics with a rate limiter as a source.

Parameters:

rateLimiter - the rate limiter

getMetrics

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

Specified by:

getMetrics in interface com.codahale.metrics.MetricSet