com.google.common.flogger.backend.system

Class EmptyLoggingContext

java.lang.Object

com.google.common.flogger.backend.system.LoggingContext

com.google.common.flogger.backend.system.EmptyLoggingContext

public final class EmptyLoggingContext
extends LoggingContext

Empty trace context implementation.

See class documentation in LoggingContext for important implementation restrictions.

Method Summary

Modifier and Type	Method and Description
static LoggingContext	getInstance()
com.google.common.flogger.backend.Tags	getTags() Returns a set of tags to be added to a log statement.
boolean	shouldForceLogging(java.lang.String loggerName, java.util.logging.Level level, boolean isEnabled) Returns whether the given logger should have logging forced at the specified level.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static LoggingContext getInstance()

shouldForceLogging

public boolean shouldForceLogging(java.lang.String loggerName,
                                  java.util.logging.Level level,
                                  boolean isEnabled)

Description copied from class: LoggingContext

Returns whether the given logger should have logging forced at the specified level. When logging is forced for a log statement it will be emitted regardless or the normal log level configuration of the logger and ignoring any rate limiting or other filtering.

A default implementation of this method should simply return false.

loggerName can be used to look up specific configuration, such as log level, for the logger, to decide if a log statement should be forced. This information might vary depending on the context in which this call is made, so the result should not be cached.

isEnabledByLevel indicates that the log statement is enabled according to its log level, but a true value does not necessarily indicate that logging will occur, due to rate limiting or other conditional logging mechanisms. To bypass conditional logging and ensure that an enabled log statement will be emitted, this method should return true if isEnabledByLevel was true.

WARNING: This method MUST complete quickly and without allocating any memory. It is invoked for every log statement regardless of logging configuration, so any implementation must go to every possible length to be efficient.

Specified by:

shouldForceLogging in class LoggingContext

Parameters:

loggerName - the fully qualified logger name (e.g. "com.example.SomeClass")

level - the level of the log statement being invoked

isEnabled - whether the logger is enabled at the given level

getTags

public com.google.common.flogger.backend.Tags getTags()

Description copied from class: LoggingContext

Returns a set of tags to be added to a log statement. These tags can be used to provide additional contextual metadata to log statements (e.g. request IDs).

A default implementation of this method should simply return Tags.empty().

Specified by:

getTags in class LoggingContext

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object