Skip navigation links
A B C D E F G I J K L M N P Q R S T U V W 

A

AbstractAppender<WriterConfigType,AppenderStatsType extends AbstractAppenderStatistics,AppenderStatsMXBeanType> - Class in com.kdgregory.log4j.aws.internal.shared
Common implementation code that's shared between appenders.
AbstractAppender(ThreadFactory, WriterFactory<WriterConfigType, AppenderStatsType>, AppenderStatsType, Class<AppenderStatsMXBeanType>) - Constructor for class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
 
AbstractAppenderStatistics - Class in com.kdgregory.log4j.aws.internal.shared
Base class for writer statistics, providing fields that are used by all writer implementations.
AbstractAppenderStatistics() - Constructor for class com.kdgregory.log4j.aws.internal.shared.AbstractAppenderStatistics
 
AbstractLogWriter - Class in com.kdgregory.log4j.aws.internal.shared
Manages common LogWriter activities.
AbstractLogWriter(AbstractAppenderStatistics, long, int, MessageQueue.DiscardAction) - Constructor for class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter
 
activateOptions() - Method in class com.kdgregory.log4j.aws.JsonLayout
 
addAppender(String, AbstractAppenderStatistics, Class<?>) - Method in class com.kdgregory.log4j.aws.internal.shared.JMXManager
Adds an appender's statsbean and its class to the internal tracking tables.
addMessage(LogMessage) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter
 
addMessage(LogMessage) - Method in interface com.kdgregory.log4j.aws.internal.shared.LogWriter
Adds a message to the writer waiting for batch.
addStatisticsMBean(StatisticsMBean, MBeanServer, ObjectName) - Method in class com.kdgregory.log4j.aws.internal.shared.JMXManager
Adds relationship between a StatisticsMBean and an MBeanServer to the internal tables.
ALLOWED_GROUP_NAME_REGEX - Static variable in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchConstants
Used to validate log stream names.
ALLOWED_PARITION_KEY_REGEX - Static variable in class com.kdgregory.log4j.aws.internal.kinesis.KinesisConstants
Allowed characters for partition key.
ALLOWED_STREAM_NAME_REGEX - Static variable in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchConstants
Used to validate log group names.
ALLOWED_STREAM_NAME_REGEX - Static variable in class com.kdgregory.log4j.aws.internal.kinesis.KinesisConstants
Allowed characters for stream name.
append(LoggingEvent) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
 
appenderStats - Variable in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
 
appenderStatsBeans - Variable in class com.kdgregory.log4j.aws.internal.shared.JMXManager
 
appenderStatsBeanTypes - Variable in class com.kdgregory.log4j.aws.internal.shared.JMXManager
 
autoCreate - Variable in class com.kdgregory.log4j.aws.internal.kinesis.KinesisWriterConfig
 
autoCreate - Variable in class com.kdgregory.log4j.aws.internal.sns.SNSWriterConfig
 

B

batchDelay - Variable in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchWriterConfig
 
batchDelay - Variable in class com.kdgregory.log4j.aws.internal.kinesis.KinesisWriterConfig
 
batchDelay - Variable in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
 
buildBatch() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter
Attempts to read a list of messages from the queue.

C

client - Variable in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchLogWriter
 
client - Variable in class com.kdgregory.log4j.aws.internal.kinesis.KinesisLogWriter
 
client - Variable in class com.kdgregory.log4j.aws.internal.sns.SNSLogWriter
 
clientEndpoint - Variable in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchWriterConfig
 
clientEndpoint - Variable in class com.kdgregory.log4j.aws.internal.kinesis.KinesisWriterConfig
 
clientEndpoint - Variable in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
 
clientEndpoint - Variable in class com.kdgregory.log4j.aws.internal.sns.SNSWriterConfig
 
clientFactory - Variable in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
 
clientFactoryMethod - Variable in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchWriterConfig
 
clientFactoryMethod - Variable in class com.kdgregory.log4j.aws.internal.kinesis.KinesisWriterConfig
 
clientFactoryMethod - Variable in class com.kdgregory.log4j.aws.internal.sns.SNSWriterConfig
 
close() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
 
CloudWatchAppender - Class in com.kdgregory.log4j.aws
Appender that writes to a CloudWatch log stream.
CloudWatchAppender() - Constructor for class com.kdgregory.log4j.aws.CloudWatchAppender
Base constructor: assigns default values to configuration properties.
CloudWatchAppenderStatistics - Class in com.kdgregory.log4j.aws.internal.cloudwatch
Statistics specific to the CloudWatch appender.
CloudWatchAppenderStatistics() - Constructor for class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchAppenderStatistics
 
CloudWatchAppenderStatisticsMXBean - Interface in com.kdgregory.log4j.aws.internal.cloudwatch
Defines the JMX Bean interface for CloudWatchAppenderStatistics.
CloudWatchConstants - Class in com.kdgregory.log4j.aws.internal.cloudwatch
Holds limits and other constants for CloudWatch Logs.
CloudWatchConstants() - Constructor for class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchConstants
 
