com.kdgregory.log4j.aws.internal.shared

Class AbstractAppenderStatistics

java.lang.Object

com.kdgregory.log4j.aws.internal.shared.AbstractAppenderStatistics

Direct Known Subclasses:

CloudWatchAppenderStatistics, KinesisAppenderStatistics, SNSAppenderStatistics

public abstract class AbstractAppenderStatistics
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
AbstractAppenderStatistics()

Method Summary

Modifier and Type	Method and Description
Throwable	getLastError()
String	getLastErrorMessage()
List<String>	getLastErrorStacktrace()
Date	getLastErrorTimestamp()
int	getMessagesDiscarded() Returns the number of messages discarded by the current writer's message queue.
int	getMessagesSent()
void	setLastError(String message, Throwable error) Sets the last error.
void	setMessageQueue(MessageQueue messageQueue) Stores the current writer's message queue.
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

AbstractAppenderStatistics

public AbstractAppenderStatistics()

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).

getLastError

public Throwable getLastError()

getLastErrorMessage

public String getLastErrorMessage()

getLastErrorTimestamp

public Date getLastErrorTimestamp()

getLastErrorStacktrace

public List<String> getLastErrorStacktrace()

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()

getMessagesDiscarded

public int getMessagesDiscarded()

Returns the number of messages discarded by the current writer's message queue.