MetricsService

class MetricsService(port: Int, path: String, initBlock: MetricsService.() -> Unit = {}) : GenericIdleService

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

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.

Parameters

port

The HTTP port for the metrics endpoint.

path

The URL path for the Prometheus metrics servlet (without a leading slash).

initBlock

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

Constructors

Link copied to clipboard
constructor(port: Int, path: String, initBlock: MetricsService.() -> Unit = {})

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val healthCheck: HealthCheck

A Dropwizard HealthCheck that reports healthy when the embedded Jetty server is running.

Link copied to clipboard

Functions

Link copied to clipboard
fun addListener(listener: Service.Listener?, executor: Executor?)
Link copied to clipboard
fun awaitRunning(timeout: Duration?)
fun awaitRunning(timeout: Long, unit: TimeUnit?)
Link copied to clipboard
fun awaitTerminated(timeout: Duration?)
fun awaitTerminated(timeout: Long, unit: TimeUnit?)
Link copied to clipboard
Link copied to clipboard
@CanIgnoreReturnValue
fun startAsync(): Service?
Link copied to clipboard
fun startSync(maxWait: Duration)
Link copied to clipboard
fun state(): Service.State?
Link copied to clipboard
@CanIgnoreReturnValue
fun stopAsync(): Service?
Link copied to clipboard
fun stopSync(maxWait: Duration)
Link copied to clipboard
open override fun toString(): String