CloudWatchLogWriter - Class in com.kdgregory.log4j.aws.internal.cloudwatch
 
CloudWatchLogWriter(CloudWatchWriterConfig, CloudWatchAppenderStatistics) - Constructor for class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchLogWriter
 
CloudWatchWriterConfig - Class in com.kdgregory.log4j.aws.internal.cloudwatch
Holds configuration that is passed to the writer factory.
CloudWatchWriterConfig(String, String, long, int, MessageQueue.DiscardAction, String, String) - Constructor for class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchWriterConfig
 
CloudWatchWriterFactory - Class in com.kdgregory.log4j.aws.internal.cloudwatch
Factory to create CloudWatchLogWriter instances.
CloudWatchWriterFactory() - Constructor for class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchWriterFactory
 
com.kdgregory.log4j.aws - package com.kdgregory.log4j.aws
 
com.kdgregory.log4j.aws.internal.cloudwatch - package com.kdgregory.log4j.aws.internal.cloudwatch
 
com.kdgregory.log4j.aws.internal.kinesis - package com.kdgregory.log4j.aws.internal.kinesis
 
com.kdgregory.log4j.aws.internal.shared - package com.kdgregory.log4j.aws.internal.shared
 
com.kdgregory.log4j.aws.internal.sns - package com.kdgregory.log4j.aws.internal.sns
 
compareTo(LogMessage) - Method in class com.kdgregory.log4j.aws.internal.shared.LogMessage
Compares instances based on their timestamp.
config - Variable in class com.kdgregory.log4j.aws.internal.sns.SNSLogWriter
 
convert(Map<String, Object>) - Method in class com.kdgregory.log4j.aws.internal.shared.JsonConverter
 
createAWSClient() - Method in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchLogWriter
 
createAWSClient() - Method in class com.kdgregory.log4j.aws.internal.kinesis.KinesisLogWriter
 
createAWSClient() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter
Creates the appropriate AWS client.
createAWSClient() - Method in class com.kdgregory.log4j.aws.internal.sns.SNSLogWriter
 

D

DefaultThreadFactory - Class in com.kdgregory.log4j.aws.internal.shared
The default ThreadFactory for most appenders: creates a normal-priority thread and starts it running with the specified writer.
DefaultThreadFactory() - Constructor for class com.kdgregory.log4j.aws.internal.shared.DefaultThreadFactory
 
dequeue() - Method in class com.kdgregory.log4j.aws.internal.shared.MessageQueue
Removes a message from the front of the queue.
dequeue(long) - Method in class com.kdgregory.log4j.aws.internal.shared.MessageQueue
Removes a message from the front of the queue, waiting for a specified number of milliseconds if the queue is empty.
discardAction - Variable in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchWriterConfig
 
discardAction - Variable in class com.kdgregory.log4j.aws.internal.kinesis.KinesisWriterConfig
 
discardAction - Variable in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
 
discardAction - Variable in class com.kdgregory.log4j.aws.internal.sns.SNSWriterConfig
 
discardThreshold - Variable in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchWriterConfig
 
discardThreshold - Variable in class com.kdgregory.log4j.aws.internal.kinesis.KinesisWriterConfig
 
discardThreshold - Variable in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
 
discardThreshold - Variable in class com.kdgregory.log4j.aws.internal.sns.SNSWriterConfig
 

E

effectiveSize(LogMessage) - Method in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchLogWriter
 
effectiveSize(LogMessage) - Method in class com.kdgregory.log4j.aws.internal.kinesis.KinesisLogWriter
 
effectiveSize(LogMessage) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter
Calculates the effective size of the message.
effectiveSize(LogMessage) - Method in class com.kdgregory.log4j.aws.internal.sns.SNSLogWriter
 
enqueue(LogMessage) - Method in class com.kdgregory.log4j.aws.internal.shared.MessageQueue
Adds a message to the end of the queue.
ensureDestinationAvailable() - Method in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchLogWriter
 
ensureDestinationAvailable() - Method in class com.kdgregory.log4j.aws.internal.kinesis.KinesisLogWriter
 
ensureDestinationAvailable() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter
Verifies that the logging destination is available, including creating it if not.
ensureDestinationAvailable() - Method in class com.kdgregory.log4j.aws.internal.sns.SNSLogWriter
 

F

format(LoggingEvent) - Method in class com.kdgregory.log4j.aws.JsonLayout
 

G

generateWriterConfig() - Method in class com.kdgregory.log4j.aws.CloudWatchAppender
 
generateWriterConfig() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Called just before a writer is created, so that the subclass can perform substitutions on the configuration.
generateWriterConfig() - Method in class com.kdgregory.log4j.aws.KinesisAppender
 
generateWriterConfig() - Method in class com.kdgregory.log4j.aws.SNSAppender
 
getActualLogGroupName() - Method in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchAppenderStatistics
 
