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

Class PrometheusProperties

java.lang.Object

org.springframework.boot.actuate.autoconfigure.metrics.export.prometheus.PrometheusProperties

@ConfigurationProperties(prefix="management.prometheus.metrics.export")
public class PrometheusProperties
extends Object

@ConfigurationProperties for configuring metrics export to Prometheus.

Since:

2.0.0

Author:

Jon Schneider, Stephane Nicoll

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PrometheusProperties.HistogramFlavor	Deprecated, for removal: This API element is subject to removal in a future version. since 3.3.0 for removal in 3.5.0
static class	PrometheusProperties.Pushgateway	Configuration options for push-based interaction with Prometheus.

Constructor Summary

Constructors

Constructor	Description
PrometheusProperties()

Method Summary

Modifier and Type	Method	Description
PrometheusProperties.HistogramFlavor	getHistogramFlavor()	Deprecated, for removal: This API element is subject to removal in a future version.
Map<String,String>	getProperties()
PrometheusProperties.Pushgateway	getPushgateway()
Duration	getStep()
boolean	isDescriptions()
boolean	isEnabled()
void	setDescriptions(boolean descriptions)
void	setEnabled(boolean enabled)
void	setHistogramFlavor(PrometheusProperties.HistogramFlavor histogramFlavor)
void	setStep(Duration step)

Methods inherited from class java.lang.Object

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

Constructor Details

PrometheusProperties

public PrometheusProperties()

Method Details

isDescriptions

public boolean isDescriptions()

setDescriptions

public void setDescriptions(boolean descriptions)

getHistogramFlavor

@Deprecated(since="3.3.0",
            forRemoval=true)
@DeprecatedConfigurationProperty(since="3.3.0",
                                 reason="No longer supported. Works only when using the Prometheus simpleclient.")
public PrometheusProperties.HistogramFlavor getHistogramFlavor()

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

setHistogramFlavor

public void setHistogramFlavor(PrometheusProperties.HistogramFlavor histogramFlavor)

getStep

public Duration getStep()

setStep

public void setStep(Duration step)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getPushgateway

public PrometheusProperties.Pushgateway getPushgateway()

getProperties

public Map<String,String> getProperties()