Package io.github.resilience4j.prometheus.collectors

Class RateLimiterMetricsCollector

java.lang.Object
io.prometheus.client.Collector
io.github.resilience4j.prometheus.collectors.RateLimiterMetricsCollector
public class RateLimiterMetricsCollector
extends io.prometheus.client.Collector
Collects RateLimiter exposed RateLimiter.Metrics.

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  RateLimiterMetricsCollector.MetricNames
    Defines possible configuration for metric names.

    Nested classes/interfaces inherited from class io.prometheus.client.Collector

    io.prometheus.client.Collector.Describable, io.prometheus.client.Collector.MetricFamilySamples, io.prometheus.client.Collector.Type

  • Field Summary

    Fields inherited from class io.prometheus.client.Collector

    MILLISECONDS_PER_SECOND, NANOSECONDS_PER_SECOND

  • Method Summary

    Modifier and Type Method Description
    java.util.List<io.prometheus.client.Collector.MetricFamilySamples> collect()  
    static RateLimiterMetricsCollector ofRateLimiterRegistry​(RateLimiterMetricsCollector.MetricNames names, io.github.resilience4j.ratelimiter.RateLimiterRegistry rateLimiterRegistry)
    Creates a new collector with custom metric names and using given supplier as source of rate limiters.
    static RateLimiterMetricsCollector ofRateLimiterRegistry​(io.github.resilience4j.ratelimiter.RateLimiterRegistry rateLimiterRegistry)
    Creates a new collector using given registry as source of rate limiters.

    Methods inherited from class io.prometheus.client.Collector

    checkMetricLabelName, checkMetricName, doubleToGoString, register, register, sanitizeMetricName

    Methods inherited from class java.lang.Object

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

  • Method Details

    • ofRateLimiterRegistry

      public static RateLimiterMetricsCollector ofRateLimiterRegistry​(RateLimiterMetricsCollector.MetricNames names, io.github.resilience4j.ratelimiter.RateLimiterRegistry rateLimiterRegistry)
      Creates a new collector with custom metric names and using given supplier as source of rate limiters.
      Parameters:
      names - the custom metric names
      rateLimiterRegistry - the source of rate limiters

    • ofRateLimiterRegistry

      public static RateLimiterMetricsCollector ofRateLimiterRegistry​(io.github.resilience4j.ratelimiter.RateLimiterRegistry rateLimiterRegistry)
      Creates a new collector using given registry as source of rate limiters.
      Parameters:
      rateLimiterRegistry - the source of rate limiters

    • collect

      public java.util.List<io.prometheus.client.Collector.MetricFamilySamples> collect()
      Specified by:
      collect in class io.prometheus.client.Collector