com.kdgregory.logging.aws.internal

Class AbstractWriterStatistics

java.lang.Object

com.kdgregory.logging.aws.internal.AbstractWriterStatistics

Direct Known Subclasses:

CloudWatchWriterStatistics, KinesisWriterStatistics, SNSWriterStatistics

public abstract class AbstractWriterStatistics
extends Object

Base class for writer statistics, providing fields that are used by all writer implementations. Concrete appender implementations hold/expose a subclass.

Statistics are limited to primitives and strings so that they can be read by JMX. Statistics will be read and written by different threads, so must be marked as volatile. A given statistic will only be written by appender or writer, not both, so there's no need for synchronization unless there's the possibility of multiple writers. In that case, implement an override in the subclass and synchronize there.

Note: the MXBean interface implemented by subclasses must explicitly expose any desired getters (we can't use a superinterface because JMX introspection only looks at declared methods).

Constructor Summary

Constructors

Constructor and Description
AbstractWriterStatistics()

Method Summary

Modifier and Type	Method and Description
int	getLastBatchSize()
Throwable	getLastError()
String	getLastErrorMessage()
List<String>	getLastErrorStacktrace()
Date	getLastErrorTimestamp()
int	getMessagesDiscarded()
int	getMessagesRequeuedLastBatch()
int	getMessagesSent()
int	getMessagesSentLastBatch()
int	getOversizeMessages()
int	getThrottledWrites()
void	incrementOversizeMessages()
void	incrementThrottledWrites()
void	setLastBatchSize(int count)
void	setLastError(String message, Throwable error) Sets the last error.
void	setMessageQueue(MessageQueue messageQueue) Stores the current writer's message queue.
void	setMessagesRequeuedLastBatch(int count)
void	setMessagesSentLastBatch(int count)
void	updateMessagesSent(int count) Updates the number of messages sent with the given count.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWriterStatistics

public AbstractWriterStatistics()

Method Detail

setMessageQueue

public void setMessageQueue(MessageQueue messageQueue)

Stores the current writer's message queue. This should be called during writer initialization.

setLastError

public void setLastError(String message,
                         Throwable error)

Sets the last error. Either the message or the throwable may be null (but not both).

Note: if multiple errors occur in rapid succession, the observer may see a mixture of reported values. This is unlikely to occur outside of testing, and the cure is to syncronize this method with the various gets, which I don't particularly want to do.

getLastError

public Throwable getLastError()

getLastErrorMessage

public String getLastErrorMessage()

getLastErrorTimestamp

public Date getLastErrorTimestamp()

getLastErrorStacktrace

public List<String> getLastErrorStacktrace()

incrementOversizeMessages

public void incrementOversizeMessages()

getOversizeMessages

public int getOversizeMessages()

updateMessagesSent

public void updateMessagesSent(int count)

Updates the number of messages sent with the given count. This should only be called after all failures have been identified.

getMessagesSent

public int getMessagesSent()

setLastBatchSize

public void setLastBatchSize(int count)

getLastBatchSize

public int getLastBatchSize()

setMessagesSentLastBatch

public void setMessagesSentLastBatch(int count)

getMessagesSentLastBatch

public int getMessagesSentLastBatch()

setMessagesRequeuedLastBatch

public void setMessagesRequeuedLastBatch(int count)

getMessagesRequeuedLastBatch

public int getMessagesRequeuedLastBatch()

getMessagesDiscarded

public int getMessagesDiscarded()

getThrottledWrites

public int getThrottledWrites()

incrementThrottledWrites

public void incrementThrottledWrites()