Skip navigation links
A B C D E F G I J M N P R S T V 

A

addDisabledMetricsCategory(MetricsDomain) - Method in class io.vertx.micrometer.MicrometerMetricsOptions
Set metric that will not be registered.
addLabelMatch(Match) - Method in class io.vertx.micrometer.MicrometerMetricsOptions
Add a rule for label matching.

B

BackendRegistries - Class in io.vertx.micrometer.backends
BackendRegistries is responsible for managing registries related to particular micrometer backends (influxdb, prometheus...) It contains a store of BackendRegistry objects, each of whose encapsulating a micrometer's MeterRegistry
BackendRegistry - Interface in io.vertx.micrometer.backends
 

C

close() - Method in interface io.vertx.micrometer.backends.BackendRegistry
 
close() - Method in class io.vertx.micrometer.backends.InfluxDbBackendRegistry
 
close() - Method in class io.vertx.micrometer.backends.JmxBackendRegistry
 
close() - Method in enum io.vertx.micrometer.backends.NoopBackendRegistry
 
close() - Method in class io.vertx.micrometer.backends.PrometheusBackendRegistry
 
create(Measured) - Static method in interface io.vertx.micrometer.MetricsService
Creates a metric service for a given Measured object.

D

DEFAULT_BATCH_SIZE - Static variable in class io.vertx.micrometer.VertxInfluxDbOptions
Default value for the maximum number of metrics in a batch = 10000.
DEFAULT_COMPRESSION_ENABLED - Static variable in class io.vertx.micrometer.VertxInfluxDbOptions
The default gzip enabled on InfluxDb = true.
DEFAULT_CONNECT_TIMEOUT - Static variable in class io.vertx.micrometer.VertxInfluxDbOptions
The default connection timeout (seconds) = 1.
DEFAULT_DATABASE - Static variable in class io.vertx.micrometer.VertxInfluxDbOptions
The default InfluxDb database = default.
DEFAULT_DOMAIN - Static variable in class io.vertx.micrometer.VertxJmxMetricsOptions
Default value for the domain = metrics.
DEFAULT_EMBEDDED_SERVER_ENDPOINT - Static variable in class io.vertx.micrometer.VertxPrometheusOptions
The default metrics endpoint = /metrics when using an embedded server.
DEFAULT_ENABLED - Static variable in class io.vertx.micrometer.VertxInfluxDbOptions
Default value for enabled = false.
DEFAULT_ENABLED - Static variable in class io.vertx.micrometer.VertxJmxMetricsOptions
Default value for enabled = false.
DEFAULT_ENABLED - Static variable in class io.vertx.micrometer.VertxPrometheusOptions
Default value for enabled = false.
DEFAULT_HTTP_SERVER_MATCH - Static variable in class io.vertx.micrometer.MicrometerMetricsOptions
Default label match for public http server: exclude remote label
DEFAULT_LABEL_MATCHES - Static variable in class io.vertx.micrometer.MicrometerMetricsOptions
The default label matches: empty by default
DEFAULT_NET_SERVER_MATCH - Static variable in class io.vertx.micrometer.MicrometerMetricsOptions
Default label match for public net server: exclude remote label
DEFAULT_NUM_THREADS - Static variable in class io.vertx.micrometer.VertxInfluxDbOptions
The default number of threads used = 2.
DEFAULT_READ_TIMEOUT - Static variable in class io.vertx.micrometer.VertxInfluxDbOptions
The default read timeout (seconds) = 10.
DEFAULT_REGISTRY_NAME - Static variable in class io.vertx.micrometer.MicrometerMetricsOptions
Default registry name is 'default'
DEFAULT_START_EMBEDDED_SERVER - Static variable in class io.vertx.micrometer.VertxPrometheusOptions
Default value for starting an embedded server = false.
DEFAULT_STEP - Static variable in class io.vertx.micrometer.VertxInfluxDbOptions
Default value for metric collection interval (in seconds) = 10.
DEFAULT_STEP - Static variable in class io.vertx.micrometer.VertxJmxMetricsOptions
Default value for metric collection interval (in seconds) = 10.
DEFAULT_TYPE - Static variable in class io.vertx.micrometer.Match
The default value : MatchType.EQUALS
DEFAULT_URI - Static variable in class io.vertx.micrometer.VertxInfluxDbOptions
The default InfluxDb server URI = http://localhost:8086.

