Package io.prometheus.client.spring.boot

Class SpringBootMetricsCollector

java.lang.Object

io.prometheus.client.Collector

io.prometheus.client.spring.boot.SpringBootMetricsCollector

All Implemented Interfaces:

io.prometheus.client.Collector.Describable

@Component
public class SpringBootMetricsCollector
extends io.prometheus.client.Collector
implements io.prometheus.client.Collector.Describable

Spring boot metrics integration for Prometheus exporter.

@Bean
 public SpringBootMetricsCollector springBootMetricsCollector(Collection<PublicMetrics> publicMetrics) {
   SpringBootMetricsCollector springBootMetricsCollector = new SpringBootMetricsCollector(publicMetrics);
   springBootMetricsCollector.register();
   return springBootMetricsCollector;
 }
 

Nested Class Summary

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

Constructor Summary

Constructors

Constructor	Description
SpringBootMetricsCollector(Collection<org.springframework.boot.actuate.endpoint.PublicMetrics> publicMetrics)

Method Summary

Modifier and Type	Method	Description
List<io.prometheus.client.Collector.MetricFamilySamples>	collect()
List<io.prometheus.client.Collector.MetricFamilySamples>	describe()

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

Constructor Detail

SpringBootMetricsCollector

@Autowired
public SpringBootMetricsCollector(Collection<org.springframework.boot.actuate.endpoint.PublicMetrics> publicMetrics)

Method Detail

collect

public List<io.prometheus.client.Collector.MetricFamilySamples> collect()

Specified by:

collect in class io.prometheus.client.Collector

describe

public List<io.prometheus.client.Collector.MetricFamilySamples> describe()

Specified by:

describe in interface io.prometheus.client.Collector.Describable