Package io.quarkus.deployment.metrics

Class MetricsCapabilityBuildItem

java.lang.Object

io.quarkus.builder.item.BuildItem

io.quarkus.builder.item.SimpleBuildItem

io.quarkus.deployment.metrics.MetricsCapabilityBuildItem

public final class MetricsCapabilityBuildItem
extends SimpleBuildItem

A build item indicating the presence and capabilities of a metrics system in the application.

This build item provides:

• A MetricsCapabilityBuildItem.MetricsCapability instance via metricsCapability to check if specific metrics backends (like Micrometer or MP Metrics) are supported. This is typically used by extensions to conditionally register metrics. See metricsSupported(String).
• The configured path for the metrics endpoint via path, if one is enabled. See metricsEndpoint().

It extends SimpleBuildItem. The inner functional interface MetricsCapabilityBuildItem.MetricsCapability defines the contract for checking backend support.

See Also:

• MetricsFactory.MICROMETER
• MetricsFactory.MP_METRICS

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MetricsCapabilityBuildItem.MetricsCapability<String>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final MetricsCapabilityBuildItem.MetricsCapability<String>	metricsCapability
(package private) final String	path

Constructor Summary

Constructors

Constructor	Description
MetricsCapabilityBuildItem(MetricsCapabilityBuildItem.MetricsCapability<String> metricsCapability)
MetricsCapabilityBuildItem(MetricsCapabilityBuildItem.MetricsCapability<String> metricsCapability, String path)

Method Summary

Modifier and Type	Method	Description
String	metricsEndpoint()
boolean	metricsSupported(String name)	Test for a known metrics system to allow selective initialization of metrics based using a known API.

Methods inherited from class java.lang.Object

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

Field Details

path

final String path

metricsCapability

final MetricsCapabilityBuildItem.MetricsCapability<String> metricsCapability

Constructor Details

MetricsCapabilityBuildItem

public MetricsCapabilityBuildItem(MetricsCapabilityBuildItem.MetricsCapability<String> metricsCapability)

MetricsCapabilityBuildItem

public MetricsCapabilityBuildItem(MetricsCapabilityBuildItem.MetricsCapability<String> metricsCapability,
 String path)

Method Details

metricsSupported

public boolean metricsSupported(String name)

Test for a known metrics system to allow selective initialization of metrics based using a known API. Avoid using deployment module artifacts. Ensure that metrics API dependencies remain optional / compile-time only.

Returns:

true if this factory supports the named metrics system. Arbitrary strings are allowed. Constants are present for a few.

See Also:

• MetricsFactory.MICROMETER
• MetricsFactory.MP_METRICS

metricsEndpoint

public String metricsEndpoint()

Returns:

the configured Metrics Endpoint (if an endpoint is enabled) or null