io.github.resilience4j.micrometer.tagged

Class RateLimiterMetricNames

java.lang.Object

io.github.resilience4j.micrometer.tagged.RateLimiterMetricNames

public class RateLimiterMetricNames
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RateLimiterMetricNames.Builder Helps building custom instance of RateLimiterMetricNames.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_AVAILABLE_PERMISSIONS_METRIC_NAME
static java.lang.String	DEFAULT_WAITING_THREADS_METRIC_NAME

Constructor Summary

Constructors

Constructor and Description
RateLimiterMetricNames()

Method Summary

Modifier and Type	Method and Description
static RateLimiterMetricNames.Builder	custom() Returns a builder for creating custom metric names.
java.lang.String	getAvailablePermissionsMetricName() Returns the metric name for available permissions, defaults to "resilience4j.ratelimiter.available.permissions".
java.lang.String	getWaitingThreadsMetricName() Returns the metric name for waiting threads, defaults to "resilience4j.ratelimiter.waiting_threads".
static RateLimiterMetricNames	ofDefaults() Returns default metric names.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_AVAILABLE_PERMISSIONS_METRIC_NAME

public static final java.lang.String DEFAULT_AVAILABLE_PERMISSIONS_METRIC_NAME

See Also:

Constant Field Values

DEFAULT_WAITING_THREADS_METRIC_NAME

public static final java.lang.String DEFAULT_WAITING_THREADS_METRIC_NAME

See Also:

Constant Field Values

Constructor Detail

RateLimiterMetricNames

public RateLimiterMetricNames()

Method Detail

custom

public static RateLimiterMetricNames.Builder custom()

Returns a builder for creating custom metric names. Note that names have default values, so only desired metrics can be renamed.

Returns:

The builder.

ofDefaults

public static RateLimiterMetricNames ofDefaults()

Returns default metric names.

Returns:

The default RateLimiterMetricNames instance.

getAvailablePermissionsMetricName

public java.lang.String getAvailablePermissionsMetricName()

Returns the metric name for available permissions, defaults to "resilience4j.ratelimiter.available.permissions".

Returns:

The available permissions metric name.

getWaitingThreadsMetricName

public java.lang.String getWaitingThreadsMetricName()

Returns the metric name for waiting threads, defaults to "resilience4j.ratelimiter.waiting_threads".

Returns:

The waiting threads metric name.