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

A

AbstractJMXManager - Class in com.kdgregory.logging.aws.internal

This class manages the relationships between the writer statistics beans and the JMX server(s) where they should be registered.

AbstractJMXManager(InternalLogger) - Constructor for class com.kdgregory.logging.aws.internal.AbstractJMXManager

AbstractLogWriter<ConfigType extends AbstractWriterConfig<ConfigType>,StatsType extends AbstractWriterStatistics> - Class in com.kdgregory.logging.aws.internal

Manages common LogWriter activities.

AbstractLogWriter(ConfigType, StatsType, InternalLogger) - Constructor for class com.kdgregory.logging.aws.internal.AbstractLogWriter

AbstractMarkerBean - Class in com.kdgregory.logging.aws.internal

This class serves as the base "marker bean" for JMX integration: it implements the MBean interfaces, and acts as a listener for registration and deregistration notifications.

AbstractMarkerBean() - Constructor for class com.kdgregory.logging.aws.internal.AbstractMarkerBean

AbstractWriterConfig<T extends AbstractWriterConfig<T>> - Class in com.kdgregory.logging.aws.internal

Holds common configuration; writer-specific config objects are subclasses.

AbstractWriterConfig(long) - Constructor for class com.kdgregory.logging.aws.internal.AbstractWriterConfig

AbstractWriterStatistics - Class in com.kdgregory.logging.aws.internal

Base class for writer statistics, providing fields that are used by all writer implementations.

AbstractWriterStatistics() - Constructor for class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

addMarkerBean(Object, MBeanServer, ObjectName) - Method in class com.kdgregory.logging.aws.internal.AbstractJMXManager

Adds relationship between a marker bean and an MBeanServer.

addMessage(LogMessage) - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

addMessage(LogMessage) - Method in interface com.kdgregory.logging.common.LogWriter

Adds a message to the writer's message queue.

addStatsBean(String, AbstractWriterStatistics, Class<?>) - Method in class com.kdgregory.logging.aws.internal.AbstractJMXManager

Adds a writer's statsbean and its class to the internal tracking tables.

ALLOWED_GROUP_NAME_REGEX - Static variable in class com.kdgregory.logging.aws.cloudwatch.CloudWatchConstants

Used to validate log stream names.

ALLOWED_PARITION_KEY_REGEX - Static variable in class com.kdgregory.logging.aws.kinesis.KinesisConstants

Allowed characters for partition key.

ALLOWED_STREAM_NAME_REGEX - Static variable in class com.kdgregory.logging.aws.cloudwatch.CloudWatchConstants

Used to validate log group names.

ALLOWED_STREAM_NAME_REGEX - Static variable in class com.kdgregory.logging.aws.kinesis.KinesisConstants

Allowed characters for stream name.

B

buildBatch(long) - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

Attempts to read a list of messages from the queue.

C

clone() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

CloudWatchConstants - Class in com.kdgregory.logging.aws.cloudwatch

Holds limits and other constants for CloudWatch Logs.

CloudWatchConstants() - Constructor for class com.kdgregory.logging.aws.cloudwatch.CloudWatchConstants

CloudWatchFacade - Interface in com.kdgregory.logging.aws.facade

Exposes the CloudWatch Logs APIs used by CloudWatchLogWriter.

CloudWatchFacadeException - Exception in com.kdgregory.logging.aws.facade

This exception is thown by CloudWatchFacade for any situation that requires intervention by the caller.

CloudWatchFacadeException(String, Throwable, CloudWatchFacadeException.ReasonCode, boolean, String, Object...) - Constructor for exception com.kdgregory.logging.aws.facade.CloudWatchFacadeException

Base constructor.

CloudWatchFacadeException(String, CloudWatchFacadeException.ReasonCode, boolean, String, Object...) - Constructor for exception com.kdgregory.logging.aws.facade.CloudWatchFacadeException

Convenience constructor, for conditions where there is no underlying exception, or where it's irrelevant.

CloudWatchFacadeException(CloudWatchFacadeException.ReasonCode, boolean, Throwable) - Constructor for exception com.kdgregory.logging.aws.facade.CloudWatchFacadeException

Convenience constructor for testing.

CloudWatchFacadeException.ReasonCode - Enum in com.kdgregory.logging.aws.facade

CloudWatchLogWriter - Class in com.kdgregory.logging.aws.cloudwatch

Writes messages to a CloudWatch log stream.

CloudWatchLogWriter(CloudWatchWriterConfig, CloudWatchWriterStatistics, InternalLogger, CloudWatchFacade) - Constructor for class com.kdgregory.logging.aws.cloudwatch.CloudWatchLogWriter

CloudWatchWriterConfig - Class in com.kdgregory.logging.aws.cloudwatch

Configuration for CloudWatchLogWriter.

CloudWatchWriterConfig() - Constructor for class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterConfig

CloudWatchWriterFactory - Class in com.kdgregory.logging.aws.cloudwatch

Factory to create SNSLogWriter instances.

CloudWatchWriterFactory() - Constructor for class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterFactory

CloudWatchWriterStatistics - Class in com.kdgregory.logging.aws.cloudwatch

Statistics specific to CloudWatchLogWriter.

CloudWatchWriterStatistics() - Constructor for class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatistics

CloudWatchWriterStatisticsMXBean - Interface in com.kdgregory.logging.aws.cloudwatch

Defines the JMX Bean interface for CloudWatchWriterStatistics.

com.kdgregory.logging.aws.cloudwatch - package com.kdgregory.logging.aws.cloudwatch

com.kdgregory.logging.aws.common - package com.kdgregory.logging.aws.common

com.kdgregory.logging.aws.facade - package com.kdgregory.logging.aws.facade

com.kdgregory.logging.aws.internal - package com.kdgregory.logging.aws.internal

com.kdgregory.logging.aws.kinesis - package com.kdgregory.logging.aws.kinesis

com.kdgregory.logging.aws.sns - package com.kdgregory.logging.aws.sns

com.kdgregory.logging.common - package com.kdgregory.logging.common

com.kdgregory.logging.common.internal - package com.kdgregory.logging.common.internal

com.kdgregory.logging.common.util - package com.kdgregory.logging.common.util

compareTo(LogMessage) - Method in class com.kdgregory.logging.common.LogMessage

Compares instances based on their timestamp.

config - Variable in class com.kdgregory.logging.aws.internal.AbstractLogWriter

convert(Map<String, Object>) - Method in class com.kdgregory.logging.common.internal.JsonConverter

