vertx / io.vertx.micrometer / VertxPrometheusOptions

# VertxPrometheusOptions

`open class VertxPrometheusOptions`

Options for Prometheus metrics backend.

Author
Joel Takvorian

### Constructors

<init> | `VertxPrometheusOptions()` Default constructor `VertxPrometheusOptions(other: VertxPrometheusOptions)` Copy constructor `VertxPrometheusOptions(json: JsonObject)` Create an instance from a io.vertx.core.json.JsonObject

### Properties

DEFAULT_EMBEDDED_SERVER_ENDPOINT | `static val DEFAULT_EMBEDDED_SERVER_ENDPOINT: String` The default metrics endpoint = /metrics when using an embedded server.
DEFAULT_ENABLED | `static val DEFAULT_ENABLED: Boolean` Default value for enabled = false.
DEFAULT_START_EMBEDDED_SERVER | `static val DEFAULT_START_EMBEDDED_SERVER: Boolean` Default value for starting an embedded server = false.

### Functions

getEmbeddedServerEndpoint | `open fun getEmbeddedServerEndpoint(): String` Get the HTTP endpoint used if an embedded server is configured
getEmbeddedServerOptions | `open fun getEmbeddedServerOptions(): HttpServerOptions` Get the HTTP server options of the embedded server, if any
isEnabled | `open fun isEnabled(): Boolean` Will Prometheus reporting be enabled?
isStartEmbeddedServer | `open fun isStartEmbeddedServer(): Boolean` Returns true if it is configured to start an embedded web server to expose Prometheus metrics
setEmbeddedServerEndpoint | `open fun setEmbeddedServerEndpoint(embeddedServerEndpoint: String): VertxPrometheusOptions` Set metrics endpoint. Use conjointly with the embedded server options. Defaults to /metrics.
setEmbeddedServerOptions | `open fun setEmbeddedServerOptions(embeddedServerOptions: HttpServerOptions): VertxPrometheusOptions` HTTP server options for the embedded server
setEnabled | `open fun setEnabled(enabled: Boolean): VertxPrometheusOptions` Set true to enable Prometheus reporting
setStartEmbeddedServer | `open fun setStartEmbeddedServer(startEmbeddedServer: Boolean): VertxPrometheusOptions` When true, an embedded server will start to expose metrics with Prometheus format.