E

eventBusInitialized(EventBus) - Method in interface io.vertx.micrometer.backends.BackendRegistry
 
eventBusInitialized(EventBus) - Method in class io.vertx.micrometer.backends.InfluxDbBackendRegistry
 
eventBusInitialized(EventBus) - Method in class io.vertx.micrometer.backends.JmxBackendRegistry
 
eventBusInitialized(EventBus) - Method in enum io.vertx.micrometer.backends.NoopBackendRegistry
 
eventBusInitialized(EventBus) - Method in class io.vertx.micrometer.backends.PrometheusBackendRegistry
 

F

fromJson(JsonObject, MicrometerMetricsOptions) - Static method in class io.vertx.micrometer.MicrometerMetricsOptionsConverter
 
fromJson(JsonObject, VertxInfluxDbOptions) - Static method in class io.vertx.micrometer.VertxInfluxDbOptionsConverter
 
fromJson(JsonObject, VertxJmxMetricsOptions) - Static method in class io.vertx.micrometer.VertxJmxMetricsOptionsConverter
 
fromJson(JsonObject, VertxPrometheusOptions) - Static method in class io.vertx.micrometer.VertxPrometheusOptionsConverter
 

G

getAlias() - Method in class io.vertx.micrometer.Match
 
getBaseName() - Method in interface io.vertx.micrometer.MetricsService
 
getBatchSize() - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Get batch size, which is the maximum number of measurements sent per request to the InfluxDB server.
getConnectTimeout() - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Get the connection timeout for InfluxDB server connections, in seconds.
getDb() - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Get the InfluxDB database name used to store metrics
getDefaultNow() - Static method in class io.vertx.micrometer.backends.BackendRegistries
Get the default micrometer registry.
getDisabledMetricsCategories() - Method in class io.vertx.micrometer.MicrometerMetricsOptions
 
getDomain() - Method in class io.vertx.micrometer.Match
 
getDomain() - Method in class io.vertx.micrometer.VertxJmxMetricsOptions
Get the JMX domain under which metrics are published
getEmbeddedServerEndpoint() - Method in class io.vertx.micrometer.VertxPrometheusOptions
Get the HTTP endpoint used if an embedded server is configured
getEmbeddedServerOptions() - Method in class io.vertx.micrometer.VertxPrometheusOptions
Get the HTTP server options of the embedded server, if any
getInfluxDbOptions() - Method in class io.vertx.micrometer.MicrometerMetricsOptions
Get the specific options for InfluxDB reporting.
getJmxMetricsOptions() - Method in class io.vertx.micrometer.MicrometerMetricsOptions
Get the specific options for JMX reporting.
getLabel() - Method in class io.vertx.micrometer.Match
 
getLabelMatchs() - Method in class io.vertx.micrometer.MicrometerMetricsOptions
 
getMeterRegistry() - Method in interface io.vertx.micrometer.backends.BackendRegistry
 
getMeterRegistry() - Method in class io.vertx.micrometer.backends.InfluxDbBackendRegistry
 
getMeterRegistry() - Method in class io.vertx.micrometer.backends.JmxBackendRegistry
 
getMeterRegistry() - Method in enum io.vertx.micrometer.backends.NoopBackendRegistry
 
getMeterRegistry() - Method in class io.vertx.micrometer.backends.PrometheusBackendRegistry
 
getMetricsSnapshot() - Method in interface io.vertx.micrometer.MetricsService
Will return the metrics that correspond with the measured object, null if no metrics is available.

getMetricsSnapshot(String) - Method in interface io.vertx.micrometer.MetricsService
Will return the metrics that begins with the baseName, null if no metrics is available.

getNow(String) - Static method in class io.vertx.micrometer.backends.BackendRegistries
Get the micrometer registry of the given name.
getNumThreads() - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Get the number of threads used by the push scheduler
getPassword() - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Get the password used for authenticated connections
getPrefix() - Method in enum io.vertx.micrometer.MetricsDomain
 
