com.vmware.vapi.diagnostics

Class Slf4jMDCLogConfigurator

java.lang.Object

com.vmware.vapi.diagnostics.Slf4jMDCLogConfigurator

All Implemented Interfaces:

LogDiagnosticsConfigurator

public final class Slf4jMDCLogConfigurator
extends Object
implements LogDiagnosticsConfigurator

SLF4J MDC based log configurator.

Configures log diagnostic context as String key and values pairs. Context is supposed to appear in logging traces by the means supported by Log4j. Context is maintained on a per thread basis.

Thread switching (like running task in ThreadPoolExecutor or newly created Thread require explicit action in order to transfer the context to the new thread and later clean it up.

See Also:

MDC

Constructor Summary

Constructors

Constructor and Description
Slf4jMDCLogConfigurator()

Method Summary

Modifier and Type	Method and Description
void	cleanUpContext() Clean the logging context for the current thread.
void	cleanUpContext(Collection<String> keys) Cleans specified keys from the logging context.
void	configureContext(Map<String,String> diagCtx) Configure logging context for the current thread.
Map<String,String>	getContext() Retrieve the logging context for the current thread (Thread.currentThread()).

Methods inherited from class java.lang.Object

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

Constructor Detail

Slf4jMDCLogConfigurator

public Slf4jMDCLogConfigurator()

Method Detail

configureContext

public void configureContext(Map<String,String> diagCtx)

Description copied from interface: LogDiagnosticsConfigurator

Configure logging context for the current thread.

Specified by:

configureContext in interface LogDiagnosticsConfigurator

Parameters:

diagCtx - log diagnostics context

cleanUpContext

public void cleanUpContext()

Description copied from interface: LogDiagnosticsConfigurator

Clean the logging context for the current thread.

WARNING: this will clear the while underlying storage of the context, e.g. the slf4j MDC. It is possible that other data is stored in that storage, which is not supposed to be cleared. Use this method with caution, the vAPI infrastructure will never invoke it.

Specified by:

cleanUpContext in interface LogDiagnosticsConfigurator

cleanUpContext

public void cleanUpContext(Collection<String> keys)

Description copied from interface: LogDiagnosticsConfigurator

Cleans specified keys from the logging context. Removes the mappings for these keys from the underlying context storage (e.g. slf4j MDC).

Specified by:

cleanUpContext in interface LogDiagnosticsConfigurator

Parameters:

keys - the keys to be cleaned; must not be null

getContext

public Map<String,String> getContext()

Description copied from interface: LogDiagnosticsConfigurator

Retrieve the logging context for the current thread (Thread.currentThread()).

The result can be used to transfer the logging context to another thread, which continues the execution of the logical operation

Specified by:

getContext in interface LogDiagnosticsConfigurator

Returns:

Map representing the log diagnostics context