com.kdgregory.log4j.aws

Class KinesisAppender

java.lang.Object

org.apache.log4j.AppenderSkeleton

com.kdgregory.log4j.aws.internal.shared.AbstractAppender<KinesisWriterConfig,KinesisAppenderStatistics,KinesisAppenderStatisticsMXBean>

com.kdgregory.log4j.aws.KinesisAppender

All Implemented Interfaces:

org.apache.log4j.Appender, org.apache.log4j.spi.OptionHandler

public class KinesisAppender
extends AbstractAppender<KinesisWriterConfig,KinesisAppenderStatistics,KinesisAppenderStatisticsMXBean>

Appender that writes to a Kinesis stream.

Field Summary

Fields inherited from class com.kdgregory.log4j.aws.internal.shared.AbstractAppender

appenderStats, batchDelay, clientEndpoint, clientFactory, discardAction, discardThreshold, lastRotationCount, lastRotationTimestamp, rotationInterval, rotationMode, sequence, threadFactory, writer, writerFactory

Fields inherited from class org.apache.log4j.AppenderSkeleton

errorHandler, headFilter, layout, name, tailFilter, threshold

Constructor Summary

Constructors

Constructor and Description
KinesisAppender() Base constructor: assigns default values to configuration properties.

Method Summary

Modifier and Type	Method and Description
protected KinesisWriterConfig	generateWriterConfig() Called just before a writer is created, so that the subclass can perform substitutions on the configuration.
String	getPartitionKey() Returns the unsubstituted partition key name; see setPartitionKey(java.lang.String).
int	getRetentionPeriod() Returns the configured retention period.
int	getShardCount() Returns the configured number of shards for the stream.
String	getStreamName() Returns the unsubstituted stream name; see setStreamName(java.lang.String).
boolean	isAutoCreate() Returns the auto-creation policy.
protected boolean	isMessageTooLarge(LogMessage message) Called AbstractAppender.append(org.apache.log4j.spi.LoggingEvent) to ensure that we don't have a single message that violates AWS batching rules.
void	setAutoCreate(boolean autoCreate) Sets the auto-creation policy: if true, the stream will be created if it does not already exist.
void	setPartitionKey(String value) Sets the partition key associated with this appender.
void	setRetentionPeriod(int value) Sets the message retention period, in hours.
void	setShardCount(int shardCount) Sets the desired number of shards to use when creating the stream.
void	setStreamName(String value) Sets the Kinesis Stream name associated with this appender.

Methods inherited from class com.kdgregory.log4j.aws.internal.shared.AbstractAppender

append, close, getAppenderStatistics, getBatchDelay, getClientEndpoint, getClientFactory, getDiscardAction, getDiscardThreshold, getRotationInterval, getRotationMode, getSequence, registerStatisticsBean, requiresLayout, rotate, setBatchDelay, setClientEndpoint, setClientFactory, setDiscardAction, setDiscardThreshold, setRotationInterval, setRotationMode, setSequence, unregisterStatisticsBean

Methods inherited from class org.apache.log4j.AppenderSkeleton

activateOptions, addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold

Methods inherited from class java.lang.Object

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

Constructor Detail

KinesisAppender

public KinesisAppender()

Base constructor: assigns default values to configuration properties.

Method Detail

setStreamName

public void setStreamName(String value)

Sets the Kinesis Stream name associated with this appender.

This property is intended for initial configuration only. Once messages have been sent to the appender, it cannot be changed.

There is no default value. If you do not configure a stream, the appender will be disabled and will report its misconfiguration.

getStreamName

public String getStreamName()

Returns the unsubstituted stream name; see setStreamName(java.lang.String). Intended primarily for testing.

setPartitionKey

public void setPartitionKey(String value)

Sets the partition key associated with this appender. This key is used to assign messages to shards: all messages with the same partition key will be sent to the same shard.

Default value is "{startupTimestamp}".

Setting this value to blank will result in generating a pseudo-random 8-digit partition key for each message.

This property is intended for initial configuration only. Once messages have been sent to the appender, it cannot be changed.

getPartitionKey

public String getPartitionKey()

Returns the unsubstituted partition key name; see setPartitionKey(java.lang.String). Intended primarily for testing.

setAutoCreate

public void setAutoCreate(boolean autoCreate)

Sets the auto-creation policy: if true, the stream will be created if it does not already exist.

isAutoCreate

public boolean isAutoCreate()

Returns the auto-creation policy.

setShardCount

public void setShardCount(int shardCount)

Sets the desired number of shards to use when creating the stream. This setting has no effect if the stream already exists.

getShardCount

public int getShardCount()

Returns the configured number of shards for the stream. This may not correspond to the actual shards in the stream.

setRetentionPeriod

public void setRetentionPeriod(int value)

Sets the message retention period, in hours. Only applied when creating a new stream. Per AWS, minimum value is 24, maximum value is 168. Note that non-default retention periods increase your stream cost.

getRetentionPeriod

public int getRetentionPeriod()

Returns the configured retention period. Note that this may not correspond to the actual retention period of the stream.

generateWriterConfig

protected KinesisWriterConfig generateWriterConfig()

Description copied from class: AbstractAppender

Called just before a writer is created, so that the subclass can perform substitutions on the configuration.

Specified by:

generateWriterConfig in class AbstractAppender<KinesisWriterConfig,KinesisAppenderStatistics,KinesisAppenderStatisticsMXBean>

isMessageTooLarge

protected boolean isMessageTooLarge(LogMessage message)

Description copied from class: AbstractAppender

Called AbstractAppender.append(org.apache.log4j.spi.LoggingEvent) to ensure that we don't have a single message that violates AWS batching rules.

Specified by:

isMessageTooLarge in class AbstractAppender<KinesisWriterConfig,KinesisAppenderStatistics,KinesisAppenderStatisticsMXBean>