getActualLogGroupName() - Method in interface com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchAppenderStatisticsMXBean
Returns the actual log group name for the appender, after substitutions.
getActualLogStreamName() - Method in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchAppenderStatistics
 
getActualLogStreamName() - Method in interface com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchAppenderStatisticsMXBean
Returns the actual log stream name for the appender, after substitutions.
getActualStreamName() - Method in class com.kdgregory.log4j.aws.internal.kinesis.KinesisAppenderStatistics
 
getActualStreamName() - Method in interface com.kdgregory.log4j.aws.internal.kinesis.KinesisAppenderStatisticsMXBean
Returns the actual log stream name used by the writer.
getActualTopicArn() - Method in class com.kdgregory.log4j.aws.internal.sns.SNSAppenderStatistics
 
getActualTopicArn() - Method in interface com.kdgregory.log4j.aws.internal.sns.SNSAppenderStatisticsMXBean
Returns the actual topic ARN used by the writer (after substitutions on the topic name).
getActualTopicName() - Method in class com.kdgregory.log4j.aws.internal.sns.SNSAppenderStatistics
 
getActualTopicName() - Method in interface com.kdgregory.log4j.aws.internal.sns.SNSAppenderStatisticsMXBean
Returns the actual topic name used by the writer (after substitutions).
getAppenderStatistics() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Returns the appender statistics object.
getAppendNewlines() - Method in class com.kdgregory.log4j.aws.JsonLayout
 
getAttribute(String) - Method in class com.kdgregory.log4j.aws.StatisticsMBean
 
getAttributes(String[]) - Method in class com.kdgregory.log4j.aws.StatisticsMBean
 
getAutoCreate() - Method in class com.kdgregory.log4j.aws.SNSAppender
Returns the auto-create flag.
getBatchCount() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter
Returns the number of batches processed.
getBatchDelay() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Returns the maximum batch delay; see AbstractAppender.setBatchDelay(long).
getBatchDelay() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter
Returns the current batch delay.
getBytes() - Method in class com.kdgregory.log4j.aws.internal.shared.LogMessage
Returns the UTF-8 message bytes.
getClientEndpoint() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Returns the current service endpoint.
getClientFactory() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Returns the current AWS client factory class/method name.
getClientFactoryUsed() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter
Returns the factory method used to create the client, if any.
getDiscardAction() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Returns the configured discard action.
getDiscardAction() - Method in class com.kdgregory.log4j.aws.internal.shared.MessageQueue
Returns the current discard action; this is intended for testing.
getDiscardThreshold() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Returns the configured discard threshold.
getDiscardThreshold() - Method in class com.kdgregory.log4j.aws.internal.shared.MessageQueue
Returns the current discard threshold; this is intended for testing.
getDroppedMessageCount() - Method in class com.kdgregory.log4j.aws.internal.shared.MessageQueue
Returns the number of messages that have been dropped.
getEnableHostname() - Method in class com.kdgregory.log4j.aws.JsonLayout
 
getEnableInstanceId() - Method in class com.kdgregory.log4j.aws.JsonLayout
 
getEnableLocation() - Method in class com.kdgregory.log4j.aws.JsonLayout
 
getInstance() - Static method in class com.kdgregory.log4j.aws.internal.shared.JMXManager
 
getLastError() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppenderStatistics
 
getLastErrorMessage() - Method in interface com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchAppenderStatisticsMXBean
Returns the most recent error from the writer.
getLastErrorMessage() - Method in interface com.kdgregory.log4j.aws.internal.kinesis.KinesisAppenderStatisticsMXBean
Returns the most recent error from the writer.
getLastErrorMessage() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppenderStatistics
 
getLastErrorMessage() - Method in interface com.kdgregory.log4j.aws.internal.sns.SNSAppenderStatisticsMXBean
Returns the most recent error from the writer.
getLastErrorStacktrace() - Method in interface com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchAppenderStatisticsMXBean
Returns the stack trace of the most recent error from the writer.
getLastErrorStacktrace() - Method in interface com.kdgregory.log4j.aws.internal.kinesis.KinesisAppenderStatisticsMXBean
Returns the stack trace of the most recent error from the writer.
getLastErrorStacktrace() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppenderStatistics
 
getLastErrorStacktrace() - Method in interface com.kdgregory.log4j.aws.internal.sns.SNSAppenderStatisticsMXBean
Returns the stack trace of the most recent error from the writer.
getLastErrorTimestamp() - Method in interface com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchAppenderStatisticsMXBean
Returns the timestamp of the most recent error from the writer.
getLastErrorTimestamp() - Method in interface com.kdgregory.log4j.aws.internal.kinesis.KinesisAppenderStatisticsMXBean
Returns the timestamp of the most recent error from the writer.
getLastErrorTimestamp() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppenderStatistics
 
