public class MicrometerMetricsOptions extends MetricsOptions
influxDbOptions, prometheusOptions or {@code jmxMetricsOptions]
in order to actually report metrics.| Modifier and Type | Field and Description |
|---|---|
static Match |
DEFAULT_HTTP_SERVER_MATCH
Default label match for public http server: exclude remote label
|
static List<Match> |
DEFAULT_LABEL_MATCHES
The default label matches: empty by default
|
static Match |
DEFAULT_NET_SERVER_MATCH
Default label match for public net server: exclude remote label
|
static String |
DEFAULT_REGISTRY_NAME
Default registry name is 'default'
|
DEFAULT_METRICS_ENABLED| Constructor and Description |
|---|
MicrometerMetricsOptions()
Creates default options for Micrometer metrics.
|
MicrometerMetricsOptions(JsonObject json)
Creates new options object for Micrometer metrics from
json input. |
MicrometerMetricsOptions(MicrometerMetricsOptions other)
Creates new options object for Micrometer metrics, which is a copy of
other. |
| Modifier and Type | Method and Description |
|---|---|
MicrometerMetricsOptions |
addDisabledMetricsCategory(MetricsDomain metricsDomain)
Set metric that will not be registered.
|
MicrometerMetricsOptions |
addLabelMatch(Match match)
Add a rule for label matching.
|
Set<MetricsDomain> |
getDisabledMetricsCategories() |
VertxInfluxDbOptions |
getInfluxDbOptions()
Get the specific options for InfluxDB reporting.
|
VertxJmxMetricsOptions |
getJmxMetricsOptions()
Get the specific options for JMX reporting.
|
List<Match> |
getLabelMatchs() |
VertxPrometheusOptions |
getPrometheusOptions()
Get the specific options for Prometheus reporting.
|
String |
getRegistryName()
Get the metrics registry name set in these options
|
boolean |
isMetricsCategoryDisabled(MetricsDomain metricsDomain)
Is the given metrics category disabled?
|
MicrometerMetricsOptions |
setDisabledMetricsCategories(Set<MetricsDomain> disabledMetricsCategories)
Sets metrics types that are disabled.
|
MicrometerMetricsOptions |
setEnabled(boolean enable)
Set whether metrics will be enabled on the Vert.x instance.
|
MicrometerMetricsOptions |
setInfluxDbOptions(VertxInfluxDbOptions influxDbOptions)
Set InfluxDB options.
|
MicrometerMetricsOptions |
setJmxMetricsOptions(VertxJmxMetricsOptions jmxMetricsOptions)
Set JMX metrics options.
|
MicrometerMetricsOptions |
setLabelMatchs(List<Match> matches)
Set a list of rules for label matching.
|
MicrometerMetricsOptions |
setPrometheusOptions(VertxPrometheusOptions prometheusOptions)
Set Prometheus options.
|
MicrometerMetricsOptions |
setRegistryName(String registryName)
Set a name for the metrics registry, so that a new registry will be created and associated with this name.
|
equals, getFactory, hashCode, isEnabled, setFactory, toJson, toStringpublic static final String DEFAULT_REGISTRY_NAME
public static final Match DEFAULT_HTTP_SERVER_MATCH
public static final Match DEFAULT_NET_SERVER_MATCH
public MicrometerMetricsOptions()
public MicrometerMetricsOptions(MicrometerMetricsOptions other)
other.public MicrometerMetricsOptions(JsonObject json)
json input.public MicrometerMetricsOptions setEnabled(boolean enable)
setEnabled in class MetricsOptionsenable - true if metrics enabled, or false if not.public Set<MetricsDomain> getDisabledMetricsCategories()
public MicrometerMetricsOptions setDisabledMetricsCategories(Set<MetricsDomain> disabledMetricsCategories)
disabledMetricsCategories - to specify the set of metrics types to be disabled.public MicrometerMetricsOptions addDisabledMetricsCategory(MetricsDomain metricsDomain)
disabledMetricsCategories when
registering metrics suppliersmetricsDomain - the type of metricspublic boolean isMetricsCategoryDisabled(MetricsDomain metricsDomain)
public String getRegistryName()
public MicrometerMetricsOptions setRegistryName(String registryName)
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.registryName - a name to uniquely identify this registrypublic MicrometerMetricsOptions setLabelMatchs(List<Match> matches)
matches - the new list of rulespublic MicrometerMetricsOptions addLabelMatch(Match match)
match - the label matchpublic VertxInfluxDbOptions getInfluxDbOptions()
public MicrometerMetricsOptions setInfluxDbOptions(VertxInfluxDbOptions influxDbOptions)
influxDbOptions - backend options for InfluxDBpublic VertxPrometheusOptions getPrometheusOptions()
public MicrometerMetricsOptions setPrometheusOptions(VertxPrometheusOptions prometheusOptions)
prometheusOptions - backend options for Prometheuspublic VertxJmxMetricsOptions getJmxMetricsOptions()
public MicrometerMetricsOptions setJmxMetricsOptions(VertxJmxMetricsOptions jmxMetricsOptions)
jmxMetricsOptions - backend options for JMX reportingCopyright © 2018 Eclipse. All rights reserved.