com.google.common.flogger

Class GoogleLogContext<LOGGER extends com.google.common.flogger.AbstractLogger<API>,API extends GoogleLoggingApi<API>>

java.lang.Object

com.google.common.flogger.LogContext<LOGGER,API>

com.google.common.flogger.GoogleLogContext<LOGGER,API>

Type Parameters:

LOGGER - The logger implementation from which this context is produced.

API - The logging api supported by this context.

All Implemented Interfaces:

com.google.common.flogger.backend.LogData, GoogleLoggingApi<API>, com.google.common.flogger.LoggingApi<API>

@CheckReturnValue
public abstract class GoogleLogContext<LOGGER extends com.google.common.flogger.AbstractLogger<API>,API extends GoogleLoggingApi<API>>
extends com.google.common.flogger.LogContext<LOGGER,API>
implements GoogleLoggingApi<API>

Implementation of any Google specific extensions to the default fluent logging API. This could be implemented purely as an inner class inside GoogleLogger, but by making it abstract and top level, it allows other teams to subclass it to add additional functionality.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.common.flogger.LogContext

com.google.common.flogger.LogContext.Key

Nested classes/interfaces inherited from interface com.google.common.flogger.GoogleLoggingApi

GoogleLoggingApi.NoOp<API extends GoogleLoggingApi<API>>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GoogleLogContext(java.util.logging.Level level, boolean isForced) Creates a logging context for the GoogleLoggerApi.

Method Summary

Modifier and Type	Method and Description
protected com.google.common.flogger.parser.MessageParser	getMessageParser()
<T> API	with(com.google.common.flogger.MetadataKey<T> key, T value) Associates a metadata key constant with a runtime value for this log statement in a structured way that is accessible to logger backends.

Methods inherited from class com.google.common.flogger.LogContext

addMetadata, api, atMostEvery, every, getArguments, getLevel, getLiteralArgument, getLogger, getLoggerName, getLogSite, getMetadata, getTemplateContext, getTimestampMicros, getTimestampNanos, isEnabled, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, logVarargs, noOp, postProcess, removeMetadata, wasForced, withCause, withInjectedLogSite, withInjectedLogSite, withStackTrace

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.flogger.LoggingApi

atMostEvery, every, isEnabled, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, logVarargs, withCause, withInjectedLogSite, withInjectedLogSite, withStackTrace

Constructor Detail

GoogleLogContext

protected GoogleLogContext(java.util.logging.Level level,
                           boolean isForced)

Creates a logging context for the GoogleLoggerApi.

Parameters:

level - the log level of this log statement.

isForced - whether the log statement should be forced.

Method Detail

getMessageParser

protected final com.google.common.flogger.parser.MessageParser getMessageParser()

Specified by:

getMessageParser in class com.google.common.flogger.LogContext<LOGGER extends com.google.common.flogger.AbstractLogger<API>,API extends GoogleLoggingApi<API>>

with

public final <T> API with(com.google.common.flogger.MetadataKey<T> key,
                          @Nullable
                          T value)

Description copied from interface: GoogleLoggingApi

Associates a metadata key constant with a runtime value for this log statement in a structured way that is accessible to logger backends.

This method is not a replacement for general parameter passing in the LoggingApi.log() method and should be reserved for keys/values with specific semantics. Examples include:

• Keys that are recognised by specific logger backends (typically to control logging behaviour in some way).
• Key value pairs which are explicitly extracted from logs by tools.

Metadata keys can support repeated values (see MetadataKey.canRepeat()), and if a repeatable key is used multiple times in the same log statement, the effect is to collect all the given values in order. If a non-repeatable key is passed multiple times, only the last value is retained (though callers should not rely on this behavior and should simply avoid repeating non-repeatable keys).

If value is null, this method is a no-op. This is useful for specifying conditional values (e.g. via logger.atInfo().with(MY_KEY, getValueOrNull()).log(...)).

Specified by:

with in interface GoogleLoggingApi<API extends GoogleLoggingApi<API>>

Parameters:

key - the metadata key (expected to be a static constant)

value - a value to be associated with the key in this log statement. Null values are allowed, but the effect is always a no-op

See Also:

MetadataKey