getLastErrorTimestamp() - Method in interface com.kdgregory.log4j.aws.internal.sns.SNSAppenderStatisticsMXBean
Returns the timestamp of the most recent error from the writer.
getLogGroup() - Method in class com.kdgregory.log4j.aws.CloudWatchAppender
Returns the log group name; see CloudWatchAppender.setLogGroup(java.lang.String).
getLogStream() - Method in class com.kdgregory.log4j.aws.CloudWatchAppender
Returns the log stream name; see CloudWatchAppender.setLogStream(java.lang.String).
getMBeanInfo() - Method in class com.kdgregory.log4j.aws.StatisticsMBean
 
getMessage() - Method in class com.kdgregory.log4j.aws.internal.shared.LogMessage
Returns the original message string.
getMessagesDiscarded() - Method in interface com.kdgregory.log4j.aws.internal.kinesis.KinesisAppenderStatisticsMXBean
Returns the number of messages discarded by the message queue.
getMessagesDiscarded() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppenderStatistics
Returns the number of messages discarded by the current writer's message queue.
getMessagesDiscarded() - Method in interface com.kdgregory.log4j.aws.internal.sns.SNSAppenderStatisticsMXBean
Returns the number of messages discarded by the message queue.
getMessagesDiscardedByCurrentWriter() - Method in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchAppenderStatistics
 
getMessagesDiscardedByCurrentWriter() - Method in interface com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchAppenderStatisticsMXBean
Returns the number of messages discarded by the current writer's message queue.
getMessagesSent() - Method in interface com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchAppenderStatisticsMXBean
Returns the number of messages successfully sent to the logstream, by all writers.
getMessagesSent() - Method in interface com.kdgregory.log4j.aws.internal.kinesis.KinesisAppenderStatisticsMXBean
Returns the number of messages successfully sent to the stream.
getMessagesSent() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppenderStatistics
 
getMessagesSent() - Method in interface com.kdgregory.log4j.aws.internal.sns.SNSAppenderStatisticsMXBean
Returns the number of messages successfully sent to the topic.
getPartitionKey() - Method in class com.kdgregory.log4j.aws.KinesisAppender
Returns the unsubstituted partition key name; see KinesisAppender.setPartitionKey(java.lang.String).
getRetentionPeriod() - Method in class com.kdgregory.log4j.aws.KinesisAppender
Returns the configured retention period.
getRotationInterval() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Returns the current rotation interval.
getRotationMode() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Returns the current rotation mode.
getSequence() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Returns the current log sequence number.
getShardCount() - Method in class com.kdgregory.log4j.aws.KinesisAppender
Returns the configured number of shards for the stream.
getStreamName() - Method in class com.kdgregory.log4j.aws.KinesisAppender
Returns the unsubstituted stream name; see KinesisAppender.setStreamName(java.lang.String).
getSubject() - Method in class com.kdgregory.log4j.aws.SNSAppender
Returns the current subject value, as set.
getTags() - Method in class com.kdgregory.log4j.aws.JsonLayout
 
getTimestamp() - Method in class com.kdgregory.log4j.aws.internal.shared.LogMessage
Returns the timestamp of the original logging event.
getTopicArn() - Method in class com.kdgregory.log4j.aws.SNSAppender
Returns the configured topic ARN, without substitutions applied.
getTopicName() - Method in class com.kdgregory.log4j.aws.SNSAppender
Returns the configured topic name, without substitutions applied.

I

ignoresThrowable() - Method in class com.kdgregory.log4j.aws.JsonLayout
 
initializationFailure(String, Exception) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter
Records an initialization failure in the appender stats.
invoke(String, Object[], String[]) - Method in class com.kdgregory.log4j.aws.StatisticsMBean
 
isAutoCreate() - Method in class com.kdgregory.log4j.aws.KinesisAppender
Returns the auto-creation policy.
isEmpty() - Method in class com.kdgregory.log4j.aws.internal.shared.MessageQueue
Determines whether the queue is empty.
isInitializationComplete() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter
Returns a flag indicating that initialization has completed (whether or not successful).
isMessageTooLarge(LogMessage) - Method in class com.kdgregory.log4j.aws.CloudWatchAppender
 
isMessageTooLarge(LogMessage) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Called AbstractAppender.append(org.apache.log4j.spi.LoggingEvent) to ensure that we don't have a single message that violates AWS batching rules.
isMessageTooLarge(LogMessage) - Method in class com.kdgregory.log4j.aws.KinesisAppender
 
isMessageTooLarge(LogMessage) - Method in class com.kdgregory.log4j.aws.SNSAppender
 

J

JMXManager - Class in com.kdgregory.log4j.aws.internal.shared
This class ensures that appenders will be registered with any MBean servers where a StatisticsMBean instance has also been registered, regardless of the order that those objects are initialized/registered.
JMXManager() - Constructor for class com.kdgregory.log4j.aws.internal.shared.JMXManager
 
JsonConverter - Class in com.kdgregory.log4j.aws.internal.shared
Transforms a Map into a JSON string.
JsonConverter() - Constructor for class com.kdgregory.log4j.aws.internal.shared.JsonConverter
 
