service-utils/com.pambrose.common.service/MetricsService

MetricsService

class MetricsService(port: Int, path: String, host: String? = null, registry: PrometheusRegistry = PrometheusRegistry.defaultRegistry, initBlock: MetricsService.() -> Unit = {}) : GenericIdleService

A Guava GenericIdleService that runs an embedded Jetty server to expose a Prometheus PrometheusMetricsServlet.

The service starts a Jetty HTTP server on the specified port and serves the Prometheus metrics endpoint at the given path. It also exposes a healthCheck property for integration with Dropwizard health check registries.

The servlet negotiates the exposition format through the request's Accept header: a plain scrape (no Accept, or one that does not ask for OpenMetrics) gets the Prometheus text format (Content-Type starting text/plain; version=0.0.4), and a scrape sending Accept: application/openmetrics-text; version=1.0.0 gets the OpenMetrics text format instead.

Parameters

port

The HTTP port for the metrics endpoint.

path

The URL path for the Prometheus metrics servlet, with or without a leading slash.

host

The interface to bind to, or null to bind every interface.

registry

The PrometheusRegistry to serve. Defaults to PrometheusRegistry.defaultRegistry.

initBlock

An optional initialization block invoked after the service listener is registered.

Constructors

MetricsService

constructor(port: Int, path: String, host: String? = null, registry: PrometheusRegistry = PrometheusRegistry.defaultRegistry, initBlock: MetricsService.() -> Unit = {})