com.caucho.health.action

Class Snapshot

java.lang.Object

com.caucho.health.action.AbstractHealthAction

com.caucho.health.action.ActionSequence

com.caucho.health.action.Snapshot

All Implemented Interfaces:

HealthAction

@Singleton
 @Configurable
public class Snapshot
extends ActionSequence

A specific sequence of health actions: thread dump, heap dump, jmx dump, and pdf report. This is intended to generate a permanent representation, or "snapshot" of the system at a point in time that includes all the information necessary to debug server issues. It is usually intended to run in response to a unexpected issue.

 <health:Snapshot>
   <health:OnAbnormalStop/>
 </health:Snapshot 
 

Nested Class Summary

Nested classes/interfaces inherited from class com.caucho.health.action.ActionSequence

ActionSequence.IfExecuting

Field Summary

Fields inherited from class com.caucho.health.action.ActionSequence

_actionList

Constructor Summary

Constructors

Constructor and Description
Snapshot()

Method Summary

Modifier and Type	Method and Description
void	init()
void	setHeapDump(boolean isEnable) Enable a heap dump for the snapshot.
void	setJmxDump(boolean isEnable) Enable a jmx dump for the snapshot.
void	setLog(boolean isLog) Output to server log in addition to internal database (default false).
void	setLogDirectory(java.lang.String logDirectory) PDF output directory (defaults to resin log directory)
void	setPath(java.lang.String path) path to a PDF generating .php file (defaults to ${resin.home}/doc/admin/pdf-gen.php)
void	setPdfReport(boolean isEnable) Enable a pdf report for the snapshot.
void	setPeriod(Period period) specifies look back period of time.
void	setReport(java.lang.String report) report type key (default Summary)
void	setThreadDump(boolean isEnable) Enable a thread dump for the snapshot.
void	setThreadScoreboard(boolean isEnable) Enable a scoreboard report for the snapshot.

Methods inherited from class com.caucho.health.action.ActionSequence

add, doActionImpl

Methods inherited from class com.caucho.health.action.AbstractHealthAction

add, addListener, doAction, getPredicates, start, stop, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Snapshot

public Snapshot()

Method Detail

setThreadDump

@Configurable
public void setThreadDump(boolean isEnable)

Enable a thread dump for the snapshot.

setHeapDump

public void setHeapDump(boolean isEnable)

Enable a heap dump for the snapshot.

setJmxDump

public void setJmxDump(boolean isEnable)

Enable a jmx dump for the snapshot.

setPdfReport

public void setPdfReport(boolean isEnable)

Enable a pdf report for the snapshot.

setThreadScoreboard

public void setThreadScoreboard(boolean isEnable)

Enable a scoreboard report for the snapshot.

init

@PostConstruct
public void init()

Overrides:

init in class ActionSequence

setLog

public void setLog(boolean isLog)

Output to server log in addition to internal database (default false).

setPath

@Configurable
public void setPath(java.lang.String path)

path to a PDF generating .php file (defaults to ${resin.home}/doc/admin/pdf-gen.php)

setReport

@Configurable
public void setReport(java.lang.String report)

report type key (default Summary)

setPeriod

@Configurable
public void setPeriod(Period period)

specifies look back period of time. e.g. '-period 1D' create the report since the same time yesterday (default 7D)

setLogDirectory

@Configurable
public void setLogDirectory(java.lang.String logDirectory)

PDF output directory (defaults to resin log directory)

Parameters:

logDirectory -