ktor-server-metrics-micrometer/io.ktor.server.metrics.micrometer/MicrometerMetricsConfig

MicrometerMetricsConfig

class MicrometerMetricsConfig(source)

A configuration for the MicrometerMetrics plugin.

Report a problem

Constructors

constructor()

Properties

distinctNotRegisteredRoutes

var distinctNotRegisteredRoutes: Boolean

Specifies if requests for non-existent routes should contain a request path or fallback to common n/a value. false by default.

distributionStatisticConfig

var distributionStatisticConfig: DistributionStatisticConfig

Configures the histogram and/or percentiles for all request timers. By default, 50%, 90% , 95% and 99% percentiles are configured. If your backend supports server side histograms, you should enable these instead with DistributionStatisticConfig.Builder.percentilesHistogram as client side percentiles cannot be aggregated.

meterBinders

var meterBinders: List<MeterBinder>

Allows you to configure a set of metrics for monitoring the JVM. To disable these metrics, assign an empty list to meterBinders:

metricName

var metricName: String

Specifies the base name (prefix) of Ktor metrics used for monitoring HTTP requests. For example, the default "ktor.http.server.requests" values results in the following metrics:

registry

var registry: MeterRegistry

Specifies the meter registry for your monitoring system. The example below shows how to create the PrometheusMeterRegistry:

Functions

timers

fun timers(block: Timer.Builder.(ApplicationCall, Throwable?) -> Unit)

Configures micrometer timers. Can be used to customize tags for each timer, configure individual SLAs, and so on.

transformRoute

fun transformRoute(block: (RoutingNode) -> String)

Configures mapping function for the route label string of the CallMeasure. Defaults to RoutingNode.path.