org.iota.jota.utils.log.interval

Class IntervalLogger

java.lang.Object

org.iota.jota.utils.log.interval.IntervalLogger

All Implemented Interfaces:

Logger

public class IntervalLogger
extends Object
implements Logger

This class represents a wrapper for the Logger used by IRI that implements a logic to rate limits the output on the console. Instead of printing all messages immediately and unnecessarily spamming the console, it only prints messages every few seconds and if the message has changed since the last output.

Constructor Summary

Constructors

Constructor and Description
IntervalLogger(Class<?> clazz) Does the same as IntervalLogger(Class, int) but defaults to the DEFAULT_LOG_INTERVAL for the interval.
IntervalLogger(Class<?> clazz, int logInterval) Does the same as IntervalLogger(org.slf4j.Logger, int) but creates a new logback logger for the given class.
IntervalLogger(org.slf4j.Logger delegate) Does the same as IntervalLogger(org.slf4j.Logger, int) but defaults to the DEFAULT_LOG_INTERVAL for the interval.
IntervalLogger(org.slf4j.Logger delegate, int logInterval) Creates a Logger for the given class that prints messages only every logInterval milliseconds.

Method Summary

Modifier and Type	Method and Description
IntervalLogger	debug(String message) This method allows us to set a new debug message that shall get printed to the screen.
org.slf4j.Logger	delegate() This method returns the underlying logback Logger. It can be used to issue log entries directly to the underlying logger without interfering with the logic of this class.
IntervalLogger	error(String message) This method allows us to set a new error message that shall get printed to the screen.
IntervalLogger	error(String message, Throwable cause) This method allows us to set a new error message that shall get printed to the screen.
boolean	getEnabled() This method is the getter for the enabled flag of the logger.
IntervalLogger	info(String message) This method allows us to set a new info message that shall get printed to the screen.
IntervalLogger	setEnabled(boolean enabled) This method is the setter for the enabled flag of the logger.
void	triggerOutput() Does the same as triggerOutput(boolean) but defaults to letting the logger decide when to print the message.
void	triggerOutput(boolean printImmediately) Triggers the output of the last received message.

Methods inherited from class java.lang.Object

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

Constructor Detail

IntervalLogger

public IntervalLogger(Class<?> clazz)

Does the same as IntervalLogger(Class, int) but defaults to the DEFAULT_LOG_INTERVAL for the interval.

Parameters:

clazz - class that is used to identify the origin of the log messages

IntervalLogger

public IntervalLogger(org.slf4j.Logger delegate)

Does the same as IntervalLogger(org.slf4j.Logger, int) but defaults to the DEFAULT_LOG_INTERVAL for the interval.

Parameters:

delegate - logback logger for issuing the messages

IntervalLogger

public IntervalLogger(Class<?> clazz,
                      int logInterval)

Does the same as IntervalLogger(org.slf4j.Logger, int) but creates a new logback logger for the given class.

Parameters:

clazz - class that is used to identify the origin of the log messages

logInterval - time in milliseconds between log messages

IntervalLogger

public IntervalLogger(org.slf4j.Logger delegate,
                      int logInterval)

Creates a Logger for the given class that prints messages only every logInterval milliseconds. It simply stores the passed in parameters in its private properties to be able to access them later on.

Parameters:

delegate - logback logger for issuing the messages

logInterval - time in milliseconds between log messages

Method Detail

delegate

public org.slf4j.Logger delegate()

This method returns the underlying logback Logger.

It can be used to issue log entries directly to the underlying logger without interfering with the logic of this class.

Returns:

the underlying logback Logger

info

public IntervalLogger info(String message)

This method allows us to set a new info message that shall get printed to the screen. It checks if the given message is new and then triggers the output.

Specified by:

info in interface Logger

Parameters:

message - info message that shall get printed

Returns:

the logger itself to allow the chaining of calls

debug

public IntervalLogger debug(String message)

This method allows us to set a new debug message that shall get printed to the screen. It checks if the given message is new and then triggers the output.

Specified by:

debug in interface Logger

Parameters:

message - debug message that shall get printed

Returns:

the logger itself to allow the chaining of calls

error

public IntervalLogger error(String message)

This method allows us to set a new error message that shall get printed to the screen. It checks if the given message is new and then triggers the output. Error messages will always get dumped immediately instead of scheduling their output. Since error messages are usually a sign of some misbehaviour of the node we want to be able to see them when they appear (to be able to track down bugs more easily).

Specified by:

error in interface Logger

Parameters:

message - debug message that shall get printed

Returns:

the logger itself to allow the chaining of calls

error

public IntervalLogger error(String message,
                            Throwable cause)

This method allows us to set a new error message that shall get printed to the screen. It checks if the given message is new and then triggers the output. Error messages will always get dumped immediately instead of scheduling their output. Since error messages are usually a sign of some misbehaviour of the node we want to be able to see them when they appear (to be able to track down bugs more easily).

Specified by:

error in interface Logger

Parameters:

message - debug message that shall get printed

cause - exception object that caused the error to happen (will be printed with the complete stacktrace)

getEnabled

public boolean getEnabled()

This method is the getter for the enabled flag of the logger. If the logger is disabled it will simply omit showing log messages.

Specified by:

getEnabled in interface Logger

Returns:

true if the logger shall output messages and false otherwise (the logger is enabled by default)

setEnabled

public IntervalLogger setEnabled(boolean enabled)

This method is the setter for the enabled flag of the logger. If the logger is disabled it will simply omit showing log messages.

Specified by:

setEnabled in interface Logger

Parameters:

enabled - true if the logger shall output messages and false otherwise (the logger is enabled by default)

Returns:

the logger itself to allow the chaining of calls

triggerOutput

public void triggerOutput()

Does the same as triggerOutput(boolean) but defaults to letting the logger decide when to print the message.

triggerOutput

public void triggerOutput(boolean printImmediately)

Triggers the output of the last received message. It either prints the message immediately (if enough time has passed since the last output or requested by the caller) or schedules it for the next interval.

Parameters:

printImmediately - flag indicating if the messages should be scheduled or printed immediately