com.extrememessaging.ResponseMaster.monitor

Interface IMonitor

All Superinterfaces:

IConfigurableItem

All Known Implementing Classes:

CLogger, CLoggerMBean, CMonitorBase, CStatisticalMonitorBase, DBLogger, EmailMonitor, HistoricalCharts, MonitorLog4j, MonitorMBean, PrometheusMonitor

public interface IMonitor
extends IConfigurableItem

The interface you need to implement to create a custom monitoring class. Typically, you'll want to derive from CMonitorBase instead of implementing the interface directly.

Method Summary

Modifier and Type	Method and Description
void	CategoryDefinitionsLoaded() The category definition file finished loading New in build 595.
void	LogError(java.lang.String sMessage) Log an error
void	LogError(java.lang.String sMessage, java.lang.Throwable e) Log an error from a Throwable Changed to Throwable (from Exception) and overload with Error was removed in build 606
void	LogSystem(java.lang.String sMessage) Log a system message
void	LogTrace(java.lang.String sMessage) Log a tracing message If the logging level is Errors or Warnings, this doesn't do anything
void	LogTrace(java.lang.String sMessage, java.lang.Throwable e) Log a tracing message from a Throwable If the logging level is Errors or Warnings, this doesn't do anything Changed to Throwable (from Exception) in build 606
void	LogWarning(java.lang.String sMessage) Log a warning If the logging level is Errors, this doesn't do anything
void	LogWarning(java.lang.String sMessage, java.lang.Throwable e) Log a warning from a Throwable If the logging level is Errors, this doesn't do anything Changed to Throwable (from Exception) in build 606
void	MailboxEmpty(java.lang.String sMailboxName) This is fired every time we check the mailbox for messages, and we find that it is empty.
void	MailboxInitializationBegun(java.lang.String sMailboxName) The mailbox initialization process started for a particular mailbox New in build 627
void	MailboxInitializationFinished(java.lang.String sMailboxName) The mailbox initialization process completed for a particular mailbox New in build 627
void	MailboxShutdownBegun(java.lang.String sMailboxName) The mailbox shutdown process began for a particular mailbox New in build 627
void	MailboxShutdownFinished(java.lang.String sMailboxName) The mailbox shutdown process finished for a particular mailbox New in build 627
void	MessageCategorized(java.lang.String sMailboxName, int CategoryID) A message was categorized into a particular category.
void	MessageCount(java.lang.String sMailboxName, int nMessageCount) We just refreshed the mailbox and this is the message count New in 811
void	MessageFetched(java.lang.String sMailboxName, int nMessageNumber, long nFetchTimeNs) We just fetched a message from the mail server.
void	MessageProcessed(java.lang.String sMailboxName, CMessage oMessage, long nProcessingTimeNs) A message was processed Changed in build 595 MailboxName added in 811.
void	MessageSkipped(java.lang.String sMailboxName) A message was deleted without processing because the headers could not be loaded.
void	SkippedRemovedMessage(java.lang.String sMailboxName) We tried to process a message, but it was removed from the mailbox or marked as deleted.
void	ThreadKilled(java.lang.String sMailboxName, int nThreadNumber, java.util.Date dtLastUpdate) A thread was killed because it was inactive for too long New in build 595 MailboxName added in 811.

Methods inherited from interface com.extrememessaging.ResponseMaster.IConfigurableItem

Initialize, Shutdown

Method Detail

LogError

void LogError(java.lang.String sMessage)

Log an error

Parameters:

sMessage - The message to log

LogError

void LogError(java.lang.String sMessage,
              java.lang.Throwable e)

Log an error from a Throwable Changed to Throwable (from Exception) and overload with Error was removed in build 606

Parameters:

sMessage - The message to log

e - The Throwable to log

LogWarning

void LogWarning(java.lang.String sMessage)

Log a warning If the logging level is Errors, this doesn't do anything

Parameters:

sMessage - The message to log

LogWarning

void LogWarning(java.lang.String sMessage,
                java.lang.Throwable e)

Log a warning from a Throwable If the logging level is Errors, this doesn't do anything Changed to Throwable (from Exception) in build 606

Parameters:

sMessage - The message to log

e - The Throwable to log

