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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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 Detail

path

final String path

metricsCapability

final MetricsCapabilityBuildItem.MetricsCapability<String> metricsCapability

Constructor Detail

MetricsCapabilityBuildItem

public MetricsCapabilityBuildItem(MetricsCapabilityBuildItem.MetricsCapability<String> metricsCapability)

MetricsCapabilityBuildItem

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

Method Detail

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