vertx / io.vertx.kotlin.micrometer / micrometerMetricsOptionsOf

micrometerMetricsOptionsOf

fun micrometerMetricsOptionsOf(disabledMetricsCategories: Iterable<MetricsDomain>? = null, enabled: Boolean? = null, factory: VertxMetricsFactory? = null, influxDbOptions: VertxInfluxDbOptions? = null, jmxMetricsOptions: VertxJmxMetricsOptions? = null, jvmMetricsEnabled: Boolean? = null, labelMatches: Iterable<Match>? = null, labelMatchs: Iterable<Match>? = null, labels: Iterable<Label>? = null, micrometerRegistry: MeterRegistry? = null, prometheusOptions: VertxPrometheusOptions? = null, registryName: String? = null): MicrometerMetricsOptions

A function providing a DSL for building io.vertx.micrometer.MicrometerMetricsOptions objects.

Vert.x micrometer configuration.

Parameters

disabledMetricsCategories - Sets metrics types that are disabled.

enabled - Set whether metrics will be enabled on the Vert.x instance. Metrics are not enabled by default.

factory - Programmatically set the metrics factory to be used when metrics are enabled. Only valid if = true. Normally Vert.x will look on the classpath for a metrics factory implementation, but if you want to set one programmatically you can use this method.

influxDbOptions - Set InfluxDB options. Setting a registry backend option is mandatory in order to effectively report metrics.

jmxMetricsOptions - Set JMX metrics options. Setting a registry backend option is mandatory in order to effectively report metrics.

jvmMetricsEnabled - Whether JVM metrics should be collected. Defaults to false.

labelMatches - Set a list of rules for label matching.

labelMatchs - Add a rule for label matching.

labels - Sets enabled labels. These labels can be fine-tuned later on using Micrometer's Meter filters (see http://micrometer.io/docs/concepts#_meter_filters)

micrometerRegistry - Programmatically set the Micrometer MeterRegistry to be used by Vert.x. This is useful in several scenarios, such as: if there is already a MeterRegistry used in the application that should be used by Vert.x as well. to define some backend configuration that is not covered in this module (example: reporting to non-covered backends such as New Relic) to use Micrometer's CompositeRegistry This setter is mutually exclusive with setInfluxDbOptions/setPrometheusOptions/setJmxMetricsOptions and takes precedence over them.

prometheusOptions - Set Prometheus options. Setting a registry backend option is mandatory in order to effectively report metrics.

registryName - Set a name for the metrics registry, so that a new registry will be created and associated with this name. If registryName is not provided (or null), a default registry will be used. If the same name is given to several Vert.x instances (within the same JVM), they will share the same registry.