com.kdgregory.logging.aws.kinesis

Class KinesisLogWriter

java.lang.Object

com.kdgregory.logging.aws.internal.AbstractLogWriter<KinesisWriterConfig,KinesisWriterStatistics>

com.kdgregory.logging.aws.kinesis.KinesisLogWriter

All Implemented Interfaces:

LogWriter, Runnable

public class KinesisLogWriter
extends AbstractLogWriter<KinesisWriterConfig,KinesisWriterStatistics>

Writes log messages to a Kinesis stream. Optionally creates the stream at startup, but will fail if the stream is deleted during operation.

Implementation note: protected instance variables are replaced by tests.

Field Summary

Fields

Modifier and Type	Field and Description
protected RetryManager2	createRetry
protected RetryManager2	describeRetry
protected RetryManager2	postCreateRetry
static String	RANDOM_PARTITION_KEY_CONFIG This string is used in configuration to specify random partition keys.
protected RetryManager2	sendRetry
protected Duration	sendTimeout

Fields inherited from class com.kdgregory.logging.aws.internal.AbstractLogWriter

config, logger, stats

Constructor Summary

Constructors

Constructor and Description
KinesisLogWriter(KinesisWriterConfig config, KinesisWriterStatistics stats, InternalLogger logger, KinesisFacade facade)

Method Summary

Modifier and Type	Method and Description
protected int	effectiveSize(LogMessage message) Calculates the effective size of the message.
protected boolean	ensureDestinationAvailable() Verifies that the logging destination is available (which may involve creating it).
int	maxMessageSize() Returns the maximum allowed UTF-8 message size for the destination.
protected List<LogMessage>	sendBatch(List<LogMessage> currentBatch) Sends a batch of messages.
protected void	stopAWSClient() This is called when the logwriter is stopped, to explicitly close the AWS service client.
protected boolean	withinServiceLimits(int batchBytes, int numMessages) Determines whether the provided batch size or number of messages would exceed the service's limits.

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

addMessage, buildBatch, getBatchCount, getBatchDelay, initialize, isRunning, isSynchronous, keepRunning, processBatch, reportError, run, setBatchDelay, setDiscardAction, setDiscardThreshold, stop, waitUntilInitialized, waitUntilStopped

Methods inherited from class java.lang.Object

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

Field Detail

RANDOM_PARTITION_KEY_CONFIG

public static final String RANDOM_PARTITION_KEY_CONFIG

This string is used in configuration to specify random partition keys.

See Also:

Constant Field Values

describeRetry

protected RetryManager2 describeRetry

createRetry

protected RetryManager2 createRetry

postCreateRetry

protected RetryManager2 postCreateRetry

sendTimeout

protected Duration sendTimeout

sendRetry

protected RetryManager2 sendRetry

Constructor Detail

KinesisLogWriter

public KinesisLogWriter(KinesisWriterConfig config,
                        KinesisWriterStatistics stats,
                        InternalLogger logger,
                        KinesisFacade facade)

Method Detail

maxMessageSize

public int maxMessageSize()

Description copied from interface: LogWriter

Returns the maximum allowed UTF-8 message size for the destination.

ensureDestinationAvailable

protected boolean ensureDestinationAvailable()

Description copied from class: AbstractLogWriter

Verifies that the logging destination is available (which may involve creating it). Return true if successful, false if not (which will cause the appender to stop running).

Specified by:

ensureDestinationAvailable in class AbstractLogWriter<KinesisWriterConfig,KinesisWriterStatistics>

sendBatch

protected List<LogMessage> sendBatch(List<LogMessage> currentBatch)

Description copied from class: AbstractLogWriter

Sends a batch of messages. The subclass is responsible for returning any messages that weren't sent, in order, so that they can be requeued.

Specified by:

sendBatch in class AbstractLogWriter<KinesisWriterConfig,KinesisWriterStatistics>

effectiveSize

protected int effectiveSize(LogMessage message)

Description copied from class: AbstractLogWriter

Calculates the effective size of the message. This includes the message bytes plus any overhead. It is used to calculate the number of bytes the message will add to a batch.

Specified by:

effectiveSize in class AbstractLogWriter<KinesisWriterConfig,KinesisWriterStatistics>

withinServiceLimits

protected boolean withinServiceLimits(int batchBytes,
                                      int numMessages)

Description copied from class: AbstractLogWriter

Determines whether the provided batch size or number of messages would exceed the service's limits.

Specified by:

withinServiceLimits in class AbstractLogWriter<KinesisWriterConfig,KinesisWriterStatistics>

stopAWSClient

protected void stopAWSClient()

Description copied from class: AbstractLogWriter

This is called when the logwriter is stopped, to explicitly close the AWS service client. It must be implemented by the subclass because we don't know the actual type and there's no abstract super-interface.

Specified by:

stopAWSClient in class AbstractLogWriter<KinesisWriterConfig,KinesisWriterStatistics>