LogTrace

void LogTrace(java.lang.String sMessage)

Log a tracing message If the logging level is Errors or Warnings, this doesn't do anything

Parameters:

sMessage - The message to log

LogTrace

void LogTrace(java.lang.String sMessage,
              java.lang.Throwable e)

Log a tracing message from a Throwable If the logging level is Errors or Warnings, this doesn't do anything Changed to Throwable (from Exception) in build 606

Parameters:

sMessage - The message to log

e - The Throwable to log

LogSystem

void LogSystem(java.lang.String sMessage)

Log a system message

Parameters:

sMessage - The message to log

MessageProcessed

void MessageProcessed(java.lang.String sMailboxName,
                      CMessage oMessage,
                      long nProcessingTimeNs)

A message was processed Changed in build 595 MailboxName added in 811. TotalTime added in 832.

Parameters:

sMailboxName - The name of the mailbox that the message was from

oMessage - The message that was processed.

nProcessingTimeNs - The total time taken to process the message in nanoseconds (includes fetch time)

MessageCategorized

void MessageCategorized(java.lang.String sMailboxName,
                        int CategoryID)

A message was categorized into a particular category. New in build 595. MailboxName added in 811.

Parameters:

sMailboxName - The name of the mailbox that the message was from

CategoryID - The category that the message was placed into

CategoryDefinitionsLoaded

void CategoryDefinitionsLoaded()

The category definition file finished loading New in build 595.

ThreadKilled

void ThreadKilled(java.lang.String sMailboxName,
                  int nThreadNumber,
                  java.util.Date dtLastUpdate)

A thread was killed because it was inactive for too long New in build 595 MailboxName added in 811.

Parameters:

sMailboxName - The name of the mailbox that the thread was processing

nThreadNumber - The number of the thread that was killed

dtLastUpdate - The last time the thread did something.

MessageSkipped

void MessageSkipped(java.lang.String sMailboxName)

A message was deleted without processing because the headers could not be loaded. New in build 595 MailboxName added in 811.

Parameters:

sMailboxName - The name of the mailbox that the message was from

MailboxInitializationBegun

void MailboxInitializationBegun(java.lang.String sMailboxName)

The mailbox initialization process started for a particular mailbox New in build 627

Parameters:

sMailboxName - The name of the mailbox

MailboxInitializationFinished

void MailboxInitializationFinished(java.lang.String sMailboxName)

The mailbox initialization process completed for a particular mailbox New in build 627

Parameters:

sMailboxName - The name of the mailbox

MailboxShutdownBegun

void MailboxShutdownBegun(java.lang.String sMailboxName)

The mailbox shutdown process began for a particular mailbox New in build 627

Parameters:

sMailboxName - The name of the mailbox

MailboxShutdownFinished

void MailboxShutdownFinished(java.lang.String sMailboxName)

The mailbox shutdown process finished for a particular mailbox New in build 627

Parameters:

sMailboxName - The name of the mailbox

MailboxEmpty

void MailboxEmpty(java.lang.String sMailboxName)

This is fired every time we check the mailbox for messages, and we find that it is empty. Note: It can fire multiple times without the mailbox getting messages in between. New in build 627

Parameters:

sMailboxName - The name of the mailbox

MessageCount

void MessageCount(java.lang.String sMailboxName,
                  int nMessageCount)

We just refreshed the mailbox and this is the message count New in 811

Parameters:

sMailboxName - The name of the mailbox

nMessageCount - The number of messages in the mailbox

MessageFetched

void MessageFetched(java.lang.String sMailboxName,
                    int nMessageNumber,
                    long nFetchTimeNs)

We just fetched a message from the mail server. Note: For different protocols, very different amounts of work are performed in this step. New in build 832

Parameters:

sMailboxName - The name of the mailbox the message was fetched from.

nMessageNumber - The number of the message (as in "Getting message #12345..."), primarily used for reporting.

nFetchTimeNs - The time taken to fetch the message in nanoseconds.

SkippedRemovedMessage

void SkippedRemovedMessage(java.lang.String sMailboxName)

We tried to process a message, but it was removed from the mailbox or marked as deleted. New in build 833

Parameters:

sMailboxName - The name of the mailbox the message was from.