Package com.codahale.metrics.health.jvm

Class ThreadDeadlockHealthCheck

java.lang.Object

com.codahale.metrics.health.HealthCheck

com.codahale.metrics.health.jvm.ThreadDeadlockHealthCheck

public class ThreadDeadlockHealthCheck
extends HealthCheck

A health check which returns healthy if no threads are deadlocked.

Nested Class Summary

Nested classes/interfaces inherited from class com.codahale.metrics.health.HealthCheck

HealthCheck.Result, HealthCheck.ResultBuilder

Constructor Summary

Constructors

Constructor	Description
ThreadDeadlockHealthCheck()	Creates a new health check.
ThreadDeadlockHealthCheck(com.codahale.metrics.jvm.ThreadDeadlockDetector detector)	Creates a new health check with the given detector.

Method Summary

Modifier and Type	Method	Description
protected HealthCheck.Result	check()	Perform a check of the application component.

Methods inherited from class com.codahale.metrics.health.HealthCheck

clock, execute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ThreadDeadlockHealthCheck

public ThreadDeadlockHealthCheck()

Creates a new health check.

ThreadDeadlockHealthCheck

public ThreadDeadlockHealthCheck(com.codahale.metrics.jvm.ThreadDeadlockDetector detector)

Creates a new health check with the given detector.

Parameters:

detector - a thread deadlock detector

Method Details

check

protected HealthCheck.Result check()
                            throws Exception

Description copied from class: HealthCheck

Perform a check of the application component.

Specified by:

check in class HealthCheck

Returns:

if the component is healthy, a healthy HealthCheck.Result; otherwise, an unhealthy HealthCheck.Result with a descriptive error message or exception

Throws:

Exception - if there is an unhandled error during the health check; this will result in a failed health check