Package com.linecorp.armeria.server.prometheus

Class PrometheusExpositionService

java.lang.Object

com.linecorp.armeria.server.AbstractHttpService

com.linecorp.armeria.server.prometheus.PrometheusExpositionService

All Implemented Interfaces:

Unwrappable, HttpService, Service<HttpRequest,HttpResponse>, TransientHttpService, TransientService<HttpRequest,HttpResponse>

@UnstableApi
public final class PrometheusExpositionService
extends AbstractHttpService
implements TransientHttpService

Exposes Prometheus metrics in EXPOSITION FORMATS.

Method Summary

Modifier and Type	Method	Description
static PrometheusExpositionServiceBuilder	builder()	Returns a new PrometheusExpositionServiceBuilder created with PrometheusRegistry.defaultRegistry.
static PrometheusExpositionServiceBuilder	builder(io.prometheus.metrics.model.registry.PrometheusRegistry prometheusRegistry)	Returns a new PrometheusExpositionServiceBuilder created with the specified PrometheusRegistry.
protected HttpResponse	doGet(ServiceRequestContext ctx, HttpRequest req)	Handles a GET request.
protected HttpResponse	doPost(ServiceRequestContext ctx, HttpRequest req)	Handles a POST request.
static PrometheusExpositionService	of()	Returns a new PrometheusExpositionService that exposes Prometheus metrics from PrometheusRegistry.defaultRegistry.
static PrometheusExpositionService	of(io.prometheus.metrics.model.registry.PrometheusRegistry prometheusRegistry)	Returns a new PrometheusExpositionService that exposes Prometheus metrics from the specified PrometheusRegistry.
Set<TransientServiceOption>	transientServiceOptions()	Returns the Set of TransientServiceOptions that are enabled for this TransientService.

Methods inherited from class com.linecorp.armeria.server.AbstractHttpService

doConnect, doDelete, doHead, doOptions, doPatch, doPut, doTrace, serve

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.server.HttpService

decorate, decorate, exchangeType, options, serve

Methods inherited from interface com.linecorp.armeria.server.Service

as, serviceAdded, shouldCachePath, unwrap

Methods inherited from interface com.linecorp.armeria.common.util.Unwrappable

equalsIgnoreWrapper, unwrapAll

Method Details

of

public static PrometheusExpositionService of()

Returns a new PrometheusExpositionService that exposes Prometheus metrics from PrometheusRegistry.defaultRegistry.

of

public static PrometheusExpositionService of(io.prometheus.metrics.model.registry.PrometheusRegistry prometheusRegistry)

Returns a new PrometheusExpositionService that exposes Prometheus metrics from the specified PrometheusRegistry.

builder

public static PrometheusExpositionServiceBuilder builder()

Returns a new PrometheusExpositionServiceBuilder created with PrometheusRegistry.defaultRegistry.

builder

public static PrometheusExpositionServiceBuilder builder(io.prometheus.metrics.model.registry.PrometheusRegistry prometheusRegistry)

Returns a new PrometheusExpositionServiceBuilder created with the specified PrometheusRegistry.

doGet

protected HttpResponse doGet(ServiceRequestContext ctx,
 HttpRequest req)
                      throws Exception

Description copied from class: AbstractHttpService

Handles a GET request. This method sends a 405 Method Not Allowed response by default.

Overrides:

doGet in class AbstractHttpService

Throws:

Exception

doPost

protected HttpResponse doPost(ServiceRequestContext ctx,
 HttpRequest req)
                       throws Exception

Description copied from class: AbstractHttpService

Handles a POST request. This method sends a 405 Method Not Allowed response by default.

Overrides:

doPost in class AbstractHttpService

Throws:

Exception

transientServiceOptions

public Set<TransientServiceOption> transientServiceOptions()

Description copied from interface: TransientService

Returns the Set of TransientServiceOptions that are enabled for this TransientService. This returns Flags.transientServiceOptions() if you didn't specify any TransientServiceOptions using TransientServiceBuilder.transientServiceOptions(TransientServiceOption...) when you create this TransientService.

Specified by:

transientServiceOptions in interface TransientService<HttpRequest,HttpResponse>