vertx / io.vertx.micrometer / VertxJmxMetricsOptions

VertxJmxMetricsOptions

open class VertxJmxMetricsOptions

Options for Prometheus metrics backend.

Author
Joel Takvorian

Constructors

<init>

VertxJmxMetricsOptions()

Default constructor

VertxJmxMetricsOptions(other: VertxJmxMetricsOptions)

Copy constructor

VertxJmxMetricsOptions(json: JsonObject)

Create an instance from a JsonObject

Properties

DEFAULT_DOMAIN

static val DEFAULT_DOMAIN: String

Default value for the domain = metrics.

DEFAULT_ENABLED

static val DEFAULT_ENABLED: Boolean

Default value for enabled = false.

DEFAULT_STEP

static val DEFAULT_STEP: Int

Default value for metric collection interval (in seconds) = 10.

Functions

getDomain

open fun getDomain(): String

Get the JMX domain under which metrics are published

getStep

open fun getStep(): Int

Get the step of push intervals, in seconds

isEnabled

open fun isEnabled(): Boolean

Will JMX reporting be enabled?

setDomain

open fun setDomain(domain: String): VertxJmxMetricsOptions

Set the JMX domain under which to publish metrics

setEnabled

open fun setEnabled(enabled: Boolean): VertxJmxMetricsOptions

Set true to enable Prometheus reporting

setStep

open fun setStep(step: Int): VertxJmxMetricsOptions

Push interval steps, in seconds. Default is 10 seconds.

toMicrometerConfig

open fun toMicrometerConfig(): JmxConfig

Convert these options to a Micrometer's JmxConfig object