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, Moritz Halbritter

Constructor Summary

Constructors

Constructor	Description
PrometheusScrapeEndpoint(io.prometheus.metrics.model.registry.PrometheusRegistry prometheusRegistry)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.3.1 for removal in 3.5.0 in favor of PrometheusScrapeEndpoint(PrometheusRegistry, Properties)
PrometheusScrapeEndpoint(io.prometheus.metrics.model.registry.PrometheusRegistry prometheusRegistry, Properties exporterProperties)	Creates a new PrometheusScrapeEndpoint.

Method Summary

Modifier and Type	Method	Description
WebEndpointResponse<byte[]>	scrape(PrometheusOutputFormat 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

@Deprecated(since="3.3.1",
            forRemoval=true)
public PrometheusScrapeEndpoint(io.prometheus.metrics.model.registry.PrometheusRegistry prometheusRegistry)

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.3.1 for removal in 3.5.0 in favor of PrometheusScrapeEndpoint(PrometheusRegistry, Properties)

Creates a new PrometheusScrapeEndpoint.

Parameters:

prometheusRegistry - the Prometheus registry to use

PrometheusScrapeEndpoint

public PrometheusScrapeEndpoint(io.prometheus.metrics.model.registry.PrometheusRegistry prometheusRegistry,
 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 WebEndpointResponse<byte[]> scrape(PrometheusOutputFormat format,
 @Nullable
 Set<String> includedNames)