Skip navigation links
A B C E G H I N O R S T U V W 

A

add(String, HealthCheckRegistry) - Static method in class com.codahale.metrics.health.SharedHealthCheckRegistries
 
addListener(HealthCheckRegistryListener) - Method in class com.codahale.metrics.health.HealthCheckRegistry
Adds a HealthCheckRegistryListener to a collection of listeners that will be notified on health check registration.
Async - Annotation Type in com.codahale.metrics.health.annotation
An annotation for marking asynchronous health check execution.
Async.InitialState - Enum in com.codahale.metrics.health.annotation
Enum representing the initial health states.
Async.ScheduleType - Enum in com.codahale.metrics.health.annotation
Enum representing the possible schedule types.

B

build() - Method in class com.codahale.metrics.health.HealthCheck.ResultBuilder
 
builder() - Static method in class com.codahale.metrics.health.HealthCheck.Result

C

check() - Method in class com.codahale.metrics.health.HealthCheck
Perform a check of the application component.
check() - Method in class com.codahale.metrics.health.jvm.ThreadDeadlockHealthCheck
 
clear() - Static method in class com.codahale.metrics.health.SharedHealthCheckRegistries
 
com.codahale.metrics.health - package com.codahale.metrics.health
 
com.codahale.metrics.health.annotation - package com.codahale.metrics.health.annotation
 
com.codahale.metrics.health.jvm - package com.codahale.metrics.health.jvm
 

E

equals(Object) - Method in class com.codahale.metrics.health.HealthCheck.Result
 
execute() - Method in class com.codahale.metrics.health.HealthCheck
Executes the health check, catching and handling any exceptions raised by HealthCheck.check().

G

getDefault() - Static method in class com.codahale.metrics.health.SharedHealthCheckRegistries
Gets the name of the default registry, if it has been set
getDetails() - Method in class com.codahale.metrics.health.HealthCheck.Result
 
getError() - Method in class com.codahale.metrics.health.HealthCheck.Result
Returns any exception for the result, or null if the result has no exception.
getMessage() - Method in class com.codahale.metrics.health.HealthCheck.Result
Returns any additional message for the result, or null if the result has no message.
getNames() - Method in class com.codahale.metrics.health.HealthCheckRegistry
Returns a set of the names of all registered health checks.
getOrCreate(String) - Static method in class com.codahale.metrics.health.SharedHealthCheckRegistries
 
getTimestamp() - Method in class com.codahale.metrics.health.HealthCheck.Result
Returns the timestamp when the result was created.

H

hashCode() - Method in class com.codahale.metrics.health.HealthCheck.Result
 
HealthCheck - Class in com.codahale.metrics.health
A health check for a component of your application.
HealthCheck() - Constructor for class com.codahale.metrics.health.HealthCheck
 
HealthCheck.Result - Class in com.codahale.metrics.health
The result of a HealthCheck being run.
HealthCheck.ResultBuilder - Class in com.codahale.metrics.health
This a convenient builder for an HealthCheck.Result.
HealthCheckRegistry - Class in com.codahale.metrics.health
A registry for health checks.
HealthCheckRegistry() - Constructor for class com.codahale.metrics.health.HealthCheckRegistry
Creates a new HealthCheckRegistry.
HealthCheckRegistry(int) - Constructor for class com.codahale.metrics.health.HealthCheckRegistry
Creates a new HealthCheckRegistry.
HealthCheckRegistry(ScheduledExecutorService) - Constructor for class com.codahale.metrics.health.HealthCheckRegistry
Creates a new HealthCheckRegistry.
HealthCheckRegistryListener - Interface in com.codahale.metrics.health
A listener contract for HealthCheckRegistry events.
healthy() - Static method in class com.codahale.metrics.health.HealthCheck.Result
Returns a healthy HealthCheck.Result with no additional message.
healthy(String) - Static method in class com.codahale.metrics.health.HealthCheck.Result
Returns a healthy HealthCheck.Result with an additional message.
healthy(String, Object...) - Static method in class com.codahale.metrics.health.HealthCheck.Result
Returns a healthy HealthCheck.Result with a formatted message.
healthy() - Method in class com.codahale.metrics.health.HealthCheck.ResultBuilder
Configure an healthy result

I

isHealthy() - Method in class com.codahale.metrics.health.HealthCheck.Result
Returns true if the result indicates the component is healthy; false otherwise.

N

names() - Static method in class com.codahale.metrics.health.SharedHealthCheckRegistries
 

