com.neeve.service

Class MessageProcessingStatsCollector

java.lang.Object

com.neeve.service.MessageProcessingStatsCollector

public final class MessageProcessingStatsCollector
extends Object

The Eagle message processing stats collector

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MessageProcessingStatsCollector.TypeStats Contains message type specific stats

Constructor Summary

Constructors

Constructor and Description
MessageProcessingStatsCollector(Boolean loggingEnabled, String loggingLocation, IdentityInformationProvider identityProvider, Integer traceInterval, IMessageProcessingStatsTracer tracer) Constructor

Method Summary

Modifier and Type	Method and Description
void	close() Close the stats collector
MessageProcessingStatsCollector	enableLogging(boolean val) Enable/disable logging
String	getLogName() Get the name of the underlying log
List<Class<?>>	getTypes() Get list of message types for which stats exist
MessageProcessingStatsCollector.TypeStats	getTypeStats(Class<?> type) Get the object containing stats for a specific message type
boolean	isLoggingEnabled() Get if logging is enabled
void	log(MessageProcessingTime mpt) Log a message processing time element
void	open() Open the stats collector
void	reset() Reset a stats collector This method returns the stats collector to the state it was at the time the collector was created
void	scheduleLogCompactionOnNextWrite() Schedule a compaction on the underlying on the next write
void	setLogCompactionThreshold(int val) Set the compaction threshold on the underlying log
void	trace() Output stats to tracer

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageProcessingStatsCollector

@Inject
public MessageProcessingStatsCollector(Boolean loggingEnabled,
                                               String loggingLocation,
                                               IdentityInformationProvider identityProvider,
                                               Integer traceInterval,
                                               IMessageProcessingStatsTracer tracer)

Constructor

Method Detail

getLogName

public final String getLogName()

Get the name of the underlying log

open

public final void open()
                throws Exception

Open the stats collector

Throws:

Exception

enableLogging

public final MessageProcessingStatsCollector enableLogging(boolean val)

Enable/disable logging

Parameters:

val - Specifies whether to switch logging on of off.

This method enables/disables logging (journalling) of message processing times. The method can be called at any time during the life of a message processing stats collector object.

isLoggingEnabled

public final boolean isLoggingEnabled()

Get if logging is enabled

setLogCompactionThreshold

public final void setLogCompactionThreshold(int val)
                                     throws Exception

Set the compaction threshold on the underlying log

Parameters:

val - The compaction threshold to set in gigabytes. A value of 0 will switch off compaction

Throws:

Exception

scheduleLogCompactionOnNextWrite

public final void scheduleLogCompactionOnNextWrite()
                                            throws Exception

Schedule a compaction on the underlying on the next write

Throws:

Exception

log

public final void log(MessageProcessingTime mpt)

Log a message processing time element

getTypes

public final List<Class<?>> getTypes()

Get list of message types for which stats exist

getTypeStats

public final MessageProcessingStatsCollector.TypeStats getTypeStats(Class<?> type)

Get the object containing stats for a specific message type

reset

public final void reset()

Reset a stats collector

This method returns the stats collector to the state it was at the time the collector was created

trace

public final void trace()

Output stats to tracer

close

public final void close()

Close the stats collector