getPrometheusOptions() - Method in class io.vertx.micrometer.MicrometerMetricsOptions
Get the specific options for Prometheus reporting.
getReadTimeout() - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Get the read timeout for InfluxDB server connections, in seconds.
getRegistryName() - Method in class io.vertx.micrometer.MicrometerMetricsOptions
Get the metrics registry name set in these options
getRetentionPolicy() - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Get the InfluxDB retention policy
getStep() - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Get the step of push intervals, in seconds
getStep() - Method in class io.vertx.micrometer.VertxJmxMetricsOptions
Get the step of push intervals, in seconds
getType() - Method in class io.vertx.micrometer.Match
 
getUri() - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Get the InfluxDB server URI
getUserName() - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Get the username used for authenticated connections
getValue() - Method in class io.vertx.micrometer.Match
 

I

InfluxDbBackendRegistry - Class in io.vertx.micrometer.backends
 
InfluxDbBackendRegistry(VertxInfluxDbOptions) - Constructor for class io.vertx.micrometer.backends.InfluxDbBackendRegistry
 
io.vertx.micrometer - package io.vertx.micrometer
= Vert.x Micrometer Metrics This project is an implementation of the Vert.x Metrics Service Provider Interface (SPI).
io.vertx.micrometer.backends - package io.vertx.micrometer.backends
 
isCompressed() - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Get the GZIP compression flag for requests
isEnabled() - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Will InfluxDB reporting be enabled?
isEnabled() - Method in class io.vertx.micrometer.VertxJmxMetricsOptions
Will JMX reporting be enabled?
isEnabled() - Method in class io.vertx.micrometer.VertxPrometheusOptions
Will Prometheus reporting be enabled?
isMetricsCategoryDisabled(MetricsDomain) - Method in class io.vertx.micrometer.MicrometerMetricsOptions
Is the given metrics category disabled?
isStartEmbeddedServer() - Method in class io.vertx.micrometer.VertxPrometheusOptions
Returns true if it is configured to start an embedded web server to expose Prometheus metrics

J

JmxBackendRegistry - Class in io.vertx.micrometer.backends
 
JmxBackendRegistry(VertxJmxMetricsOptions) - Constructor for class io.vertx.micrometer.backends.JmxBackendRegistry
 

M

Match - Class in io.vertx.micrometer
A match for a value.
Match() - Constructor for class io.vertx.micrometer.Match
Default constructor
Match(Match) - Constructor for class io.vertx.micrometer.Match
Copy constructor
Match(JsonObject) - Constructor for class io.vertx.micrometer.Match
Create an instance from a JsonObject
MatchType - Enum in io.vertx.micrometer
The type of match.
MetricsDomain - Enum in io.vertx.micrometer
Metric domains with their associated prefixes.
metricsNames() - Method in interface io.vertx.micrometer.MetricsService
 
MetricsService - Interface in io.vertx.micrometer
The metrics service mainly allows to return a snapshot of measured objects.
This service is derived and adapted from MetricsService in the vertx-dropwizard-metrics module.
MicrometerMetricsOptions - Class in io.vertx.micrometer
Vert.x micrometer configuration.
It is required to set either influxDbOptions, prometheusOptions or {@code jmxMetricsOptions] in order to actually report metrics.
MicrometerMetricsOptions() - Constructor for class io.vertx.micrometer.MicrometerMetricsOptions
Creates default options for Micrometer metrics.
MicrometerMetricsOptions(MicrometerMetricsOptions) - Constructor for class io.vertx.micrometer.MicrometerMetricsOptions
Creates new options object for Micrometer metrics, which is a copy of other.
MicrometerMetricsOptions(JsonObject) - Constructor for class io.vertx.micrometer.MicrometerMetricsOptions
Creates new options object for Micrometer metrics from json input.
MicrometerMetricsOptionsConverter - Class in io.vertx.micrometer
MicrometerMetricsOptionsConverter() - Constructor for class io.vertx.micrometer.MicrometerMetricsOptionsConverter
 

N

NoopBackendRegistry - Enum in io.vertx.micrometer.backends
 

P

