com.kdgregory.log4j.aws

Class CloudWatchAppender

java.lang.Object

org.apache.log4j.AppenderSkeleton

com.kdgregory.log4j.aws.internal.shared.AbstractAppender<CloudWatchWriterConfig,CloudWatchAppenderStatistics,CloudWatchAppenderStatisticsMXBean>

com.kdgregory.log4j.aws.CloudWatchAppender

All Implemented Interfaces:

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

public class CloudWatchAppender
extends AbstractAppender<CloudWatchWriterConfig,CloudWatchAppenderStatistics,CloudWatchAppenderStatisticsMXBean>

Appender that writes to a CloudWatch log 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
CloudWatchAppender() Base constructor: assigns default values to configuration properties.

Method Summary

Modifier and Type	Method and Description
protected CloudWatchWriterConfig	generateWriterConfig() Called just before a writer is created, so that the subclass can perform substitutions on the configuration.
String	getLogGroup() Returns the log group name; see setLogGroup(java.lang.String).
String	getLogStream() Returns the log stream name; see setLogStream(java.lang.String).
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	rotate() Rotates the log stream: flushes all outstanding messages to the current stream, and opens a new stream.
void	setLogGroup(String value) Sets the CloudWatch Log Group associated with this appender.
void	setLogStream(String value) Sets the CloudWatch Log Stream 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, 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

CloudWatchAppender

public CloudWatchAppender()

Base constructor: assigns default values to configuration properties.

Method Detail

setLogGroup

public void setLogGroup(String value)

Sets the CloudWatch Log Group associated with this appender.

You typically assign a single log group to an application, and then use multiple log streams for instances of that application.

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

getLogGroup

public String getLogGroup()

Returns the log group name; see setLogGroup(java.lang.String). Primarily used for testing.

setLogStream

public void setLogStream(String value)

Sets the CloudWatch Log Stream associated with this appender.

You typically create a separate log stream for each instance of the application.

Default value is {startTimestamp}, the JVM startup timestamp.

getLogStream

public String getLogStream()

Returns the log stream name; see setLogStream(java.lang.String). Primarily used for testing.

rotate

public void rotate()

Rotates the log stream: flushes all outstanding messages to the current stream, and opens a new stream. This is called internally, and exposed for testing.

Overrides:

rotate in class AbstractAppender<CloudWatchWriterConfig,CloudWatchAppenderStatistics,CloudWatchAppenderStatisticsMXBean>

generateWriterConfig

protected CloudWatchWriterConfig 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<CloudWatchWriterConfig,CloudWatchAppenderStatistics,CloudWatchAppenderStatisticsMXBean>

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<CloudWatchWriterConfig,CloudWatchAppenderStatistics,CloudWatchAppenderStatisticsMXBean>