createFacade(Class<T>, AbstractWriterConfig<?>) - Static method in class com.kdgregory.logging.aws.facade.FacadeFactory

Instantiates the facade implementation corresponding to the provided interface class.

createFacade(Class<T>) - Static method in class com.kdgregory.logging.aws.facade.FacadeFactory

Instantiates the facade implementation corresponding to the provided interface class.

createLogGroup() - Method in interface com.kdgregory.logging.aws.facade.CloudWatchFacade

Attempts to create the configured log group.

createLogStream() - Method in interface com.kdgregory.logging.aws.facade.CloudWatchFacade

Attempts to create the configured log stream.

createRetry - Variable in class com.kdgregory.logging.aws.cloudwatch.CloudWatchLogWriter

createRetry - Variable in class com.kdgregory.logging.aws.kinesis.KinesisLogWriter

createRetry - Variable in class com.kdgregory.logging.aws.sns.SNSLogWriter

createStream() - Method in interface com.kdgregory.logging.aws.facade.KinesisFacade

Creates the stream.

createThread(LogWriter, Thread.UncaughtExceptionHandler) - Method in class com.kdgregory.logging.common.util.DefaultThreadFactory

Creates and initializes the thread.

createTopic() - Method in interface com.kdgregory.logging.aws.facade.SNSFacade

Attempts to create a topic with the configured name.

D

debug(String) - Method in interface com.kdgregory.logging.common.util.InternalLogger

Called to log general status messages.

DEFAULT_AUTO_CREATE - Static variable in class com.kdgregory.logging.aws.kinesis.KinesisWriterConfig

DEFAULT_BATCH_DELAY - Static variable in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

DEFAULT_DEDICATED_WRITER - Static variable in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterConfig

DEFAULT_DISCARD_ACTION - Static variable in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

DEFAULT_DISCARD_THRESHOLD - Static variable in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

DEFAULT_ENABLE_BATCH_LOGGING - Static variable in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

DEFAULT_INITIALIZATION_TIMEOUT - Static variable in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterConfig

DEFAULT_INITIALIZATION_TIMEOUT - Static variable in class com.kdgregory.logging.aws.kinesis.KinesisWriterConfig

DEFAULT_INITIALIZATION_TIMEOUT - Static variable in class com.kdgregory.logging.aws.sns.SNSWriterConfig

DEFAULT_IS_SYNCHRONOUS - Static variable in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

DEFAULT_LOG_STREAM_NAME - Static variable in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterConfig

DEFAULT_PARTITION_KEY - Static variable in class com.kdgregory.logging.aws.kinesis.KinesisWriterConfig

DEFAULT_RETENTION_PERIOD - Static variable in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterConfig

DEFAULT_SHARD_COUNT - Static variable in class com.kdgregory.logging.aws.kinesis.KinesisWriterConfig

DEFAULT_TRUNCATE_OVERSIZE - Static variable in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

DEFAULT_USE_SHUTDOWN_HOOK - Static variable in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

DefaultThreadFactory - Class in com.kdgregory.logging.common.util

The standard ThreadFactory: launches a daemon thread to run normal writers, runs synchronous writers inline.

DefaultThreadFactory(String) - Constructor for class com.kdgregory.logging.common.util.DefaultThreadFactory

dequeue() - Method in class com.kdgregory.logging.common.util.MessageQueue

Removes a message from the front of the queue.

dequeue(long) - Method in class com.kdgregory.logging.common.util.MessageQueue

Removes a message from the front of the queue, waiting for a specified number of milliseconds if the queue is empty.

describeRetry - Variable in class com.kdgregory.logging.aws.cloudwatch.CloudWatchLogWriter

describeRetry - Variable in class com.kdgregory.logging.aws.kinesis.KinesisLogWriter

describeRetry - Variable in class com.kdgregory.logging.aws.sns.SNSLogWriter

describeTimeout - Variable in class com.kdgregory.logging.aws.sns.SNSLogWriter

E

effectiveSize(LogMessage) - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchLogWriter

effectiveSize(LogMessage) - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

Calculates the effective size of the message.

effectiveSize(LogMessage) - Method in class com.kdgregory.logging.aws.kinesis.KinesisLogWriter

effectiveSize(LogMessage) - Method in class com.kdgregory.logging.aws.sns.SNSLogWriter

enqueue(LogMessage) - Method in class com.kdgregory.logging.common.util.MessageQueue

Adds a message to the end of the queue.

ensureDestinationAvailable() - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchLogWriter

ensureDestinationAvailable() - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

Verifies that the logging destination is available (which may involve creating it).

ensureDestinationAvailable() - Method in class com.kdgregory.logging.aws.kinesis.KinesisLogWriter

ensureDestinationAvailable() - Method in class com.kdgregory.logging.aws.sns.SNSLogWriter

error(String, Throwable) - Method in interface com.kdgregory.logging.common.util.InternalLogger

Called to log error messages.

F

FacadeException - Exception in com.kdgregory.logging.aws.facade

A wrapper for any exceptions that happen inside a facade implementation.

FacadeException(String, Throwable, boolean, String, Object...) - Constructor for exception com.kdgregory.logging.aws.facade.FacadeException

Base constructor.

FacadeFactory - Class in com.kdgregory.logging.aws.facade

Creates new instances of AWS facade objects.

FacadeFactory() - Constructor for class com.kdgregory.logging.aws.facade.FacadeFactory

findFullyQualifiedMethod(String, Class<?>...) - Static method in class com.kdgregory.logging.common.internal.Utils

Attempts to find a method given its fully-qualified name (eg: com.example.package.MyClass.myMethod).

findLogGroup() - Method in interface com.kdgregory.logging.aws.facade.CloudWatchFacade

Determines whether the configured log group exists, and returns its ARN if it does.

findLogStream() - Method in interface com.kdgregory.logging.aws.facade.CloudWatchFacade

Determines whether the configured log stream exists, returning its ARN if it does.

findMethodIfExists(Class<?>, String, Class<?>...) - Static method in class com.kdgregory.logging.common.internal.Utils

Returns a declared or inherited method with the specified parameter types, null if one doesn't exist or the passed class is null.

G

getActualLogGroupName() - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatistics

getActualLogGroupName() - Method in interface com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatisticsMXBean

Returns the actual log group name for the appender, after substitutions.

getActualLogStreamName() - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatistics

getActualLogStreamName() - Method in interface com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatisticsMXBean

Returns the actual log stream name for the appender, after substitutions.