PrometheusBackendRegistry - Class in io.vertx.micrometer.backends
 
PrometheusBackendRegistry(Vertx, VertxPrometheusOptions) - Constructor for class io.vertx.micrometer.backends.PrometheusBackendRegistry
 

R

registerMatchers(MeterRegistry, List<Match>) - Static method in class io.vertx.micrometer.backends.BackendRegistries
 

S

setAlias(String) - Method in class io.vertx.micrometer.Match
Set an alias that would replace the label value when it matches.
setBatchSize(int) - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Maximum number of measurements sent per request to the InfluxDB server.
setCompressed(boolean) - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Activate or deactivate GZIP compression.
setConnectTimeout(int) - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Connection timeout for InfluxDB server connections, in seconds.
setDb(String) - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Database name used to store metrics.
setDisabledMetricsCategories(Set<MetricsDomain>) - Method in class io.vertx.micrometer.MicrometerMetricsOptions
Sets metrics types that are disabled.
setDomain(MetricsDomain) - Method in class io.vertx.micrometer.Match
Set the label domain, restricting this rule to a single domain.
setDomain(String) - Method in class io.vertx.micrometer.VertxJmxMetricsOptions
Set the JMX domain under which to publish metrics
setEmbeddedServerEndpoint(String) - Method in class io.vertx.micrometer.VertxPrometheusOptions
Set metrics endpoint.
setEmbeddedServerOptions(HttpServerOptions) - Method in class io.vertx.micrometer.VertxPrometheusOptions
HTTP server options for the embedded server
setEnabled(boolean) - Method in class io.vertx.micrometer.MicrometerMetricsOptions
Set whether metrics will be enabled on the Vert.x instance.
setEnabled(boolean) - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Set true to enable InfluxDB reporting
setEnabled(boolean) - Method in class io.vertx.micrometer.VertxJmxMetricsOptions
Set true to enable Prometheus reporting
setEnabled(boolean) - Method in class io.vertx.micrometer.VertxPrometheusOptions
Set true to enable Prometheus reporting
setInfluxDbOptions(VertxInfluxDbOptions) - Method in class io.vertx.micrometer.MicrometerMetricsOptions
Set InfluxDB options.
setJmxMetricsOptions(VertxJmxMetricsOptions) - Method in class io.vertx.micrometer.MicrometerMetricsOptions
Set JMX metrics options.
setLabel(String) - Method in class io.vertx.micrometer.Match
Set the label name.
setLabelMatchs(List<Match>) - Method in class io.vertx.micrometer.MicrometerMetricsOptions
Set a list of rules for label matching.
setNumThreads(int) - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Number of threads to use by the push scheduler.
setPassword(String) - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Password used for authenticated connections
setPrometheusOptions(VertxPrometheusOptions) - Method in class io.vertx.micrometer.MicrometerMetricsOptions
Set Prometheus options.
setReadTimeout(int) - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Read timeout for InfluxDB server connections, in seconds.
setRegistryName(String) - Method in class io.vertx.micrometer.MicrometerMetricsOptions
Set a name for the metrics registry, so that a new registry will be created and associated with this name.
setRetentionPolicy(String) - Method in class io.vertx.micrometer.VertxInfluxDbOptions
InfluxDB retention policy
setStartEmbeddedServer(boolean) - Method in class io.vertx.micrometer.VertxPrometheusOptions
When true, an embedded server will start to expose metrics with Prometheus format.
setStep(int) - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Push interval steps, in seconds.
setStep(int) - Method in class io.vertx.micrometer.VertxJmxMetricsOptions
Push interval steps, in seconds.
setType(MatchType) - Method in class io.vertx.micrometer.Match
Set the type of matching to apply.
setupBackend(Vertx, MicrometerMetricsOptions) - Static method in class io.vertx.micrometer.backends.BackendRegistries
Create a new backend registry, containing a micrometer registry, initialized with the provided options.
setUri(String) - Method in class io.vertx.micrometer.VertxInfluxDbOptions
URI of the InfluxDB server.
setUserName(String) - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Username used for authenticated connections
setValue(String) - Method in class io.vertx.micrometer.Match
Set the matched value.
stop(String) - Static method in class io.vertx.micrometer.backends.BackendRegistries
Stop (unregister) the backend registry of the given name.

