CloudWatchWriterStatisticsMXBean (Log-Writers and Shared Components 3.1.2 API)

All Known Implementing Classes:

CloudWatchWriterStatistics
```
public interface CloudWatchWriterStatisticsMXBean
```
Defines the JMX Bean interface for CloudWatchWriterStatistics.

Method Summary

All Methods Instance Methods Abstract Methods
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`	`getLastBatchSize()` Returns the number of messages in the most recent batch.
`String`	`getLastErrorMessage()` Returns the most recent error from the writer.
`List<String>`	`getLastErrorStacktrace()` Returns the stack trace of the most recent error from the writer.
`Date`	`getLastErrorTimestamp()` Returns the timestamp of the most recent error from the writer.
`int`	`getMessagesDiscarded()` Returns the number of messages discarded by the current writer's message queue.
`int`	`getMessagesRequeuedLastBatch()` Returns the number of messages requeued because they could not be sent.
`int`	`getMessagesSent()` Returns the number of messages successfully sent to the logstream, by the current writer.
`int`	`getMessagesSentLastBatch()` Returns the number of messages successfully sent to the logstream in the last batch.
`int`	`getOversizeMessages()` Returns the number of messages that were either dropped or truncated because they were too large for the service to accept.
`int`	`getThrottledWrites()` Returns the number of batches that were retried due to throttling.
`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`.

- Method Detail
  - getActualLogGroupName
```
String getActualLogGroupName()
```
    Returns the actual log group name for the appender, after substitutions.
  - getActualLogStreamName
```
String getActualLogStreamName()
```
    Returns the actual log stream name for the appender, after substitutions.
  - getLastErrorMessage
```
String getLastErrorMessage()
```
    Returns the most recent error from the writer. This will be null if there have been no errors.
  - getLastErrorTimestamp
```
Date getLastErrorTimestamp()
```
    Returns the timestamp of the most recent error from the writer. This will be null if there have been no errors.
  - getLastErrorStacktrace
```
List<String> getLastErrorStacktrace()
```
    Returns the stack trace of the most recent error from the writer. This will be null if there have been no errors or if the error did not have an associated exception.
  - getThrottledWrites
```
int getThrottledWrites()
```
    Returns the number of batches that were retried due to throttling. If this is more than single digits, you should contact AWS to increase your quota.
  - getOversizeMessages
```
int getOversizeMessages()
```
    Returns the number of messages that were either dropped or truncated because they were too large for the service to accept.
  - getMessagesSent
```
int getMessagesSent()
```
    Returns the number of messages successfully sent to the logstream, by the current writer.
  - getLastBatchSize
```
int getLastBatchSize()
```
    Returns the number of messages in the most recent batch.
  - getMessagesSentLastBatch
```
int getMessagesSentLastBatch()
```
    Returns the number of messages successfully sent to the logstream in the last batch. This should be at least 1; higher values indicate how many messages will be lost if the program shuts down unexpectedly.
  - getMessagesRequeuedLastBatch
```
int getMessagesRequeuedLastBatch()
```
    Returns the number of messages requeued because they could not be sent. This should be 0; non-zero values indicate throttling or an error condition (see getLastErrorMessage() and getWriterRaceRetries() for more info).
  - getMessagesDiscarded
```
int getMessagesDiscarded()
```
    Returns the number of messages discarded by the current writer's message queue.
  - getWriterRaceRetries
```
int getWriterRaceRetries()
```
    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.
  - getUnrecoveredWriterRaceRetries
```
int getUnrecoveredWriterRaceRetries()
```
    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.

Interface CloudWatchWriterStatisticsMXBean

Method Summary

Method Detail

getActualLogGroupName

getActualLogStreamName

getLastErrorMessage

getLastErrorTimestamp

getLastErrorStacktrace

getThrottledWrites

getOversizeMessages

getMessagesSent

getLastBatchSize

getMessagesSentLastBatch

getMessagesRequeuedLastBatch

getMessagesDiscarded

getWriterRaceRetries

getUnrecoveredWriterRaceRetries