JsonLayout - Class in com.kdgregory.log4j.aws
Formats a LogMessage as a JSON string.
JsonLayout() - Constructor for class com.kdgregory.log4j.aws.JsonLayout
 

K

KinesisAppender - Class in com.kdgregory.log4j.aws
Appender that writes to a Kinesis stream.
KinesisAppender() - Constructor for class com.kdgregory.log4j.aws.KinesisAppender
Base constructor: assigns default values to configuration properties.
KinesisAppenderStatistics - Class in com.kdgregory.log4j.aws.internal.kinesis
 
KinesisAppenderStatistics() - Constructor for class com.kdgregory.log4j.aws.internal.kinesis.KinesisAppenderStatistics
 
KinesisAppenderStatisticsMXBean - Interface in com.kdgregory.log4j.aws.internal.kinesis
Defines the JMX Bean interface for KinesisAppenderStatistics.
KinesisConstants - Class in com.kdgregory.log4j.aws.internal.kinesis
Holds limits and other constants for Kinesis Streams.
KinesisConstants() - Constructor for class com.kdgregory.log4j.aws.internal.kinesis.KinesisConstants
 
KinesisLogWriter - Class in com.kdgregory.log4j.aws.internal.kinesis
 
KinesisLogWriter(KinesisWriterConfig, KinesisAppenderStatistics) - Constructor for class com.kdgregory.log4j.aws.internal.kinesis.KinesisLogWriter
 
KinesisWriterConfig - Class in com.kdgregory.log4j.aws.internal.kinesis
Holds configuration for the LogWriter.
KinesisWriterConfig(String, String, int, long, int, MessageQueue.DiscardAction, String, String, boolean, int, Integer) - Constructor for class com.kdgregory.log4j.aws.internal.kinesis.KinesisWriterConfig
 
KinesisWriterFactory - Class in com.kdgregory.log4j.aws.internal.kinesis
A factory for KinesisLogWriter instances.
KinesisWriterFactory() - Constructor for class com.kdgregory.log4j.aws.internal.kinesis.KinesisWriterFactory
 
knownServers - Variable in class com.kdgregory.log4j.aws.internal.shared.JMXManager
 

L

lastRotationCount - Variable in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
 
lastRotationTimestamp - Variable in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
 
logGroup - Variable in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchWriterConfig
 
LogMessage - Class in com.kdgregory.log4j.aws.internal.shared
Holder for an in-queue logging message.
LogMessage(long, String) - Constructor for class com.kdgregory.log4j.aws.internal.shared.LogMessage
Constructs an instance from a simple string.
LogMessage(LoggingEvent, Layout) - Constructor for class com.kdgregory.log4j.aws.internal.shared.LogMessage
Constructs an instance from a Log4J event, using the specified layout.
logStream - Variable in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchWriterConfig
 
LogWriter - Interface in com.kdgregory.log4j.aws.internal.shared
Defines the contract between appenders and writers.
lookup(String) - Static method in enum com.kdgregory.log4j.aws.internal.shared.MessageQueue.DiscardAction
 
lookup(String) - Static method in enum com.kdgregory.log4j.aws.internal.shared.RotationMode
Finds the rotation mode corresponding to a passed string (case-insensitive).

M

MAX_BATCH_BYTES - Static variable in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchConstants
Maximum number of bytes in a single batch.
MAX_BATCH_BYTES - Static variable in class com.kdgregory.log4j.aws.internal.kinesis.KinesisConstants
Maximum number of bytes in a batch.
MAX_BATCH_COUNT - Static variable in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchConstants
Maximum number of messages in a single batch.
MAX_BATCH_COUNT - Static variable in class com.kdgregory.log4j.aws.internal.kinesis.KinesisConstants
Maximum number of messages in a single batch.
MAX_MESSAGE_BYTES - Static variable in class com.kdgregory.log4j.aws.internal.kinesis.KinesisConstants
Maximum number of bytes in a for a single message.
MAX_MESSAGE_BYTES - Static variable in class com.kdgregory.log4j.aws.internal.sns.SNSConstants
Maximum number of bytes in a for a single message.
MAXIMUM_RETENTION_PERIOD - Static variable in class com.kdgregory.log4j.aws.internal.kinesis.KinesisConstants
Maximum number of hours for retention period.
MESSAGE_OVERHEAD - Static variable in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchConstants
Overhead added to each message.
MessageQueue - Class in com.kdgregory.log4j.aws.internal.shared
A thread-safe message queue that keeps track of the current number of entries and optionally discards messages after its size reaches a given threshold.
MessageQueue(int, MessageQueue.DiscardAction) - Constructor for class com.kdgregory.log4j.aws.internal.shared.MessageQueue
 
MessageQueue.DiscardAction - Enum in com.kdgregory.log4j.aws.internal.shared
Controls how messages are discarded once the threshold is reached.
MINIMUM_RETENTION_PERIOD - Static variable in class com.kdgregory.log4j.aws.internal.kinesis.KinesisConstants
Minimum number of hours for retention period.

N

