com.kdgregory.logging.aws.cloudwatch

Class CloudWatchWriterStatistics

java.lang.Object

com.kdgregory.logging.aws.internal.AbstractWriterStatistics

com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatistics

All Implemented Interfaces:

CloudWatchWriterStatisticsMXBean

public class CloudWatchWriterStatistics
extends AbstractWriterStatistics
implements CloudWatchWriterStatisticsMXBean

Statistics specific to CloudWatchLogWriter.

Constructor Summary

Constructors

Constructor and Description
CloudWatchWriterStatistics()

Method Summary

Modifier and Type	Method and Description
String	getActualLogGroupName() Returns the actual log group name for the appender, after substitutions.
String	getActualLogStreamName() Returns the actual log stream name for the appender, after substitutions.
int	getMessagesDiscarded() Returns the number of messages discarded by the current writer's message queue.
int	getUnrecoveredWriterRaceRetries() Returns the times that the writer had to requeue a batch after receiving and repeated InvalidSequenceTokenException errors.
int	getWriterRaceRetries() Returns the number of retries due to InvalidSequenceTokenException response from PutLogEvents.
void	setActualLogGroupName(String actualLogGroupName)
void	setActualLogStreamName(String actualLogStreamName)
void	updateUnrecoveredWriterRaceRetries()
void	updateWriterRaceRetries()

Methods inherited from class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

getLastBatchSize, getLastError, getLastErrorMessage, getLastErrorStacktrace, getLastErrorTimestamp, getMessagesRequeuedLastBatch, getMessagesSent, getMessagesSentLastBatch, getOversizeMessages, getThrottledWrites, incrementOversizeMessages, incrementThrottledWrites, setLastBatchSize, setLastError, setMessageQueue, setMessagesRequeuedLastBatch, setMessagesSentLastBatch, updateMessagesSent

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatisticsMXBean

getLastBatchSize, getLastErrorMessage, getLastErrorStacktrace, getLastErrorTimestamp, getMessagesRequeuedLastBatch, getMessagesSent, getMessagesSentLastBatch, getOversizeMessages, getThrottledWrites

Constructor Detail

CloudWatchWriterStatistics

public CloudWatchWriterStatistics()

Method Detail

getActualLogGroupName

public String getActualLogGroupName()

Description copied from interface: CloudWatchWriterStatisticsMXBean

Returns the actual log group name for the appender, after substitutions.

Specified by:

getActualLogGroupName in interface CloudWatchWriterStatisticsMXBean

setActualLogGroupName

public void setActualLogGroupName(String actualLogGroupName)

getActualLogStreamName

public String getActualLogStreamName()

Description copied from interface: CloudWatchWriterStatisticsMXBean

Returns the actual log stream name for the appender, after substitutions.

Specified by:

getActualLogStreamName in interface CloudWatchWriterStatisticsMXBean

setActualLogStreamName

public void setActualLogStreamName(String actualLogStreamName)

getMessagesDiscarded

public int getMessagesDiscarded()

Description copied from interface: CloudWatchWriterStatisticsMXBean

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

Specified by:

getMessagesDiscarded in interface CloudWatchWriterStatisticsMXBean

Overrides:

getMessagesDiscarded in class AbstractWriterStatistics

getWriterRaceRetries

public int getWriterRaceRetries()

Description copied from interface: CloudWatchWriterStatisticsMXBean

Returns the number of retries due to InvalidSequenceTokenException response from PutLogEvents. This exception will be thrown when there is a race between two writers: both get the same sequence token but only once can use it. This may happen when there are many instances that are started at the same time or have a low batch delay.

Specified by:

getWriterRaceRetries in interface CloudWatchWriterStatisticsMXBean

updateWriterRaceRetries

public void updateWriterRaceRetries()

getUnrecoveredWriterRaceRetries

public int getUnrecoveredWriterRaceRetries()

Description copied from interface: CloudWatchWriterStatisticsMXBean

Returns the times that the writer had to requeue a batch after receiving and repeated InvalidSequenceTokenException errors. This number should remain 0; if it is non-zero, and particularly if it is a noticeable percentage of WriterRaceRetries, it indicates that you have too many writers concurrently accessing the same stream. Either increase batch delay or (better) direct output to different streams.

Specified by:

getUnrecoveredWriterRaceRetries in interface CloudWatchWriterStatisticsMXBean

updateUnrecoveredWriterRaceRetries

public void updateUnrecoveredWriterRaceRetries()