Package io.quarkus.micrometer.runtime.config

Class PrometheusConfigGroup

java.lang.Object

io.quarkus.micrometer.runtime.config.PrometheusConfigGroup

All Implemented Interfaces:

MicrometerConfig.CapabilityEnabled

public class PrometheusConfigGroup
extends Object
implements MicrometerConfig.CapabilityEnabled

Field Summary

Fields

Modifier and Type	Field	Description
boolean	defaultRegistry	By default, this extension will create a Prometheus MeterRegistry instance.
Optional<Boolean>	enabled	Support for export to Prometheus.
String	path	The path for the prometheus metrics endpoint (produces text/plain).

Constructor Summary

Constructors

Constructor	Description
PrometheusConfigGroup()

Method Summary

Modifier and Type	Method	Description
Optional<Boolean>	getEnabled()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

enabled

@ConfigItem
public Optional<Boolean> enabled

Support for export to Prometheus.

Support for Prometheus will be enabled if Micrometer support is enabled, the PrometheusMeterRegistry is on the classpath and either this value is true, or this value is unset and quarkus.micrometer.registry-enabled-default is true.

path

@ConfigItem(defaultValue="metrics")
public String path

The path for the prometheus metrics endpoint (produces text/plain). The default value is `metrics` and is resolved relative to the non-application endpoint (`q`), e.g. `${quarkus.http.root-path}/${quarkus.http.non-application-root-path}/metrics`. If an absolute path is specified (`/metrics`), the prometheus endpoint will be served from the configured path. If the management interface is enabled, the value will be resolved as a path relative to `${quarkus.management.root-path}` (`q` by default), e.g. `http://${quarkus.management.host}:${quarkus.management.port}/${quarkus.management.root-path}/metrics`. If an absolute path is specified (`/metrics`), the prometheus endpoint will be served from the configured path, e.g. `http://${quarkus.management.host}:${quarkus.management.port}/metrics`.

defaultRegistry

@ConfigItem(defaultValue="true")
public boolean defaultRegistry

By default, this extension will create a Prometheus MeterRegistry instance.

Use this attribute to veto the creation of the default Prometheus MeterRegistry.

Constructor Details

PrometheusConfigGroup

public PrometheusConfigGroup()

Method Details

getEnabled

public Optional<Boolean> getEnabled()

Specified by:

getEnabled in interface MicrometerConfig.CapabilityEnabled

toString

public String toString()

Overrides:

toString in class Object