T

toJson(MicrometerMetricsOptions, JsonObject) - Static method in class io.vertx.micrometer.MicrometerMetricsOptionsConverter
 
toJson(VertxInfluxDbOptions, JsonObject) - Static method in class io.vertx.micrometer.VertxInfluxDbOptionsConverter
 
toJson(VertxJmxMetricsOptions, JsonObject) - Static method in class io.vertx.micrometer.VertxJmxMetricsOptionsConverter
 
toJson(VertxPrometheusOptions, JsonObject) - Static method in class io.vertx.micrometer.VertxPrometheusOptionsConverter
 
toMicrometerConfig() - Method in class io.vertx.micrometer.VertxInfluxDbOptions
Convert these options to a Micrometer's InfluxConfig object
toMicrometerConfig() - Method in class io.vertx.micrometer.VertxJmxMetricsOptions
Convert these options to a Micrometer's JmxConfig object

V

valueOf(String) - Static method in enum io.vertx.micrometer.backends.NoopBackendRegistry
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.vertx.micrometer.MatchType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.vertx.micrometer.MetricsDomain
Returns the enum constant of this type with the specified name.
values() - Static method in enum io.vertx.micrometer.backends.NoopBackendRegistry
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.vertx.micrometer.MatchType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.vertx.micrometer.MetricsDomain
Returns an array containing the constants of this enum type, in the order they are declared.
VertxInfluxDbOptions - Class in io.vertx.micrometer
Vert.x InfluxDb micrometer configuration.
VertxInfluxDbOptions() - Constructor for class io.vertx.micrometer.VertxInfluxDbOptions
Create default options for InfluxDB reporting.
VertxInfluxDbOptions(VertxInfluxDbOptions) - Constructor for class io.vertx.micrometer.VertxInfluxDbOptions
Creates new options object for InfluxDB reporting, which is a copy of other.
VertxInfluxDbOptions(JsonObject) - Constructor for class io.vertx.micrometer.VertxInfluxDbOptions
Creates new options object for InfluxDB reporting from json input.
VertxInfluxDbOptionsConverter - Class in io.vertx.micrometer
Converter for VertxInfluxDbOptions.
VertxInfluxDbOptionsConverter() - Constructor for class io.vertx.micrometer.VertxInfluxDbOptionsConverter
 
VertxJmxMetricsOptions - Class in io.vertx.micrometer
Options for Prometheus metrics backend.
VertxJmxMetricsOptions() - Constructor for class io.vertx.micrometer.VertxJmxMetricsOptions
Default constructor
VertxJmxMetricsOptions(VertxJmxMetricsOptions) - Constructor for class io.vertx.micrometer.VertxJmxMetricsOptions
Copy constructor
VertxJmxMetricsOptions(JsonObject) - Constructor for class io.vertx.micrometer.VertxJmxMetricsOptions
Create an instance from a JsonObject
VertxJmxMetricsOptionsConverter - Class in io.vertx.micrometer
Converter for VertxJmxMetricsOptions.
VertxJmxMetricsOptionsConverter() - Constructor for class io.vertx.micrometer.VertxJmxMetricsOptionsConverter
 
VertxPrometheusOptions - Class in io.vertx.micrometer
Options for Prometheus metrics backend.
VertxPrometheusOptions() - Constructor for class io.vertx.micrometer.VertxPrometheusOptions
Default constructor
VertxPrometheusOptions(VertxPrometheusOptions) - Constructor for class io.vertx.micrometer.VertxPrometheusOptions
Copy constructor
VertxPrometheusOptions(JsonObject) - Constructor for class io.vertx.micrometer.VertxPrometheusOptions
Create an instance from a JsonObject
VertxPrometheusOptionsConverter - Class in io.vertx.micrometer
Converter for VertxPrometheusOptions.
VertxPrometheusOptionsConverter() - Constructor for class io.vertx.micrometer.VertxPrometheusOptionsConverter
 
A B C D E F G I J M N P R S T V 
Skip navigation links

Copyright © 2018 Eclipse. All rights reserved.