io.github.resilience4j.metrics

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 java.lang.Object
implements com.codahale.metrics.MetricSet

An adapter which exports RateLimiter.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 RateLimiterMetrics	ofIterable(java.lang.Iterable<io.github.resilience4j.ratelimiter.RateLimiter> rateLimiters) Creates a new instance RateLimiterMetrics with an Iterable of rate limiters as a source.
static RateLimiterMetrics	ofIterable(java.lang.String prefix, java.lang.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(java.lang.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(java.lang.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 java.lang.Object

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

Method Detail

ofRateLimiterRegistry

public static RateLimiterMetrics ofRateLimiterRegistry(java.lang.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(java.lang.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(java.lang.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(java.lang.String prefix,
                                            java.lang.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 java.util.Map<java.lang.String,com.codahale.metrics.Metric> getMetrics()

Specified by:

getMetrics in interface com.codahale.metrics.MetricSet