public class DropwizardMetricsOptions extends MetricsOptions
Modifier and Type | Field and Description |
---|---|
static boolean |
DEFAULT_JMX_ENABLED
The default value of JMX enabled =
false |
static List<Match> |
DEFAULT_MONITORED_HANDLERS
The default monitored handlers :
null |
static List<Match> |
DEFAULT_MONITORED_HTTP_CLIENT_ENDPOINTS
The default monitored http client endpoints :
null |
static List<Match> |
DEFAULT_MONITORED_HTTP_CLIENT_URIS
The default monitored http client uris :
null |
static List<Match> |
DEFAULT_MONITORED_HTTP_SERVER_ROUTES
The default monitored http server routes :
null |
static List<Match> |
DEFAULT_MONITORED_HTTP_SERVER_URIS
The default monitored http server uris :
null |
DEFAULT_METRICS_ENABLED
Constructor and Description |
---|
DropwizardMetricsOptions()
Default constructor
|
DropwizardMetricsOptions(DropwizardMetricsOptions other)
Copy constructor
|
DropwizardMetricsOptions(JsonObject json)
Create an instance from a
JsonObject |
DropwizardMetricsOptions(MetricsOptions other)
Copy constructor with base metrics options
|
Modifier and Type | Method and Description |
---|---|
DropwizardMetricsOptions |
addMonitoredEventBusHandler(Match match)
Add a monitored event bus handler.
|
DropwizardMetricsOptions |
addMonitoredHttpClientEndpoint(Match match)
Add an monitored http client endpoint.
|
DropwizardMetricsOptions |
addMonitoredHttpClientUri(Match match)
Add an monitored http client uri.
|
DropwizardMetricsOptions |
addMonitoredHttpServerRoute(Match match)
Add an monitored http server route.
|
DropwizardMetricsOptions |
addMonitoredHttpServerUri(Match match)
Add an monitored http server uri.
|
String |
getBaseName() |
String |
getConfigPath() |
String |
getJmxDomain()
Get the JMX domain to use when JMX metrics are enabled.
|
com.codahale.metrics.MetricRegistry |
getMetricRegistry()
An optional metric registry used instead of the Dropwizard shared registry.
|
List<Match> |
getMonitoredEventBusHandlers() |
List<Match> |
getMonitoredHttpClientEndpoint() |
List<Match> |
getMonitoredHttpClientUris() |
List<Match> |
getMonitoredHttpServerRoutes() |
List<Match> |
getMonitoredHttpServerUris() |
String |
getRegistryName()
An optional name used for registering the metrics in the Dropwizard shared registry.
|
boolean |
isJmxEnabled()
Will JMX be enabled on the Vert.x instance?
|
DropwizardMetricsOptions |
setBaseName(String baseName)
Set a custom baseName for metrics.
|
DropwizardMetricsOptions |
setConfigPath(String configPath)
Set the path for a config file that contains options in JSON format, to be used to create a new options object.
|
DropwizardMetricsOptions |
setEnabled(boolean enable)
Set whether metrics will be enabled on the Vert.x instance.
|
DropwizardMetricsOptions |
setJmxDomain(String jmxDomain)
Set the JMX domain to use when JMX metrics are enabled.
|
DropwizardMetricsOptions |
setJmxEnabled(boolean jmxEnabled)
Set whether JMX will be enabled on the Vert.x instance.
|
DropwizardMetricsOptions |
setMetricRegistry(com.codahale.metrics.MetricRegistry metricRegistry)
Set the optional metric registry used instead of the Dropwizard shared registry.
|
DropwizardMetricsOptions |
setRegistryName(String registryName)
Set the name used for registering the metrics in the Dropwizard shared registry.
|
JsonObject |
toJson() |
getFactory, isEnabled, setFactory, toString
public static final boolean DEFAULT_JMX_ENABLED
false
public static final List<Match> DEFAULT_MONITORED_HANDLERS
null
public static final List<Match> DEFAULT_MONITORED_HTTP_SERVER_URIS
null
public static final List<Match> DEFAULT_MONITORED_HTTP_SERVER_ROUTES
null
public static final List<Match> DEFAULT_MONITORED_HTTP_CLIENT_URIS
null
public DropwizardMetricsOptions()
public DropwizardMetricsOptions(MetricsOptions other)
other
- The other MetricsOptions
to copy when creating thispublic DropwizardMetricsOptions(DropwizardMetricsOptions other)
other
- The other DropwizardMetricsOptions
to copy when creating thispublic DropwizardMetricsOptions(JsonObject json)
JsonObject
json
- the JsonObject to create it frompublic String getRegistryName()
public DropwizardMetricsOptions setRegistryName(String registryName)
registryName
- the namepublic boolean isJmxEnabled()
public DropwizardMetricsOptions setJmxEnabled(boolean jmxEnabled)
jmxEnabled
- true if JMX enabled, or false if not.public String getJmxDomain()
public DropwizardMetricsOptions setJmxDomain(String jmxDomain)
jmxDomain
- the JMX domainpublic List<Match> getMonitoredEventBusHandlers()
public DropwizardMetricsOptions addMonitoredEventBusHandler(Match match)
match
- the event bus address matchpublic List<Match> getMonitoredHttpServerUris()
public DropwizardMetricsOptions addMonitoredHttpServerUri(Match match)
match
- the handler matchpublic List<Match> getMonitoredHttpServerRoutes()
public DropwizardMetricsOptions addMonitoredHttpServerRoute(Match match)
match
- the handler matchpublic List<Match> getMonitoredHttpClientUris()
public DropwizardMetricsOptions setEnabled(boolean enable)
MetricsOptions
setEnabled
in class MetricsOptions
enable
- true if metrics enabled, or false if not.public String getConfigPath()
public DropwizardMetricsOptions setConfigPath(String configPath)
configPath
- the file namepublic DropwizardMetricsOptions addMonitoredHttpClientUri(Match match)
match
- the handler matchpublic DropwizardMetricsOptions addMonitoredHttpClientEndpoint(Match match)
match
- the handler matchpublic List<Match> getMonitoredHttpClientEndpoint()
public DropwizardMetricsOptions setBaseName(String baseName)
baseName
- the new baseName.public String getBaseName()
public com.codahale.metrics.MetricRegistry getMetricRegistry()
public DropwizardMetricsOptions setMetricRegistry(com.codahale.metrics.MetricRegistry metricRegistry)
metricRegistry
- the metricRegistrypublic JsonObject toJson()
toJson
in class MetricsOptions
Copyright © 2022 Eclipse. All rights reserved.