sirius.kernel.health

Class MemoryBasedHealthMonitor

java.lang.Object

sirius.kernel.health.MemoryBasedHealthMonitor

All Implemented Interfaces:

ExceptionHandler, LogTap

public class MemoryBasedHealthMonitor
extends Object
implements ExceptionHandler, LogTap

Provides a in-memory store for logs and exceptions.

This will be inherently limited in size but should always contain the most recent logs and errors.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Incident>	incidents
protected List<LogMessage>	messages

Constructor Summary

Constructors

Constructor and Description
MemoryBasedHealthMonitor()

Method Summary

Modifier and Type	Method and Description
List<Incident>	getIncidents() Contains all recorded incidents.
List<LogMessage>	getMessages() Contains all recorded log messages.
long	getNumIncidents() Returns the total number of incidents (exceptions) encountered.
long	getNumLogMessages() Returns the total number of log messages encountered.
long	getNumUniqueIncidents() Returns the total number of unique incidents (with different locations) encountered.
void	handle(Incident incident) Invoked to handle the given exception.
void	handleLogMessage(LogMessage msg) Invoked once a log message is received.

Methods inherited from class java.lang.Object

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

Field Detail

incidents

protected final List<Incident> incidents

messages

protected final List<LogMessage> messages

Constructor Detail

MemoryBasedHealthMonitor

public MemoryBasedHealthMonitor()

Method Detail

handle

public void handle(Incident incident)
            throws Exception

Description copied from interface: ExceptionHandler

Invoked to handle the given exception.

Can be used to get notified about any exception which occurs in the system.

Specified by:

handle in interface ExceptionHandler

Parameters:

incident - contains the error description to be processed.

Throws:

Exception - as this method is already called from within the exception handling system, errors in here should not be sent there again, but simply be thrown by this method

See Also:

CallContext.getMDC(), Exceptions.handle()

handleLogMessage

public void handleLogMessage(LogMessage msg)

Description copied from interface: LogTap

Invoked once a log message is received.

Specified by:

handleLogMessage in interface LogTap

Parameters:

msg - the message to log

getIncidents

public List<Incident> getIncidents()

Contains all recorded incidents.

Returns:

all recorded incidents

getMessages

public List<LogMessage> getMessages()

Contains all recorded log messages.

Returns:

all recorded messages

getNumLogMessages

public long getNumLogMessages()

Returns the total number of log messages encountered.

Returns:

the total number of log messages so far.

getNumIncidents

public long getNumIncidents()

Returns the total number of incidents (exceptions) encountered.

Returns:

the total number of incidents so far.

getNumUniqueIncidents

public long getNumUniqueIncidents()

Returns the total number of unique incidents (with different locations) encountered.

Returns:

the total number of unique incidents so far.