newLogWriter(CloudWatchWriterConfig, CloudWatchAppenderStatistics) - Method in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchWriterFactory
 
newLogWriter(KinesisWriterConfig, KinesisAppenderStatistics) - Method in class com.kdgregory.log4j.aws.internal.kinesis.KinesisWriterFactory
 
newLogWriter(C, S) - Method in interface com.kdgregory.log4j.aws.internal.shared.WriterFactory
 
newLogWriter(SNSWriterConfig, SNSAppenderStatistics) - Method in class com.kdgregory.log4j.aws.internal.sns.SNSWriterFactory
 

P

partitionKey - Variable in class com.kdgregory.log4j.aws.internal.kinesis.KinesisWriterConfig
 
partitionKeyLength - Variable in class com.kdgregory.log4j.aws.internal.kinesis.KinesisWriterConfig
 
perform(String) - Method in class com.kdgregory.log4j.aws.internal.shared.Substitutions
Applies all substitutions.
postDeregister() - Method in class com.kdgregory.log4j.aws.StatisticsMBean
 
postRegister(Boolean) - Method in class com.kdgregory.log4j.aws.StatisticsMBean
 
preDeregister() - Method in class com.kdgregory.log4j.aws.StatisticsMBean
 
preRegister(MBeanServer, ObjectName) - Method in class com.kdgregory.log4j.aws.StatisticsMBean
 
processBatch(List<LogMessage>) - Method in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchLogWriter
 
processBatch(List<LogMessage>) - Method in class com.kdgregory.log4j.aws.internal.kinesis.KinesisLogWriter
 
processBatch(List<LogMessage>) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter
Processes a batch of messages.
processBatch(List<LogMessage>) - Method in class com.kdgregory.log4j.aws.internal.sns.SNSLogWriter
 

Q

queueSize() - Method in class com.kdgregory.log4j.aws.internal.shared.MessageQueue
Returns the current number of elements in the queue, as recorded by the queue itself.

R

registerAppenderBean(String, MBeanServer) - Method in class com.kdgregory.log4j.aws.internal.shared.JMXManager
Registers an appender's stats bean with a server.
registerStatisticsBean() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Registers the appender statistics with JMX.
removeAppender(String) - Method in class com.kdgregory.log4j.aws.internal.shared.JMXManager
Removes information about an appender from the internal tables and deregisters it from any MBeanServers.
removeStatisticsMBean(StatisticsMBean) - Method in class com.kdgregory.log4j.aws.internal.shared.JMXManager
Will deregister a StatisticsMBean instance from all known servers.
requeue(LogMessage) - Method in class com.kdgregory.log4j.aws.internal.shared.MessageQueue
Adds a message to the start of the queue.
requiresLayout() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
 
reset(JMXManager) - Static method in class com.kdgregory.log4j.aws.internal.shared.JMXManager
Replaces the singleton instance with a new instance.
retentionPeriod - Variable in class com.kdgregory.log4j.aws.internal.kinesis.KinesisWriterConfig
 
retrieveAWSAccountId() - Static method in class com.kdgregory.log4j.aws.internal.shared.Utils
Retrieves the current AWS account ID, using reflection so that we don't have a hard reference to the STS SDK JAR (ie, if you don't want account IDs you don't need the JAR).
rotate() - Method in class com.kdgregory.log4j.aws.CloudWatchAppender
Rotates the log stream: flushes all outstanding messages to the current stream, and opens a new stream.
rotate() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Rotates the log writer.
rotationInterval - Variable in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
 
rotationMode - Variable in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
 
RotationMode - Enum in com.kdgregory.log4j.aws.internal.shared
Defines the ways that we'll rotate logs (for appenders that support rotate).
run() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter
 

S

sequence - Variable in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
 
setActualLogGroupName(String) - Method in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchAppenderStatistics
 
setActualLogStreamName(String) - Method in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchAppenderStatistics
 
setActualStreamName(String) - Method in class com.kdgregory.log4j.aws.internal.kinesis.KinesisAppenderStatistics
 
setActualTopicArn(String) - Method in class com.kdgregory.log4j.aws.internal.sns.SNSAppenderStatistics
 
setActualTopicName(String) - Method in class com.kdgregory.log4j.aws.internal.sns.SNSAppenderStatistics
 
setAppendNewlines(boolean) - Method in class com.kdgregory.log4j.aws.JsonLayout
 
setAttribute(Attribute) - Method in class com.kdgregory.log4j.aws.StatisticsMBean
 
setAttributes(AttributeList) - Method in class com.kdgregory.log4j.aws.StatisticsMBean
 
setAutoCreate(boolean) - Method in class com.kdgregory.log4j.aws.KinesisAppender
Sets the auto-creation policy: if true, the stream will be created if it does not already exist.
setAutoCreate(boolean) - Method in class com.kdgregory.log4j.aws.SNSAppender
Sets the auto-create flag: if the topic is specified by name and does not already exist, the writer will attempt to create it.
setBatchDelay(long) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Sets the maximum batch delay, in milliseconds.
setBatchDelay(long) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter
 
