Module io.helidon.metrics.providers.micrometer

Package io.helidon.metrics.providers.micrometer

Class PrometheusPublisher

java.lang.Object

io.helidon.metrics.providers.micrometer.PrometheusPublisher

All Implemented Interfaces:

RuntimeType.Api<PrometheusPublisherConfig>, NamedService, MetricsPublisher

public class PrometheusPublisher
extends Object
implements RuntimeType.Api<PrometheusPublisherConfig>

Metrics publisher for Prometheus output.

Method Summary

Modifier and Type	Method	Description
static PrometheusPublisherConfig.Builder	builder()	Returns a builder for constructing a Prometheus publisher.
static PrometheusPublisher	create()	Returns a default Prometheus publisher.
static PrometheusPublisher	create(PrometheusPublisherConfig config)	Creates a new Prometheus published using the provided configuration.
static PrometheusPublisher	create(Consumer<PrometheusPublisherConfig.Builder> consumer)	Creates a Prometheus publisher using a new builder and applying a consumer of the builder.
boolean	enabled()	Whether this publisher is enabled.
String	name()	Name of this implementation, as provided in ConfiguredProvider.create(Config, String).
BiFunction<Function<String,String>,SpanContextSupplierProvider,io.micrometer.prometheus.PrometheusMeterRegistry>	prometheusRegistry()	Returns a factory function accepting a property look-up function and the Micrometer span context supplier provider and producing a PrometheusMeterRegistry.
PrometheusPublisherConfig	prototype()	The prototype as it was received when creating this runtime object instance.
Supplier<io.micrometer.core.instrument.MeterRegistry>	registry()
String	type()	Type of this implementation, to distinguish instances of same type, with different NamedService.name().

Methods inherited from class java.lang.Object

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

Method Details

builder

public static PrometheusPublisherConfig.Builder builder()

Returns a builder for constructing a Prometheus publisher.

Returns:

new builder

create

public static PrometheusPublisher create()

Returns a default Prometheus publisher.

Returns:

default Prometheus publisher

create

public static PrometheusPublisher create(PrometheusPublisherConfig config)

Creates a new Prometheus published using the provided configuration.

Parameters:

config - Prometheus publisher config

Returns:

new Prometheus publisher

create

public static PrometheusPublisher create(Consumer<PrometheusPublisherConfig.Builder> consumer)

Creates a Prometheus publisher using a new builder and applying a consumer of the builder.

Parameters:

consumer - code to process a builder

Returns:

new Prometheus publisher

prototype

public PrometheusPublisherConfig prototype()

Description copied from interface: RuntimeType.Api

The prototype as it was received when creating this runtime object instance.

Specified by:

prototype in interface RuntimeType.Api<PrometheusPublisherConfig>

Returns:

prototype object used to create this instance

enabled

public boolean enabled()

Description copied from interface: MetricsPublisher

Whether this publisher is enabled.

Specified by:

enabled in interface MetricsPublisher

Returns:

true if enabled, false otherwise

name

public String name()

Description copied from interface: NamedService

Name of this implementation, as provided in ConfiguredProvider.create(Config, String).

Specified by:

name in interface NamedService

Returns:

name of this service

type

public String type()

Description copied from interface: NamedService

Type of this implementation, to distinguish instances of same type, with different NamedService.name(). Use for example ConfiguredProvider.configKey() to define the type.

Specified by:

type in interface NamedService

Returns:

type of this service

prometheusRegistry

public BiFunction<Function<String,String>,SpanContextSupplierProvider,io.micrometer.prometheus.PrometheusMeterRegistry> prometheusRegistry()

Returns a factory function accepting a property look-up function and the Micrometer span context supplier provider and producing a PrometheusMeterRegistry.

Returns:

factory function

registry

public Supplier<io.micrometer.core.instrument.MeterRegistry> registry()