org.qbroker.sonicmq

Class SonicMQMonitor

java.lang.Object

org.qbroker.monitor.Monitor

org.qbroker.sonicmq.SonicMQMonitor

All Implemented Interfaces:

MonitorAction, MonitorReport

public class SonicMQMonitor
extends Monitor

SonicMQMonitor monitors the message storage on a SonicMQ broker via JMS/JMX. Currently, it only supports broker, queues and durable subscriptions. Since there is no metric for deq and enq on destinations, it queries the metrics of connections associated with the specific destination. Unfortunately, SonicMQ management API does not provide a easy way to query all connections on a queue. So it is assumed that the consumer application of the queue is is running as a dedicated user only on certain well known hosts. Therefore, SonicMQMonitor is able to use the combinations of the user and the hostnames to associate non-topic connections with a specific queue.

HostPattern is a map contains Pattern expression to select hostnames for the consumer applications with a specific destination name. UserMappingRule is a list of maps with two items of Pattern and Substitution. On a given name of the destination, SonicMQMonitor loops through the list to apply patterns matching the name one by one until it finds a match. Then its substitution part is applied on the name to map the destination name to the username. One example is to cut off the ending "Queue" to convert a queue name to a user name.

In order for SonicMQMonitor to work, the metrics on connections, queues and brokers must be enabled. Please check the source code to figure out the list of the metrics.

Author:

yannanlu@yahoo.com

Field Summary

Fields inherited from class org.qbroker.monitor.Monitor

actionCount, actionGroup, aPatternGroup, cachedSkip, category, dependencyGroup, description, disabledWithReport, disableMode, exceptionCount, exceptionTolerance, FILE_SEPARATOR, formatText, keyList, maxPage, maxRetry, name, normalStep, pm, previousStatus, repeatPeriod, report, reportMode, reportName, resolution, serialNumber, site, skip, statsLogger, statusOffset, statusText, step, template, timeFormat, timeTemplate, tolerance, type, xPatternGroup

Fields inherited from interface org.qbroker.monitor.MonitorReport

DISABLED, EXCEPTION, NOSKIP, REPORT_CACHED, REPORT_CLUSTER, REPORT_FINAL, REPORT_FLOW, REPORT_LOCAL, REPORT_NODE, REPORT_NONE, REPORT_SHARED, SKIPPED

Constructor Summary

Constructors

Constructor and Description
SonicMQMonitor(java.util.Map props)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	checkpoint() returns the checkpoint Map for the action
void	destroy() closes and releases all opened resources
java.util.Map<java.lang.String,java.lang.Object>	generateReport(long currentTime) generates a report on a monitored entity and returns it as a Map.
static void	main(java.lang.String[] args)
Event	performAction(int status, long currentTime, java.util.Map<java.lang.String,java.lang.Object> latest) examines the report on the monitored entity and reacts to it as an action
void	restoreFromCheckpoint(java.util.Map<java.lang.String,java.lang.Object> chkpt) restores the state of the action from the checkpoint Map

Methods inherited from class org.qbroker.monitor.Monitor

finalize, getName, getReportKeys, getReportMode, getReportName, getSkippingStatus, initTimeTemplate, updateContent

Methods inherited from class java.lang.Object

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

Constructor Detail

SonicMQMonitor

public SonicMQMonitor(java.util.Map props)

Method Detail

generateReport

public java.util.Map<java.lang.String,java.lang.Object> generateReport(long currentTime)
                                                                throws javax.management.JMException

Description copied from interface: MonitorReport

generates a report on a monitored entity and returns it as a Map. The report Map will be passed to the associated MonitorAction as an opaque object. The action object is supposed to know how to retrieve the information from the report Map.

Specified by:

generateReport in interface MonitorReport

Specified by:

generateReport in class Monitor

Throws:

javax.management.JMException

performAction

public Event performAction(int status,
                           long currentTime,
                           java.util.Map<java.lang.String,java.lang.Object> latest)

Description copied from interface: MonitorAction

examines the report on the monitored entity and reacts to it as an action

Specified by:

performAction in interface MonitorAction

Specified by:

performAction in class Monitor

checkpoint

public java.util.Map<java.lang.String,java.lang.Object> checkpoint()

Description copied from interface: MonitorAction

returns the checkpoint Map for the action

Specified by:

checkpoint in interface MonitorAction

Overrides:

checkpoint in class Monitor

restoreFromCheckpoint

public void restoreFromCheckpoint(java.util.Map<java.lang.String,java.lang.Object> chkpt)

Description copied from interface: MonitorAction

restores the state of the action from the checkpoint Map

Specified by:

restoreFromCheckpoint in interface MonitorAction

Overrides:

restoreFromCheckpoint in class Monitor

destroy

public void destroy()

Description copied from interface: MonitorReport

closes and releases all opened resources

Specified by:

destroy in interface MonitorReport

Overrides:

destroy in class Monitor

main

public static void main(java.lang.String[] args)