setBatchDelay(long) - Method in interface com.kdgregory.log4j.aws.internal.shared.LogWriter
Sets the batch delay for the writer.
setBatchDelay(long) - Method in class com.kdgregory.log4j.aws.SNSAppender
Any configured batch delay will be ignored; the appender attempts to send all messages as soon as they are appended.
setClientEndpoint(String) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Sets the service endpoint.
setClientFactory(String) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Sets a static AWS client factory method, which will be called instead of the writer's internal client factory.
setDiscardAction(String) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Sets the action to take when the number of unsent messages exceeds the discard threshold.
setDiscardAction(MessageQueue.DiscardAction) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter
 
setDiscardAction(MessageQueue.DiscardAction) - Method in interface com.kdgregory.log4j.aws.internal.shared.LogWriter
Updates the writer's discard action: how it discards messages once the threshold has been reached.
setDiscardAction(MessageQueue.DiscardAction) - Method in class com.kdgregory.log4j.aws.internal.shared.MessageQueue
Changes the discard action
setDiscardThreshold(int) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Sets the number of unsent messages that will trigger message discard.
setDiscardThreshold(int) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter
 
setDiscardThreshold(int) - Method in interface com.kdgregory.log4j.aws.internal.shared.LogWriter
Updates the writer's discard threshold: the maximum number of message stored in its queue.
setDiscardThreshold(int) - Method in class com.kdgregory.log4j.aws.internal.shared.MessageQueue
Changes the discard threshold.
setEnableHostname(boolean) - Method in class com.kdgregory.log4j.aws.JsonLayout
 
setEnableInstanceId(boolean) - Method in class com.kdgregory.log4j.aws.JsonLayout
 
setEnableLocation(boolean) - Method in class com.kdgregory.log4j.aws.JsonLayout
 
setLastError(String, Throwable) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppenderStatistics
Sets the last error.
setLogGroup(String) - Method in class com.kdgregory.log4j.aws.CloudWatchAppender
Sets the CloudWatch Log Group associated with this appender.
setLogStream(String) - Method in class com.kdgregory.log4j.aws.CloudWatchAppender
Sets the CloudWatch Log Stream associated with this appender.
setMessageQueue(MessageQueue) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppenderStatistics
Stores the current writer's message queue.
setPartitionKey(String) - Method in class com.kdgregory.log4j.aws.KinesisAppender
Sets the partition key associated with this appender.
setRetentionPeriod(int) - Method in class com.kdgregory.log4j.aws.KinesisAppender
Sets the message retention period, in hours.
setRotationInterval(long) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Sets the rotation interval, for those appenders that support rotation.
setRotationMode(String) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Sets the rule for log stream rotation, for those appenders that support rotation.
setSequence(int) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Sets the log sequence number, used by the {sequence} substitution variable.
setShardCount(int) - Method in class com.kdgregory.log4j.aws.KinesisAppender
Sets the desired number of shards to use when creating the stream.
setStreamName(String) - Method in class com.kdgregory.log4j.aws.KinesisAppender
Sets the Kinesis Stream name associated with this appender.
setSubject(String) - Method in class com.kdgregory.log4j.aws.SNSAppender
Sets the subject that will be applied to messages; blank disables subjects.
setTags(String) - Method in class com.kdgregory.log4j.aws.JsonLayout
 
setTopicArn(String) - Method in class com.kdgregory.log4j.aws.SNSAppender
Specifies the destination topic by ARN; the topic must already exist.
setTopicName(String) - Method in class com.kdgregory.log4j.aws.SNSAppender
Sets the topic name.
shardCount - Variable in class com.kdgregory.log4j.aws.internal.kinesis.KinesisWriterConfig
 
size() - Method in class com.kdgregory.log4j.aws.internal.shared.LogMessage
Returns the size of the message after conversion to UTF-8.
size() - Method in class com.kdgregory.log4j.aws.internal.shared.MessageQueue
Returns the current number of elements in the queue, as recorded by the atomic counter.
sleepQuietly(long) - Static method in class com.kdgregory.log4j.aws.internal.shared.Utils
Sleeps until the specified time elapses or the thread is interrupted.
SNSAppender - Class in com.kdgregory.log4j.aws
Writes messages to Amazon's Simple Notification Service.
SNSAppender() - Constructor for class com.kdgregory.log4j.aws.SNSAppender
 
SNSAppenderStatistics - Class in com.kdgregory.log4j.aws.internal.sns
 
SNSAppenderStatistics() - Constructor for class com.kdgregory.log4j.aws.internal.sns.SNSAppenderStatistics
 
SNSAppenderStatisticsMXBean - Interface in com.kdgregory.log4j.aws.internal.sns
Defines the JMX Bean interface for SNSAppenderStatistics.
SNSConstants - Class in com.kdgregory.log4j.aws.internal.sns
Holds limits and other constants for SNS.
SNSConstants() - Constructor for class com.kdgregory.log4j.aws.internal.sns.SNSConstants
 