getActualStreamName() - Method in class com.kdgregory.logging.aws.kinesis.KinesisWriterStatistics

getActualStreamName() - Method in interface com.kdgregory.logging.aws.kinesis.KinesisWriterStatisticsMXBean

Returns the actual log stream name used by the writer.

getActualSubject() - Method in class com.kdgregory.logging.aws.sns.SNSWriterStatistics

getActualSubject() - Method in interface com.kdgregory.logging.aws.sns.SNSWriterStatisticsMXBean

Returns the actual subject used by the writer (after substitutions).

getActualTimeout() - Method in exception com.kdgregory.logging.common.util.RetryManager2.TimeoutException

Returns the instant when the RetryManager decided to abort the operation.

getActualTopicArn() - Method in class com.kdgregory.logging.aws.sns.SNSWriterStatistics

getActualTopicArn() - Method in interface com.kdgregory.logging.aws.sns.SNSWriterStatisticsMXBean

Returns the actual topic ARN used by the writer (after substitutions).

getActualTopicName() - Method in class com.kdgregory.logging.aws.sns.SNSWriterStatistics

getActualTopicName() - Method in interface com.kdgregory.logging.aws.sns.SNSWriterStatisticsMXBean

Returns the actual topic name used by the writer (after substitutions).

getAssumedRole() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

getAttribute(String) - Method in class com.kdgregory.logging.aws.internal.AbstractMarkerBean

getAttributes(String[]) - Method in class com.kdgregory.logging.aws.internal.AbstractMarkerBean

getAutoCreate() - Method in class com.kdgregory.logging.aws.kinesis.KinesisWriterConfig

getAutoCreate() - Method in class com.kdgregory.logging.aws.sns.SNSWriterConfig

getBatchCount() - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

Returns the number of batches processed.

getBatchDelay() - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

Returns the current batch delay.

getBatchDelay() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

getBytes() - Method in class com.kdgregory.logging.common.LogMessage

Returns the UTF-8 message bytes.

getClientEndpoint() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

getClientFactoryMethod() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

getClientRegion() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

getDedicatedWriter() - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterConfig

getDiscardAction() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

getDiscardAction() - Method in class com.kdgregory.logging.common.util.MessageQueue

Returns the current discard action; this is intended for testing.

getDiscardThreshold() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

getDiscardThreshold() - Method in class com.kdgregory.logging.common.util.MessageQueue

Returns the current discard threshold; this is intended for testing.

getDroppedMessageCount() - Method in class com.kdgregory.logging.common.util.MessageQueue

Returns the number of messages that have been dropped.

getEnableBatchLogging() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

getExpectedTimeout() - Method in exception com.kdgregory.logging.common.util.RetryManager2.TimeoutException

Returns the instant provided to the RetryManager as a timeout limit.

getFunctionName() - Method in exception com.kdgregory.logging.aws.facade.FacadeException

Returns the function that throw this exception (included for completeness).

getInitializationTimeout() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

getLastBatchSize() - Method in interface com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatisticsMXBean

Returns the number of messages in the most recent batch.

getLastBatchSize() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

getLastBatchSize() - Method in interface com.kdgregory.logging.aws.kinesis.KinesisWriterStatisticsMXBean

Returns the number of messages in the most recent batch.

getLastBatchSize() - Method in interface com.kdgregory.logging.aws.sns.SNSWriterStatisticsMXBean

Returns the number of messages in the most recent batch.

getLastError() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

getLastErrorMessage() - Method in interface com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatisticsMXBean

Returns the most recent error from the writer.

getLastErrorMessage() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

getLastErrorMessage() - Method in interface com.kdgregory.logging.aws.kinesis.KinesisWriterStatisticsMXBean

Returns the most recent error from the writer.

getLastErrorMessage() - Method in interface com.kdgregory.logging.aws.sns.SNSWriterStatisticsMXBean

Returns the most recent error from the writer.

getLastErrorStacktrace() - Method in interface com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatisticsMXBean

Returns the stack trace of the most recent error from the writer.

getLastErrorStacktrace() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

getLastErrorStacktrace() - Method in interface com.kdgregory.logging.aws.kinesis.KinesisWriterStatisticsMXBean

Returns the stack trace of the most recent error from the writer.

getLastErrorStacktrace() - Method in interface com.kdgregory.logging.aws.sns.SNSWriterStatisticsMXBean

Returns the stack trace of the most recent error from the writer.

getLastErrorTimestamp() - Method in interface com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatisticsMXBean

Returns the timestamp of the most recent error from the writer.

getLastErrorTimestamp() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

getLastErrorTimestamp() - Method in interface com.kdgregory.logging.aws.kinesis.KinesisWriterStatisticsMXBean

Returns the timestamp of the most recent error from the writer.

getLastErrorTimestamp() - Method in interface com.kdgregory.logging.aws.sns.SNSWriterStatisticsMXBean

Returns the timestamp of the most recent error from the writer.

getLength() - Method in class com.kdgregory.logging.aws.kinesis.PartitionKeyHelper

Returns the length of the partition key.

getLogGroupName() - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterConfig

getLogStreamName() - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterConfig

getMBeanInfo() - Method in class com.kdgregory.logging.aws.internal.AbstractMarkerBean

getMessage() - Method in class com.kdgregory.logging.common.LogMessage

Returns the original message string.

getMessage() - Method in exception com.kdgregory.logging.common.util.RetryManager2.TimeoutException

getMessagesDiscarded() - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatistics

getMessagesDiscarded() - Method in interface com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatisticsMXBean

Returns the number of messages discarded by the current writer's message queue.

getMessagesDiscarded() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

getMessagesDiscarded() - Method in interface com.kdgregory.logging.aws.kinesis.KinesisWriterStatisticsMXBean

Returns the number of messages discarded by the writer's message queue.

getMessagesDiscarded() - Method in interface com.kdgregory.logging.aws.sns.SNSWriterStatisticsMXBean

Returns the number of messages discarded by the writer's message queue.

getMessagesRequeuedLastBatch() - Method in interface com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatisticsMXBean

Returns the number of messages requeued because they could not be sent.

getMessagesRequeuedLastBatch() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

getMessagesRequeuedLastBatch() - Method in interface com.kdgregory.logging.aws.kinesis.KinesisWriterStatisticsMXBean

Returns the number of messages requeued because they could not be sent.

getMessagesRequeuedLastBatch() - Method in interface com.kdgregory.logging.aws.sns.SNSWriterStatisticsMXBean

Returns the number of messages requeued because they could not be sent.

