Module io.helidon.metrics.prometheus

Package io.helidon.metrics.prometheus

Class PrometheusSupport

java.lang.Object

io.helidon.metrics.prometheus.PrometheusSupport

All Implemented Interfaces:

Service

public final class PrometheusSupport
extends Object
implements Service

Support for Prometheus client endpoint.

Default and simplest use on Routing creates /metrics endpoint for default CollectorRegistry.

 Routing.builder()
        .register(PrometheusSupport.create())
 

It is possible to use

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PrometheusSupport.Builder	A builder of PrometheusSupport.

Method Summary

Modifier and Type	Method	Description
static PrometheusSupport.Builder	builder()	Creates new Builder instance.
static PrometheusSupport	create()	Creates new instance using default Prometheus CollectorRegistry.
static PrometheusSupport	create(CollectorRegistry collectorRegistry)	Creates new instance using specified Prometheus CollectorRegistry.
void	update(Routing.Rules rules)	Updates Routing.Rules with handlers representing this service.

Methods inherited from class java.lang.Object

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

Method Details

update

public void update(Routing.Rules rules)

Description copied from interface: Service

Updates Routing.Rules with handlers representing this service.

Specified by:

update in interface Service

Parameters:

rules - a routing rules to update

create

public static PrometheusSupport create(CollectorRegistry collectorRegistry)

Creates new instance using specified Prometheus CollectorRegistry.

Parameters:

collectorRegistry - a registry to use

Returns:

new instance

See Also:

• create()
• builder()

create

public static PrometheusSupport create()

Creates new instance using default Prometheus CollectorRegistry.

Returns:

new instance

See Also:

• CollectorRegistry
• create(CollectorRegistry)
• builder()

builder

public static PrometheusSupport.Builder builder()

Creates new Builder instance.

Returns:

the new instance

See Also:

• create()
• create(CollectorRegistry)