io.vertx.kotlin.micrometer.VertxJmxMetricsOptions.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vertx-lang-kotlin Show documentation

There is a newer version: 5.0.0.CR1

/*
 * Copyright 2019 Red Hat, Inc.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Apache License v2.0 which accompanies this distribution.
 *
 * The Eclipse Public License is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * The Apache License v2.0 is available at
 * http://www.opensource.org/licenses/apache2.0.php
 *
 * You may elect to redistribute this code under either of these licenses.
 */
package io.vertx.kotlin.micrometer

import io.vertx.micrometer.VertxJmxMetricsOptions

/**
 * A function providing a DSL for building [io.vertx.micrometer.VertxJmxMetricsOptions] objects.
 *
 * Options for Prometheus metrics backend.
 *
 * @param enabled  Set true to enable Prometheus reporting
 * @param domain  Set the JMX domain under which to publish metrics
 * @param step  Push interval steps, in seconds. Default is 10 seconds.
 *
 * 
 * NOTE: This function has been automatically generated from the [io.vertx.micrometer.VertxJmxMetricsOptions original] using Vert.x codegen.
 */
fun vertxJmxMetricsOptionsOf(
  enabled: Boolean? = null,
  domain: String? = null,
  step: Int? = null): VertxJmxMetricsOptions = io.vertx.micrometer.VertxJmxMetricsOptions().apply {

  if (enabled != null) {
    this.setEnabled(enabled)
  }
  if (domain != null) {
    this.setDomain(domain)
  }
  if (step != null) {
    this.setStep(step)
  }
}