getMessagesSent() - Method in interface com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatisticsMXBean

Returns the number of messages successfully sent to the logstream, by the current writer.

getMessagesSent() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

getMessagesSent() - Method in interface com.kdgregory.logging.aws.kinesis.KinesisWriterStatisticsMXBean

Returns the number of messages successfully sent to the stream.

getMessagesSent() - Method in interface com.kdgregory.logging.aws.sns.SNSWriterStatisticsMXBean

Returns the number of messages successfully sent to the topic.

getMessagesSentLastBatch() - Method in interface com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatisticsMXBean

Returns the number of messages successfully sent to the logstream in the last batch.

getMessagesSentLastBatch() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

getMessagesSentLastBatch() - Method in interface com.kdgregory.logging.aws.kinesis.KinesisWriterStatisticsMXBean

Returns the number of messages successfully sent to the stream in the last batch.

getMessagesSentLastBatch() - Method in interface com.kdgregory.logging.aws.sns.SNSWriterStatisticsMXBean

Returns the number of messages successfully sent to the logstream in the last batch.

getOperation() - Method in exception com.kdgregory.logging.common.util.RetryManager2.TimeoutException

Returns the name of the operation that timed out.

getOversizeMessages() - Method in interface com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatisticsMXBean

Returns the number of messages that were either dropped or truncated because they were too large for the service to accept.

getOversizeMessages() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

getOversizeMessages() - Method in interface com.kdgregory.logging.aws.kinesis.KinesisWriterStatisticsMXBean

Returns the number of messages that were either dropped or truncated because they were too large for the service to accept.

getOversizeMessages() - Method in interface com.kdgregory.logging.aws.sns.SNSWriterStatisticsMXBean

Returns the number of messages that were either dropped or truncated because they were too large for the service to accept.

getPartitionKey() - Method in class com.kdgregory.logging.aws.kinesis.KinesisWriterConfig

getPartitionKeyHelper() - Method in class com.kdgregory.logging.aws.kinesis.KinesisWriterConfig

Returns the object that manages partition keys; use this rather than directly accessing the key.

getReason() - Method in exception com.kdgregory.logging.aws.facade.CloudWatchFacadeException

Returns a code that can be used by the application to dispatch exception handling.

getReason() - Method in exception com.kdgregory.logging.aws.facade.KinesisFacadeException

Returns a code that can be used by the application to dispatch exception handling.

getReason() - Method in exception com.kdgregory.logging.aws.facade.SNSFacadeException

Returns a code that can be used by the application to dispatch exception handling.

getRetentionPeriod() - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterConfig

getRetentionPeriod() - Method in class com.kdgregory.logging.aws.kinesis.KinesisWriterConfig

getShardCount() - Method in class com.kdgregory.logging.aws.kinesis.KinesisWriterConfig

getStreamName() - Method in class com.kdgregory.logging.aws.kinesis.KinesisWriterConfig

getSubject() - Method in class com.kdgregory.logging.aws.sns.SNSWriterConfig

getSynchronousMode() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

getThrottledWrites() - Method in interface com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatisticsMXBean

Returns the number of batches that were retried due to throttling.

getThrottledWrites() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

getThrottledWrites() - Method in interface com.kdgregory.logging.aws.kinesis.KinesisWriterStatisticsMXBean

Returns the number of batches that were retried due to throttling.

getTimestamp() - Method in class com.kdgregory.logging.common.LogMessage

Returns the timestamp.

getTopicArn() - Method in class com.kdgregory.logging.aws.sns.SNSWriterConfig

getTopicName() - Method in class com.kdgregory.logging.aws.sns.SNSWriterConfig

getTruncateOversizeMessages() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

getUnrecoveredWriterRaceRetries() - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatistics

getUnrecoveredWriterRaceRetries() - Method in interface com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatisticsMXBean

Returns the times that the writer had to requeue a batch after receiving and repeated InvalidSequenceTokenException errors.

getUseShutdownHook() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

getValue() - Method in class com.kdgregory.logging.aws.kinesis.PartitionKeyHelper

Returns the next partition key, either literal or generated.

getWriterRaceRetries() - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatistics

getWriterRaceRetries() - Method in interface com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatisticsMXBean

Returns the number of retries due to InvalidSequenceTokenException response from PutLogEvents.

I

incrementOversizeMessages() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

incrementThrottledWrites() - Method in class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

InfoFacade - Interface in com.kdgregory.logging.aws.facade

A facade for various operations that retrieve information about the AWS environment.

initialize() - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

Called before the main loop, to ensure that the writer is able to perform its job.

InternalLogger - Interface in com.kdgregory.logging.common.util

The appender is expected to provide the writer with an instance of this interface, used for logging status and error messages.

invoke(String, Object[], String[]) - Method in class com.kdgregory.logging.aws.internal.AbstractMarkerBean

invoke(Supplier<T>) - Method in class com.kdgregory.logging.common.util.RetryManager

Deprecated.

Invokes the passed function.

invoke(Supplier<T>, Consumer<RuntimeException>) - Method in class com.kdgregory.logging.common.util.RetryManager

Deprecated.

Invokes the passed function.

invoke(Instant, Supplier<T>, Consumer<RuntimeException>) - Method in class com.kdgregory.logging.common.util.RetryManager2

Invokes the passed function, passing any exceptions to the provided handler.

invoke(Instant, Supplier<T>) - Method in class com.kdgregory.logging.common.util.RetryManager2

Invokes the passed function, propagating exceptions.

invoke(Duration, Supplier<T>, Consumer<RuntimeException>) - Method in class com.kdgregory.logging.common.util.RetryManager2

Invokes the passed function, passing any exceptions to the provided handler.

invoke(Duration, Supplier<T>) - Method in class com.kdgregory.logging.common.util.RetryManager2

Invokes the passed function, propagating exceptions.

isEmpty() - Method in class com.kdgregory.logging.common.util.MessageQueue

Determines whether the queue is empty.

isGenerated() - Method in class com.kdgregory.logging.aws.kinesis.PartitionKeyHelper

Indicates whether the partition keys are literal or generated.

isRetryable() - Method in exception com.kdgregory.logging.aws.facade.FacadeException

Returns an indication of whether the caller should retry the operation that threw this exception.

isRunning() - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

Returns whether or not the writer is currently running.

isSynchronous() - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

isSynchronous() - Method in interface com.kdgregory.logging.common.LogWriter

Returns a flag to indicate whether the writer is operating in synchrnous mode.

J

JsonConverter - Class in com.kdgregory.logging.common.internal

