open class MicrometerMetricsOptions : MetricsOptions
Vert.x micrometer configuration. It is required to set either influxDbOptions, prometheusOptions or jmxMetricsOptions] in order to actually report metrics. Joel Takvorian
MicrometerMetricsOptions()
Creates default options for Micrometer metrics. MicrometerMetricsOptions(other: MicrometerMetricsOptions)
Creates new options object for Micrometer metrics, which is a copy of MicrometerMetricsOptions(json: JsonObject)
Creates new options object for Micrometer metrics from |
static val DEFAULT_HTTP_SERVER_MATCH: Match
Default label match for public http server: exclude remote label |
|
static val DEFAULT_LABEL_MATCHES: MutableList<Match>
The default label matches: empty by default |
|
static val DEFAULT_NET_SERVER_MATCH: Match
Default label match for public net server: exclude remote label |
|
static val DEFAULT_REGISTRY_NAME: String
Default registry name is 'default' |
open fun addDisabledMetricsCategory(metricsDomain: MetricsDomain): MicrometerMetricsOptions
Set metric that will not be registered. Schedulers will check the set |
|
open fun addLabelMatch(match: Match): MicrometerMetricsOptions
Add a rule for label matching. |
|
open fun getDisabledMetricsCategories(): MutableSet<MetricsDomain> |
|
open fun getInfluxDbOptions(): VertxInfluxDbOptions
Get the specific options for InfluxDB reporting. |
|
open fun getJmxMetricsOptions(): VertxJmxMetricsOptions
Get the specific options for JMX reporting. |
|
open fun getLabelMatchs(): MutableList<Match> |
|
open fun getPrometheusOptions(): VertxPrometheusOptions
Get the specific options for Prometheus reporting. |
|
open fun getRegistryName(): String
Get the metrics registry name set in these options |
|
open fun isMetricsCategoryDisabled(metricsDomain: MetricsDomain): Boolean
Is the given metrics category disabled? |
|
open fun setDisabledMetricsCategories(disabledMetricsCategories: MutableSet<MetricsDomain>): MicrometerMetricsOptions
Sets metrics types that are disabled. |
|
open fun setEnabled(enable: Boolean): MicrometerMetricsOptions
Set whether metrics will be enabled on the Vert.x instance. Metrics are not enabled by default. |
|
open fun setInfluxDbOptions(influxDbOptions: VertxInfluxDbOptions): MicrometerMetricsOptions
Set InfluxDB options. Setting a registry backend option is mandatory in order to effectively report metrics. |
|
open fun setJmxMetricsOptions(jmxMetricsOptions: VertxJmxMetricsOptions): MicrometerMetricsOptions
Set JMX metrics options. Setting a registry backend option is mandatory in order to effectively report metrics. |
|
open fun setLabelMatchs(matches: MutableList<Match>): MicrometerMetricsOptions
Set a list of rules for label matching. |
|
open fun setPrometheusOptions(prometheusOptions: VertxPrometheusOptions): MicrometerMetricsOptions
Set Prometheus options. Setting a registry backend option is mandatory in order to effectively report metrics. |
|
open fun setRegistryName(registryName: String): MicrometerMetricsOptions
Set a name for the metrics registry, so that a new registry will be created and associated with this name. If |