com.sleepycat.je.utilint

Class RateLimitingLogger<T>

java.lang.Object

com.sleepycat.je.utilint.RateLimitingLogger<T>

Type Parameters:

T - the type of the object associated with the log message.

public class RateLimitingLogger<T>
extends Object

A simple logger used to limit the rate at which messages related to a specific object are logged to at most once within the configured time period. The effect of the rate limited logging is to sample log messages associated with the object. This type of logging is suitable for informational messages about the state of some entity that may persist over some extended period of time, e.g. a repeated problem communicating with a specific node, where the nature of the problem may change over time.

Constructor Summary

Constructors

Constructor and Description
RateLimitingLogger(int logSamplePeriodMs, int maxObjects, Logger logger) Constructs a configured RateLimitingLoggerInstance.

Method Summary

Modifier and Type	Method and Description
Logger	getInternalLogger()
long	getLimitedMessageCount()
void	log(T object, Level level, String string) Logs the message, if one has not already been logged for the object in the current time interval.

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimitingLogger

public RateLimitingLogger(int logSamplePeriodMs,
                          int maxObjects,
                          Logger logger)

Constructs a configured RateLimitingLoggerInstance.

Parameters:

logSamplePeriodMs - used to compute the max rate of 1 message/logSamplePeriodMs

maxObjects - the max number of MRU objects to track

logger - the rate limited messages are written to this logger

Method Detail

getLimitedMessageCount

public long getLimitedMessageCount()

log

public void log(T object,
                Level level,
                String string)

Logs the message, if one has not already been logged for the object in the current time interval.

Parameters:

object - the object associated with the log message

level - the level to be used for logging

string - the log message string

getInternalLogger

public Logger getInternalLogger()