Yet another JSON serializer; this exists to avoid external dependencies.

JsonConverter() - Constructor for class com.kdgregory.logging.common.internal.JsonConverter

K

keepRunning() - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

A check for whether we should keep running: either we haven't been shut down or there's still messages to process

KinesisConstants - Class in com.kdgregory.logging.aws.kinesis

Holds limits and other constants for Kinesis Streams.

KinesisConstants() - Constructor for class com.kdgregory.logging.aws.kinesis.KinesisConstants

KinesisConstants.StreamStatus - Enum in com.kdgregory.logging.aws.kinesis

An SDK-independent enumeration of stream status codes as returned by DescribeStream, with the addition of a status indicating that the stream does not exist.

KinesisFacade - Interface in com.kdgregory.logging.aws.facade

Exposes the CloudWatch Logs APIs used by KinesisLogWriter.

KinesisFacadeException - Exception in com.kdgregory.logging.aws.facade

This exception is thown by KinesisFacade for any situation that requires intervention by the caller.

KinesisFacadeException(String, Throwable, KinesisFacadeException.ReasonCode, boolean, String, Object...) - Constructor for exception com.kdgregory.logging.aws.facade.KinesisFacadeException

Base constructor.

KinesisFacadeException(String, KinesisFacadeException.ReasonCode, boolean, String, Object...) - Constructor for exception com.kdgregory.logging.aws.facade.KinesisFacadeException

Convenience constructor, for conditions where there is no underlying exception, or where it's irrelevant.

KinesisFacadeException(KinesisFacadeException.ReasonCode, boolean, Throwable) - Constructor for exception com.kdgregory.logging.aws.facade.KinesisFacadeException

Convenience constructor, for conditions where there is no underlying exception, or where it's irrelevant.

KinesisFacadeException.ReasonCode - Enum in com.kdgregory.logging.aws.facade

KinesisLogWriter - Class in com.kdgregory.logging.aws.kinesis

Writes log messages to a Kinesis stream.

KinesisLogWriter(KinesisWriterConfig, KinesisWriterStatistics, InternalLogger, KinesisFacade) - Constructor for class com.kdgregory.logging.aws.kinesis.KinesisLogWriter

KinesisWriterConfig - Class in com.kdgregory.logging.aws.kinesis

Configuration for KinesisLogWriter.

KinesisWriterConfig() - Constructor for class com.kdgregory.logging.aws.kinesis.KinesisWriterConfig

KinesisWriterFactory - Class in com.kdgregory.logging.aws.kinesis

Factory to create KinesisLogWriter instances.

KinesisWriterFactory() - Constructor for class com.kdgregory.logging.aws.kinesis.KinesisWriterFactory

KinesisWriterStatistics - Class in com.kdgregory.logging.aws.kinesis

Statistics specific to KinesisLogWriter.

KinesisWriterStatistics() - Constructor for class com.kdgregory.logging.aws.kinesis.KinesisWriterStatistics

KinesisWriterStatisticsMXBean - Interface in com.kdgregory.logging.aws.kinesis

Defines the JMX Bean interface for KinesisWriterStatistics.

L

loadClass(String) - Static method in class com.kdgregory.logging.common.internal.Utils

Attempts to load a class, returning null if it doesn't exist.

logger - Variable in class com.kdgregory.logging.aws.internal.AbstractJMXManager

logger - Variable in class com.kdgregory.logging.aws.internal.AbstractLogWriter

LogMessage - Class in com.kdgregory.logging.common

Holder for an in-queue logging message.

LogMessage(long, String) - Constructor for class com.kdgregory.logging.common.LogMessage

Constructs an instance from a simple string.

LogWriter - Interface in com.kdgregory.logging.common

Defines the contract between appenders and writers.

lookup(String) - Static method in enum com.kdgregory.logging.common.util.MessageQueue.DiscardAction

lookupTopic() - Method in interface com.kdgregory.logging.aws.facade.SNSFacade

Attempts to match the configured topic ARN or name to an existing SNS topic in the configured account and region.

M

MAX_BATCH_BYTES - Static variable in class com.kdgregory.logging.aws.cloudwatch.CloudWatchConstants

Maximum number of bytes in a single batch.

MAX_BATCH_BYTES - Static variable in class com.kdgregory.logging.aws.kinesis.KinesisConstants

Maximum number of bytes in a batch.

MAX_BATCH_COUNT - Static variable in class com.kdgregory.logging.aws.cloudwatch.CloudWatchConstants

Maximum number of messages in a single batch.

MAX_BATCH_COUNT - Static variable in class com.kdgregory.logging.aws.kinesis.KinesisConstants

Maximum number of messages in a single batch.

MAX_MESSAGE_BYTES - Static variable in class com.kdgregory.logging.aws.kinesis.KinesisConstants

Maximum number of bytes in a for a single message.

MAX_MESSAGE_BYTES - Static variable in class com.kdgregory.logging.aws.sns.SNSConstants

Maximum number of bytes in a for a single message.

MAX_MESSAGE_SIZE - Static variable in class com.kdgregory.logging.aws.cloudwatch.CloudWatchConstants

The maximum number of bytes in a single message, after conversion to UTF-8.

MAXIMUM_RETENTION_PERIOD - Static variable in class com.kdgregory.logging.aws.kinesis.KinesisConstants

Maximum number of hours for retention period.

maxMessageSize() - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchLogWriter

maxMessageSize() - Method in class com.kdgregory.logging.aws.kinesis.KinesisLogWriter

maxMessageSize() - Method in class com.kdgregory.logging.aws.sns.SNSLogWriter

maxMessageSize() - Method in interface com.kdgregory.logging.common.LogWriter

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

MESSAGE_OVERHEAD - Static variable in class com.kdgregory.logging.aws.cloudwatch.CloudWatchConstants

Overhead added to each message in a batch.

MessageQueue - Class in com.kdgregory.logging.common.util

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.logging.common.util.MessageQueue

MessageQueue.DiscardAction - Enum in com.kdgregory.logging.common.util

Controls how messages are discarded once the threshold is reached.

MINIMUM_RETENTION_PERIOD - Static variable in class com.kdgregory.logging.aws.kinesis.KinesisConstants

Minimum number of hours for retention period.

myName - Variable in class com.kdgregory.logging.aws.internal.AbstractMarkerBean

myServer - Variable in class com.kdgregory.logging.aws.internal.AbstractMarkerBean

N

newLogWriter(CloudWatchWriterConfig, CloudWatchWriterStatistics, InternalLogger) - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterFactory

newLogWriter(KinesisWriterConfig, KinesisWriterStatistics, InternalLogger) - Method in class com.kdgregory.logging.aws.kinesis.KinesisWriterFactory

newLogWriter(SNSWriterConfig, SNSWriterStatistics, InternalLogger) - Method in class com.kdgregory.logging.aws.sns.SNSWriterFactory

newLogWriter(C, S, InternalLogger) - Method in interface com.kdgregory.logging.common.util.WriterFactory

O

onDeregister(MBeanServer, ObjectName) - Method in class com.kdgregory.logging.aws.internal.AbstractMarkerBean

Called when the marker bean has been deregistered from a server.

onRegister(MBeanServer, ObjectName) - Method in class com.kdgregory.logging.aws.internal.AbstractMarkerBean

Called when registration is complete, to allow the subclass to register with the JMXManager.

P

PartitionKeyHelper - Class in com.kdgregory.logging.aws.kinesis

Responsible for returning either a configured literal partition key or generating a random key.

PartitionKeyHelper(String) - Constructor for class com.kdgregory.logging.aws.kinesis.PartitionKeyHelper

perform(String) - Method in class com.kdgregory.logging.aws.common.Substitutions

Applies all substitutions.

postCreateRetry - Variable in class com.kdgregory.logging.aws.kinesis.KinesisLogWriter

postDeregister() - Method in class com.kdgregory.logging.aws.internal.AbstractMarkerBean

postRegister(Boolean) - Method in class com.kdgregory.logging.aws.internal.AbstractMarkerBean

preDeregister() - Method in class com.kdgregory.logging.aws.internal.AbstractMarkerBean

preRegister(MBeanServer, ObjectName) - Method in class com.kdgregory.logging.aws.internal.AbstractMarkerBean

processBatch(long) - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

Called from the main loop to build a batch of messages and send them.

publish(LogMessage) - Method in interface com.kdgregory.logging.aws.facade.SNSFacade

Attempts to publish the provided message, using configured topic and subject.

putEvents(String, List<LogMessage>) - Method in interface com.kdgregory.logging.aws.facade.CloudWatchFacade

Attempts to send a batch of messages.

putRecords(List<LogMessage>) - Method in interface com.kdgregory.logging.aws.facade.KinesisFacade

Attempts to send records to the stream.

Q

queueSize() - Method in class com.kdgregory.logging.common.util.MessageQueue

Returns the current number of elements in the queue, as recorded by the queue itself.

R

RANDOM_PARTITION_KEY_CONFIG - Static variable in class com.kdgregory.logging.aws.kinesis.KinesisLogWriter

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

registerAppenderBean(String, MBeanServer) - Method in class com.kdgregory.logging.aws.internal.AbstractJMXManager

Registers an appender's stats bean with a server.

registrationNames - Variable in class com.kdgregory.logging.aws.internal.AbstractJMXManager

registrations - Variable in class com.kdgregory.logging.aws.internal.AbstractJMXManager

removeMarkerBean(Object) - Method in class com.kdgregory.logging.aws.internal.AbstractJMXManager

Will deregister a StatisticsMBean instance from all known servers.

removeStatsBean(String) - Method in class com.kdgregory.logging.aws.internal.AbstractJMXManager

Removes information about a stats bean from the internal tables and deregisters it from any MBeanServers.

reportError(String, Throwable) - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

Reports an operational error to both the internal logger and the stats bean.

requeue(LogMessage) - Method in class com.kdgregory.logging.common.util.MessageQueue

Adds a message to the start of the queue.

retrieveAccountId() - Method in interface com.kdgregory.logging.aws.facade.InfoFacade

Retrieves the current AWS account ID, "unknown" if unable to determine the account ID for any reason.

retrieveDefaultRegion() - Method in interface com.kdgregory.logging.aws.facade.InfoFacade

Retrieves the current configured region, using the default region provider.

retrieveEC2InstanceId() - Method in interface com.kdgregory.logging.aws.facade.InfoFacade

Returns the current instance ID, using the EC2 metadata service.

retrieveEC2Region() - Method in interface com.kdgregory.logging.aws.facade.InfoFacade

Returns the instance where the logger is running, using the EC2 metadata service.

retrieveEC2Tags(String) - Method in interface com.kdgregory.logging.aws.facade.InfoFacade

Returns all tags for the specified EC2 instance.

retrieveParameter(String) - Method in interface com.kdgregory.logging.aws.facade.InfoFacade

Retrieves a named Systems Manager parameter, null if it doesnt' exist or is a secure string.

retrieveSequenceToken() - Method in interface com.kdgregory.logging.aws.facade.CloudWatchFacade

If the configured stream exists, returns the sequence token needed to write to it.

retrieveStreamStatus() - Method in interface com.kdgregory.logging.aws.facade.KinesisFacade

Returns the current status of the stream, null if the status cannot be determined due to a retryable condition.

RetryManager - Class in com.kdgregory.logging.common.util

Deprecated.

use

RetryManager(long, long, boolean) - Constructor for class com.kdgregory.logging.common.util.RetryManager

Deprecated.

Constructor for those who like to specify times in milliseconds.

RetryManager(Duration, Duration, boolean) - Constructor for class com.kdgregory.logging.common.util.RetryManager

Deprecated.

Constructor for those preferring Java8 durations.

RetryManager2 - Class in com.kdgregory.logging.common.util

Invokes a function, retrying with a delay until specified time, with optional exponential (2x) backoff.

RetryManager2(String, Duration, boolean, boolean) - Constructor for class com.kdgregory.logging.common.util.RetryManager2

Base constructor.

RetryManager2(String, Duration) - Constructor for class com.kdgregory.logging.common.util.RetryManager2

Convenience constructor: uses exponential backoff and throws on timeout.

RetryManager2.TimeoutException - Exception in com.kdgregory.logging.common.util

This exception is thrown by the RetryManager on timeout.

run() - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

S

sendBatch(List<LogMessage>) - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchLogWriter

sendBatch(List<LogMessage>) - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

Sends a batch of messages.

sendBatch(List<LogMessage>) - Method in class com.kdgregory.logging.aws.kinesis.KinesisLogWriter

sendBatch(List<LogMessage>) - Method in class com.kdgregory.logging.aws.sns.SNSLogWriter

sendRetry - Variable in class com.kdgregory.logging.aws.cloudwatch.CloudWatchLogWriter

sendRetry - Variable in class com.kdgregory.logging.aws.kinesis.KinesisLogWriter

