Package io.github.resilience4j.prometheus.collectors

Class RateLimiterMetricsCollector.MetricNames

java.lang.Object

io.github.resilience4j.prometheus.collectors.RateLimiterMetricsCollector.MetricNames

Enclosing class:

RateLimiterMetricsCollector

public static class RateLimiterMetricsCollector.MetricNames
extends java.lang.Object

Defines possible configuration for metric names.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
MetricNames()

Method Summary

Modifier and Type	Method	Description
static RateLimiterMetricsCollector.MetricNames.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 RateLimiterMetricsCollector.MetricNames	ofDefaults()	Returns default metric names.

Methods inherited from class java.lang.Object

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

Field Details

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 Details

MetricNames

public MetricNames()

Method Details

custom

public static RateLimiterMetricsCollector.MetricNames.Builder custom()

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

ofDefaults

public static RateLimiterMetricsCollector.MetricNames ofDefaults()

Returns default metric names.

getAvailablePermissionsMetricName

public java.lang.String getAvailablePermissionsMetricName()

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

getWaitingThreadsMetricName

public java.lang.String getWaitingThreadsMetricName()

Returns the metric name for waiting threads, defaults to "resilience4j_ratelimiter_waiting_threads".