O

onHealthCheckAdded(String, HealthCheck) - Method in interface com.codahale.metrics.health.HealthCheckRegistryListener
Called when a new HealthCheck is added to the registry.
onHealthCheckRemoved(String, HealthCheck) - Method in interface com.codahale.metrics.health.HealthCheckRegistryListener
Called when a HealthCheck is removed from the registry.

R

register(String, HealthCheck) - Method in class com.codahale.metrics.health.HealthCheckRegistry
Registers an application HealthCheck.
remove(String) - Static method in class com.codahale.metrics.health.SharedHealthCheckRegistries
 
removeListener(HealthCheckRegistryListener) - Method in class com.codahale.metrics.health.HealthCheckRegistry
Removes a HealthCheckRegistryListener from this registry's collection of listeners.
ResultBuilder() - Constructor for class com.codahale.metrics.health.HealthCheck.ResultBuilder
 
runHealthCheck(String) - Method in class com.codahale.metrics.health.HealthCheckRegistry
Runs the health check with the given name.
runHealthChecks() - Method in class com.codahale.metrics.health.HealthCheckRegistry
Runs the registered health checks and returns a map of the results.
runHealthChecks(ExecutorService) - Method in class com.codahale.metrics.health.HealthCheckRegistry
Runs the registered health checks in parallel and returns a map of the results.

S

setDefault(String) - Static method in class com.codahale.metrics.health.SharedHealthCheckRegistries
Creates a new registry and sets it as the default one under the provided name.
setDefault(String, HealthCheckRegistry) - Static method in class com.codahale.metrics.health.SharedHealthCheckRegistries
Sets the provided registry as the default one under the provided name
SharedHealthCheckRegistries - Class in com.codahale.metrics.health
A map of shared, named health registries.
shutdown() - Method in class com.codahale.metrics.health.HealthCheckRegistry
Shuts down the scheduled executor for async health checks

T

ThreadDeadlockHealthCheck - Class in com.codahale.metrics.health.jvm
A health check which returns healthy if no threads are deadlocked.
ThreadDeadlockHealthCheck() - Constructor for class com.codahale.metrics.health.jvm.ThreadDeadlockHealthCheck
Creates a new health check.
ThreadDeadlockHealthCheck(ThreadDeadlockDetector) - Constructor for class com.codahale.metrics.health.jvm.ThreadDeadlockHealthCheck
Creates a new health check with the given detector.
toString() - Method in class com.codahale.metrics.health.HealthCheck.Result
 
tryGetDefault() - Static method in class com.codahale.metrics.health.SharedHealthCheckRegistries
Same as SharedHealthCheckRegistries.getDefault() except returns null when the default registry has not been set.

U

unhealthy(String) - Static method in class com.codahale.metrics.health.HealthCheck.Result
Returns an unhealthy HealthCheck.Result with the given message.
unhealthy(String, Object...) - Static method in class com.codahale.metrics.health.HealthCheck.Result
Returns an unhealthy HealthCheck.Result with a formatted message.
unhealthy(Throwable) - Static method in class com.codahale.metrics.health.HealthCheck.Result
Returns an unhealthy HealthCheck.Result with the given error.
unhealthy() - Method in class com.codahale.metrics.health.HealthCheck.ResultBuilder
Configure an unhealthy result
unhealthy(Throwable) - Method in class com.codahale.metrics.health.HealthCheck.ResultBuilder
Configure an unhealthy result with an error
unregister(String) - Method in class com.codahale.metrics.health.HealthCheckRegistry
Unregisters the application HealthCheck with the given name.

V

valueOf(String) - Static method in enum com.codahale.metrics.health.annotation.Async.InitialState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.codahale.metrics.health.annotation.Async.ScheduleType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.codahale.metrics.health.annotation.Async.InitialState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.codahale.metrics.health.annotation.Async.ScheduleType
Returns an array containing the constants of this enum type, in the order they are declared.

W

withDetail(String, Object) - Method in class com.codahale.metrics.health.HealthCheck.ResultBuilder
Add an optional detail
withMessage(String) - Method in class com.codahale.metrics.health.HealthCheck.ResultBuilder
Set an optional message
withMessage(String, Object...) - Method in class com.codahale.metrics.health.HealthCheck.ResultBuilder
Set an optional formatted message

Message formatting follows the same rules as String.format(String, Object...).

A B C E G H I N O R S T U V W 
Skip navigation links

Copyright © 2020. All Rights Reserved.