sendTimeout - Variable in class com.kdgregory.logging.aws.cloudwatch.CloudWatchLogWriter

sendTimeout - Variable in class com.kdgregory.logging.aws.kinesis.KinesisLogWriter

setActualLogGroupName(String) - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatistics

setActualLogStreamName(String) - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatistics

setActualStreamName(String) - Method in class com.kdgregory.logging.aws.kinesis.KinesisWriterStatistics

setActualSubject(String) - Method in class com.kdgregory.logging.aws.sns.SNSWriterStatistics

setActualTopicArn(String) - Method in class com.kdgregory.logging.aws.sns.SNSWriterStatistics

setActualTopicName(String) - Method in class com.kdgregory.logging.aws.sns.SNSWriterStatistics

setAssumedRole(String) - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

setAttribute(Attribute) - Method in class com.kdgregory.logging.aws.internal.AbstractMarkerBean

setAttributes(AttributeList) - Method in class com.kdgregory.logging.aws.internal.AbstractMarkerBean

setAutoCreate(boolean) - Method in class com.kdgregory.logging.aws.kinesis.KinesisWriterConfig

setAutoCreate(boolean) - Method in class com.kdgregory.logging.aws.sns.SNSWriterConfig

setBatchDelay(long) - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

setBatchDelay(long) - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

setBatchDelay(long) - Method in class com.kdgregory.logging.aws.sns.SNSWriterConfig

setBatchDelay(long) - Method in interface com.kdgregory.logging.common.LogWriter

Sets the batch delay for the writer.

setClientEndpoint(String) - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

setClientFactoryMethod(String) - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

setClientRegion(String) - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

setDedicatedWriter(boolean) - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterConfig

setDiscardAction(MessageQueue.DiscardAction) - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

setDiscardAction(MessageQueue.DiscardAction) - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

setDiscardAction(MessageQueue.DiscardAction) - Method in interface com.kdgregory.logging.common.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.logging.common.util.MessageQueue

Changes the discard action

setDiscardThreshold(int) - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

setDiscardThreshold(int) - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

setDiscardThreshold(int) - Method in interface com.kdgregory.logging.common.LogWriter

Updates the writer's discard threshold: the maximum number of message stored in its queue.

setDiscardThreshold(int) - Method in class com.kdgregory.logging.common.util.MessageQueue

Changes the discard threshold.

setEnableBatchLogging(boolean) - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

setInitializationTimeout(long) - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

setLastBatchSize(int) - Method in class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

setLastError(String, Throwable) - Method in class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

Sets the last error.

setLogGroupName(String) - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterConfig

setLogGroupRetention() - Method in interface com.kdgregory.logging.aws.facade.CloudWatchFacade

Sets the retention period on the configured log group.

setLogStreamName(String) - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterConfig

setMessageQueue(MessageQueue) - Method in class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

Stores the current writer's message queue.

setMessagesRequeuedLastBatch(int) - Method in class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

setMessagesSentLastBatch(int) - Method in class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

setPartitionKey(String) - Method in class com.kdgregory.logging.aws.kinesis.KinesisWriterConfig

setRetentionPeriod(Integer) - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterConfig

setRetentionPeriod() - Method in interface com.kdgregory.logging.aws.facade.KinesisFacade

Sets the stream's retention period, iff configuration specifies a non-null period.

setRetentionPeriod(Integer) - Method in class com.kdgregory.logging.aws.kinesis.KinesisWriterConfig

setShardCount(int) - Method in class com.kdgregory.logging.aws.kinesis.KinesisWriterConfig

setStreamName(String) - Method in class com.kdgregory.logging.aws.kinesis.KinesisWriterConfig

setSubject(String) - Method in class com.kdgregory.logging.aws.sns.SNSWriterConfig

setSynchronousMode(boolean) - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

setTopicArn(String) - Method in class com.kdgregory.logging.aws.sns.SNSWriterConfig

setTopicName(String) - Method in class com.kdgregory.logging.aws.sns.SNSWriterConfig

setTruncateOversizeMessages(boolean) - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

setUseShutdownHook(boolean) - Method in class com.kdgregory.logging.aws.internal.AbstractWriterConfig

shutdown() - Method in interface com.kdgregory.logging.aws.facade.CloudWatchFacade

Shuts down the underlying client.

shutdown() - Method in interface com.kdgregory.logging.aws.facade.KinesisFacade

Shuts down the underlying client.

shutdown() - Method in interface com.kdgregory.logging.aws.facade.SNSFacade

Shuts down the underlying client.

size() - Method in class com.kdgregory.logging.common.LogMessage

Returns the size of the UTF-8 representation.

size() - Method in class com.kdgregory.logging.common.util.MessageQueue

Returns the current number of elements in the queue, as recorded by the atomic counter.

sleepQuietly(long) - Static method in class com.kdgregory.logging.common.internal.Utils

Sleeps until the specified time elapses or the thread is interrupted.

sleepQuietly(long) - Static method in class com.kdgregory.logging.common.util.RetryManager

Deprecated.

Sleeps for the specified duration (in milliseconds).

sleepQuietly(long) - Static method in class com.kdgregory.logging.common.util.RetryManager2

Sleeps for the specified duration (in milliseconds).

SNSConstants - Class in com.kdgregory.logging.aws.sns

Holds limits and other constants for SNS.

SNSConstants() - Constructor for class com.kdgregory.logging.aws.sns.SNSConstants

SNSFacade - Interface in com.kdgregory.logging.aws.facade

Exposes the CloudWatch Logs APIs used by SNShLogWriter.

SNSFacadeException - Exception in com.kdgregory.logging.aws.facade

This exception is thown by SNSFacade for any situation that requires intervention by the caller.

SNSFacadeException(String, Throwable, SNSFacadeException.ReasonCode, boolean, String, Object...) - Constructor for exception com.kdgregory.logging.aws.facade.SNSFacadeException

Base constructor.

SNSFacadeException(String, SNSFacadeException.ReasonCode, boolean, String, Object...) - Constructor for exception com.kdgregory.logging.aws.facade.SNSFacadeException

Convenience constructor, for conditions where there is no underlying exception, or where it's irrelevant.

SNSFacadeException(SNSFacadeException.ReasonCode, boolean, Throwable) - Constructor for exception com.kdgregory.logging.aws.facade.SNSFacadeException

Convenience constructor for testing.

SNSFacadeException.ReasonCode - Enum in com.kdgregory.logging.aws.facade

