Module io.helidon.metrics.prometheus

Package io.helidon.metrics.prometheus

Class PrometheusSupport

java.lang.Object

io.helidon.webserver.servicecommon.HelidonFeatureSupport

io.helidon.metrics.prometheus.PrometheusSupport

All Implemented Interfaces:

HttpFeature, ServerLifecycle, FeatureSupport, Supplier<HttpFeature>

@Deprecated(since="4.5.0",
            forRemoval=true)
public final class PrometheusSupport
extends HelidonFeatureSupport

Deprecated, for removal: This API element is subject to removal in a future version.

use Helidon's built-in metrics implementation, which already supports Prometheus/OpenMetrics output, instead

Support for Prometheus client endpoint.

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

 HttpRouting.builder()
        ..addFeature(PrometheusSupport.create())
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PrometheusSupport.Builder	Deprecated, for removal: This API element is subject to removal in a future version. use Helidon's built-in metrics implementation, which already supports Prometheus/OpenMetrics output, instead

Method Summary

Modifier and Type	Method	Description
static PrometheusSupport.Builder	builder()	Deprecated, for removal: This API element is subject to removal in a future version. Creates new Builder instance.
static PrometheusSupport	create()	Deprecated, for removal: This API element is subject to removal in a future version. Creates new instance using default Prometheus CollectorRegistry.
static PrometheusSupport	create(CollectorRegistry collectorRegistry)	Deprecated, for removal: This API element is subject to removal in a future version. Creates new instance using specified Prometheus CollectorRegistry.
Optional<HttpService>	service()	Deprecated, for removal: This API element is subject to removal in a future version. If this feature is represented by a service, return it here, to simplify implementation.

Methods inherited from class io.helidon.webserver.servicecommon.HelidonFeatureSupport

configuredContext, context, context, enabled, logger, postSetup, setup

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.webserver.servicecommon.FeatureSupport

setup

Methods inherited from interface io.helidon.webserver.http.HttpFeature

get, socket, socketRequired

Methods inherited from interface io.helidon.webserver.ServerLifecycle

afterStart, afterStop, beforeStart

Method Details

service

public Optional<HttpService> service()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: FeatureSupport

If this feature is represented by a service, return it here, to simplify implementation. Otherwise you will need to implement FeatureSupport.setup(HttpRouting.Builder, HttpRouting.Builder).

Returns:

service if implemented

create

public static PrometheusSupport create(CollectorRegistry collectorRegistry)

Deprecated, for removal: This API element is subject to removal in a future version.

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()

Deprecated, for removal: This API element is subject to removal in a future version.

Creates new instance using default Prometheus CollectorRegistry.

Returns:

new instance

See Also:

• CollectorRegistry
• create(CollectorRegistry)
• builder()

builder

public static PrometheusSupport.Builder builder()

Deprecated, for removal: This API element is subject to removal in a future version.

Creates new Builder instance.

Returns:

the new instance

See Also:

• create()
• create(CollectorRegistry)