Class PrometheusScrapeEndpoint

java.lang.Object

org.springframework.boot.micrometer.metrics.autoconfigure.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:

4.0.0

Constructor Summary

Constructors

Constructor	Description
PrometheusScrapeEndpoint(io.prometheus.metrics.model.registry.PrometheusRegistry prometheusRegistry, @Nullable Properties exporterProperties)	Creates a new PrometheusScrapeEndpoint.

Method Summary

Modifier and Type	Method	Description
org.springframework.boot.actuate.endpoint.web.WebEndpointResponse<byte[]>	scrape(PrometheusOutputFormat format, @Nullable Set<String> includedNames)

Methods inherited from class Object

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

Constructor Details

PrometheusScrapeEndpoint

public PrometheusScrapeEndpoint(io.prometheus.metrics.model.registry.PrometheusRegistry prometheusRegistry,
 @Nullable Properties exporterProperties)

Creates a new PrometheusScrapeEndpoint.

Parameters:

prometheusRegistry - the Prometheus registry to use

exporterProperties - the properties used to configure Prometheus' ExpositionFormats

Since:

3.3.1

Method Details

scrape

@ReadOperation(producesFrom=PrometheusOutputFormat.class)
public org.springframework.boot.actuate.endpoint.web.WebEndpointResponse<byte[]> scrape(PrometheusOutputFormat format,
 @Nullable Set<String> includedNames)