SNSLogWriter - Class in com.kdgregory.logging.aws.sns

Writes log messages to an SNS topic.

SNSLogWriter(SNSWriterConfig, SNSWriterStatistics, InternalLogger, SNSFacade) - Constructor for class com.kdgregory.logging.aws.sns.SNSLogWriter

SNSWriterConfig - Class in com.kdgregory.logging.aws.sns

Configuration for SNSLogWriter.

SNSWriterConfig() - Constructor for class com.kdgregory.logging.aws.sns.SNSWriterConfig

SNSWriterFactory - Class in com.kdgregory.logging.aws.sns

Factory to create SNSLogWriter instances.

SNSWriterFactory() - Constructor for class com.kdgregory.logging.aws.sns.SNSWriterFactory

SNSWriterStatistics - Class in com.kdgregory.logging.aws.sns

Statistics specific to SNSLogWriter.

SNSWriterStatistics() - Constructor for class com.kdgregory.logging.aws.sns.SNSWriterStatistics

SNSWriterStatisticsMXBean - Interface in com.kdgregory.logging.aws.sns

Defines the JMX Bean interface for SNSWriterStatistics.

startWriterThread(LogWriter, Thread.UncaughtExceptionHandler) - Method in class com.kdgregory.logging.common.util.DefaultThreadFactory

startWriterThread(LogWriter, Thread.UncaughtExceptionHandler) - Method in interface com.kdgregory.logging.common.util.ThreadFactory

stats - Variable in class com.kdgregory.logging.aws.internal.AbstractLogWriter

statsBeans - Variable in class com.kdgregory.logging.aws.internal.AbstractJMXManager

statsBeanTypes - Variable in class com.kdgregory.logging.aws.internal.AbstractJMXManager

stop() - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

stop() - Method in interface com.kdgregory.logging.common.LogWriter

Signals the writer that it will no longer receive batches.

stopAWSClient() - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchLogWriter

stopAWSClient() - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

This is called when the logwriter is stopped, to explicitly close the AWS service client.

stopAWSClient() - Method in class com.kdgregory.logging.aws.kinesis.KinesisLogWriter

stopAWSClient() - Method in class com.kdgregory.logging.aws.sns.SNSLogWriter

Substitutions - Class in com.kdgregory.logging.aws.common

Performs substitutions.

Substitutions(Date, int, InfoFacade) - Constructor for class com.kdgregory.logging.aws.common.Substitutions

Base constructor, which allows configuration of the InfoFacade instance.

Substitutions(Date, int) - Constructor for class com.kdgregory.logging.aws.common.Substitutions

Standard constructor, which retrieves an InfoFacade if and when it is needed.

T

ThreadFactory - Interface in com.kdgregory.logging.common.util

Creates and starts a new thread for running the LogWriter.

TimeoutException(String, Instant, Instant) - Constructor for exception com.kdgregory.logging.common.util.RetryManager2.TimeoutException

toList() - Method in class com.kdgregory.logging.common.util.MessageQueue

Copies the current queue contents into a List.

TOPIC_ARN_REGEX - Static variable in class com.kdgregory.logging.aws.sns.SNSConstants

Validation regex for a topic ARN.

TOPIC_NAME_REGEX - Static variable in class com.kdgregory.logging.aws.sns.SNSConstants

Validation regex for a topic name.

truncate(int) - Method in class com.kdgregory.logging.common.LogMessage

Ensures that the message has no more than the specified number of bytes, truncating if necessary.

U

unregisterAppenderBean(String, MBeanServer) - Method in class com.kdgregory.logging.aws.internal.AbstractJMXManager

Deregisters an appender's stats bean from a server.

updateMessagesSent(int) - Method in class com.kdgregory.logging.aws.internal.AbstractWriterStatistics

Updates the number of messages sent with the given count.

updateUnrecoveredWriterRaceRetries() - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatistics

updateWriterRaceRetries() - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterStatistics

Utils - Class in com.kdgregory.logging.common.internal

Various static utility functions.

Utils() - Constructor for class com.kdgregory.logging.common.internal.Utils

V

validate() - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchWriterConfig

Validates the configuration, returning a list of any validation errors.

validate() - Method in class com.kdgregory.logging.aws.kinesis.KinesisWriterConfig

Validates the configuration, returning a list of any validation errors.

validate() - Method in class com.kdgregory.logging.aws.sns.SNSWriterConfig

Validates the configuration, returning a list of any validation errors.

validateRetentionPeriod(Integer) - Static method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchConstants

Validates proposed retention period, throwing if invalid.

valueOf(String) - Static method in enum com.kdgregory.logging.aws.facade.CloudWatchFacadeException.ReasonCode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.kdgregory.logging.aws.facade.KinesisFacadeException.ReasonCode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.kdgregory.logging.aws.facade.SNSFacadeException.ReasonCode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.kdgregory.logging.aws.kinesis.KinesisConstants.StreamStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.kdgregory.logging.common.util.MessageQueue.DiscardAction

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.kdgregory.logging.aws.facade.CloudWatchFacadeException.ReasonCode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.kdgregory.logging.aws.facade.KinesisFacadeException.ReasonCode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.kdgregory.logging.aws.facade.SNSFacadeException.ReasonCode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.kdgregory.logging.aws.kinesis.KinesisConstants.StreamStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.kdgregory.logging.common.util.MessageQueue.DiscardAction

Returns an array containing the constants of this enum type, in the order they are declared.

W

waitUntilInitialized(long) - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

waitUntilInitialized(long) - Method in interface com.kdgregory.logging.common.LogWriter

Waits up to the specified amount of time for the writer to initialize.

waitUntilStopped(long) - Method in class com.kdgregory.logging.aws.internal.AbstractLogWriter

waitUntilStopped(long) - Method in interface com.kdgregory.logging.common.LogWriter

Waits until the writer thread has stopped, the timeout has expired, or the calling thread is interrupted.

warn(String) - Method in interface com.kdgregory.logging.common.util.InternalLogger

Called to log warning messages.

withinServiceLimits(int, int) - Method in class com.kdgregory.logging.aws.cloudwatch.CloudWatchLogWriter

withinServiceLimits(int, int) - Method in class com.kdgregory.logging.aws.internal.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.logging.aws.kinesis.KinesisLogWriter

withinServiceLimits(int, int) - Method in class com.kdgregory.logging.aws.sns.SNSLogWriter

WriterFactory<C,S> - Interface in com.kdgregory.logging.common.util

Defines a function to create a LogWriter.

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