Package org.springframework.boot.actuate.metrics.export.prometheus

Class PrometheusScrapeEndpoint

java.lang.Object

org.springframework.boot.actuate.metrics.export.prometheus.PrometheusScrapeEndpoint

@WebEndpoint(id="prometheus")
public class PrometheusScrapeEndpoint
extends Object

@Endpoint that outputs metrics in a format that can be scraped by the Prometheus server.

Since:

2.0.0

Author:

Jon Schneider, Johnny Lim

Constructor Summary

Constructors

Constructor	Description
PrometheusScrapeEndpoint(io.prometheus.client.CollectorRegistry collectorRegistry)

Method Summary

Modifier and Type	Method	Description
WebEndpointResponse<String>	scrape(TextOutputFormat format, Set<String> includedNames)

Methods inherited from class java.lang.Object

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

Constructor Details

PrometheusScrapeEndpoint

public PrometheusScrapeEndpoint(io.prometheus.client.CollectorRegistry collectorRegistry)

Method Details

scrape

@ReadOperation(producesFrom=TextOutputFormat.class)
public WebEndpointResponse<String> scrape(TextOutputFormat format,
 @Nullable
 Set<String> includedNames)