Class DropwizardMetricsOptions

Vert.x Dropwizard metrics configuration.

Hierarchy

any
- DropwizardMetricsOptions

Index

Constructors

constructor

Constructors

constructor

new DropwizardMetricsOptions(): DropwizardMetricsOptions
new DropwizardMetricsOptions(obj: DropwizardMetricsOptions | {}): DropwizardMetricsOptions

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:22
Returns DropwizardMetricsOptions
- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:24
Parameters
- obj: DropwizardMetricsOptions | {}
Returns DropwizardMetricsOptions

Methods

addMonitoredEventBusHandler

addMonitoredEventBusHandler(monitoredEventBusHandlers: Match): DropwizardMetricsOptions

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:96
Add a monitored event bus handler.

Parameters
- monitoredEventBusHandlers: Match
Returns DropwizardMetricsOptions

addMonitoredHttpClientEndpoint

addMonitoredHttpClientEndpoint(monitoredHttpClientEndpoints: Match): DropwizardMetricsOptions

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:105
Add an monitored http client endpoint.

Parameters
- monitoredHttpClientEndpoints: Match
Returns DropwizardMetricsOptions

addMonitoredHttpClientUri

addMonitoredHttpClientUri(monitoredHttpClientUris: Match): DropwizardMetricsOptions

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:115
Add an monitored http client uri.

Parameters
- monitoredHttpClientUris: Match
Returns DropwizardMetricsOptions

addMonitoredHttpServerRoute

addMonitoredHttpServerRoute(monitoredHttpServerRoutes: Match): DropwizardMetricsOptions

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:125
Add an monitored http server route.

Parameters
- monitoredHttpServerRoutes: Match
Returns DropwizardMetricsOptions

addMonitoredHttpServerUri

addMonitoredHttpServerUri(monitoredHttpServerUris: Match): DropwizardMetricsOptions

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:135
Add an monitored http server uri.

Parameters
- monitoredHttpServerUris: Match
Returns DropwizardMetricsOptions

getBaseName

getBaseName(): string

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:31
Set a custom baseName for metrics.

Returns string

getConfigPath

getConfigPath(): string

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:42
Set the path for a config file that contains options in JSON format, to be used to create a new options object. The file will be looked for on the file system first and then on the classpath if it's not found.

Returns string

getFactory

getFactory(): any

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:54
Returns any

getJmxDomain

getJmxDomain(): string

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:61
Set the JMX domain to use when JMX metrics are enabled.

Returns string

getMetricRegistry

getMetricRegistry(): any

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:81
Set the optional metric registry used instead of the Dropwizard shared registry.

Returns any

getMonitoredEventBusHandlers

getMonitoredEventBusHandlers(): Match[]

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:91
Add a monitored event bus handler.

Returns Match[]

getMonitoredHttpClientEndpoint

getMonitoredHttpClientEndpoint(): Match[]

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:100
Returns Match[]

getMonitoredHttpClientUris

getMonitoredHttpClientUris(): Match[]

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:110
Add an monitored http client uri.

Returns Match[]

getMonitoredHttpServerRoutes

getMonitoredHttpServerRoutes(): Match[]

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:120
Add an monitored http server route.

Returns Match[]

getMonitoredHttpServerUris

getMonitoredHttpServerUris(): Match[]

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:130
Add an monitored http server uri.

Returns Match[]

getRegistryName

getRegistryName(): string

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:140
Set the name used for registering the metrics in the Dropwizard shared registry.

Returns string

isEnabled

isEnabled(): boolean

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:50
Returns boolean

isJmxEnabled

isJmxEnabled(): boolean

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:71
Set whether JMX will be enabled on the Vert.x instance.

Returns boolean

setBaseName

setBaseName(baseName: string): DropwizardMetricsOptions

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:36
Set a custom baseName for metrics.

Parameters
- baseName: string
Returns DropwizardMetricsOptions

setConfigPath

setConfigPath(configPath: string): DropwizardMetricsOptions

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:48
Set the path for a config file that contains options in JSON format, to be used to create a new options object. The file will be looked for on the file system first and then on the classpath if it's not found.

Parameters
- configPath: string
Returns DropwizardMetricsOptions

setEnabled

setEnabled(enabled: boolean): DropwizardMetricsOptions

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:52
Parameters
- enabled: boolean
Returns DropwizardMetricsOptions

setFactory

setFactory(factory: any): DropwizardMetricsOptions

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:56
Parameters
- factory: any
Returns DropwizardMetricsOptions

setJmxDomain

setJmxDomain(jmxDomain: string): DropwizardMetricsOptions

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:66
Set the JMX domain to use when JMX metrics are enabled.

Parameters
- jmxDomain: string
Returns DropwizardMetricsOptions

setJmxEnabled

setJmxEnabled(jmxEnabled: boolean): DropwizardMetricsOptions

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:76
Set whether JMX will be enabled on the Vert.x instance.

Parameters
- jmxEnabled: boolean
Returns DropwizardMetricsOptions

setMetricRegistry

setMetricRegistry(metricRegistry: any): DropwizardMetricsOptions

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:86
Set the optional metric registry used instead of the Dropwizard shared registry.

Parameters
- metricRegistry: any
Returns DropwizardMetricsOptions

setRegistryName

setRegistryName(registryName: string): DropwizardMetricsOptions

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:145
Set the name used for registering the metrics in the Dropwizard shared registry.

Parameters
- registryName: string
Returns DropwizardMetricsOptions

toJson

toJson(): {}

- Defined in io.vertx/vertx-dropwizard-metrics/target/npm/options.d.ts:148
Returns {}
- [key: string]: any

Generated using TypeDoc