SNSLogWriter - Class in com.kdgregory.log4j.aws.internal.sns
 
SNSLogWriter(SNSWriterConfig, SNSAppenderStatistics) - Constructor for class com.kdgregory.log4j.aws.internal.sns.SNSLogWriter
 
SNSWriterConfig - Class in com.kdgregory.log4j.aws.internal.sns
Holds configuration for the LogWriter.
SNSWriterConfig(String, String, boolean, String, int, MessageQueue.DiscardAction, String, String) - Constructor for class com.kdgregory.log4j.aws.internal.sns.SNSWriterConfig
 
SNSWriterFactory - Class in com.kdgregory.log4j.aws.internal.sns
 
SNSWriterFactory() - Constructor for class com.kdgregory.log4j.aws.internal.sns.SNSWriterFactory
 
startLoggingThread(LogWriter, Thread.UncaughtExceptionHandler) - Method in class com.kdgregory.log4j.aws.internal.shared.DefaultThreadFactory
 
startLoggingThread(LogWriter, Thread.UncaughtExceptionHandler) - Method in interface com.kdgregory.log4j.aws.internal.shared.ThreadFactory
 
StatisticsMBean - Class in com.kdgregory.log4j.aws
This class provides a bridge between an appenders and an MBeanServer.
StatisticsMBean() - Constructor for class com.kdgregory.log4j.aws.StatisticsMBean
 
stop() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter
 
stop() - Method in interface com.kdgregory.log4j.aws.internal.shared.LogWriter
Signals the writer that it will no longer receive batches.
streamName - Variable in class com.kdgregory.log4j.aws.internal.kinesis.KinesisWriterConfig
 
subject - Variable in class com.kdgregory.log4j.aws.internal.sns.SNSWriterConfig
 
Substitutions - Class in com.kdgregory.log4j.aws.internal.shared
Handles the standard substitution variables.
Substitutions(Date, int) - Constructor for class com.kdgregory.log4j.aws.internal.shared.Substitutions
 

T

threadFactory - Variable in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
 
ThreadFactory - Interface in com.kdgregory.log4j.aws.internal.shared
Creates and starts a new thread for running the LogWriter.
toList() - Method in class com.kdgregory.log4j.aws.internal.shared.MessageQueue
Copies the current queue contents into a List.
TOPIC_NAME_REGEX - Static variable in class com.kdgregory.log4j.aws.internal.sns.SNSConstants
Validation regex for a topic name.
topicArn - Variable in class com.kdgregory.log4j.aws.internal.sns.SNSLogWriter
 
topicArn - Variable in class com.kdgregory.log4j.aws.internal.sns.SNSWriterConfig
 
topicName - Variable in class com.kdgregory.log4j.aws.internal.sns.SNSWriterConfig
 
tryClientFactory(String, Class<T>, boolean) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter
Attempts to use a factory method to create the service client.
tryConfigureEndpointOrRegion(T, String) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter
Common support code: attempts to configure client endpoint and/or region.

U

unregisterAppenderBean(String, MBeanServer) - Method in class com.kdgregory.log4j.aws.internal.shared.JMXManager
Deregisters an appender's stats bean from a server.
unregisterStatisticsBean() - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
Unregisters the appender statistics from JMX.
updateMessagesSent(int) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractAppenderStatistics
Updates the number of messages sent with the given count.
Utils - Class in com.kdgregory.log4j.aws.internal.shared
Various static utility functions.
Utils() - Constructor for class com.kdgregory.log4j.aws.internal.shared.Utils
 

V

valueOf(String) - Static method in enum com.kdgregory.log4j.aws.internal.shared.MessageQueue.DiscardAction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.kdgregory.log4j.aws.internal.shared.RotationMode
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.kdgregory.log4j.aws.internal.shared.MessageQueue.DiscardAction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.kdgregory.log4j.aws.internal.shared.RotationMode
Returns an array containing the constants of this enum type, in the order they are declared.

W

withinServiceLimits(int, int) - Method in class com.kdgregory.log4j.aws.internal.cloudwatch.CloudWatchLogWriter
 
withinServiceLimits(int, int) - Method in class com.kdgregory.log4j.aws.internal.kinesis.KinesisLogWriter
 
withinServiceLimits(int, int) - Method in class com.kdgregory.log4j.aws.internal.shared.AbstractLogWriter
Determines whether the provided batch size or number of messages would exceed the service's limits.
withinServiceLimits(int, int) - Method in class com.kdgregory.log4j.aws.internal.sns.SNSLogWriter
 
writer - Variable in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
 
writerFactory - Variable in class com.kdgregory.log4j.aws.internal.shared.AbstractAppender
 
WriterFactory<C,S> - Interface in com.kdgregory.log4j.aws.internal.shared
Defines a function to create a LogWriter.
A B C D E F G I J K L M N P Q R S T U V W 
Skip navigation links

Copyright © 2018. All rights reserved.