com.vmware.vapi.diagnostics

Interface LogDiagnosticsConfigurator

All Known Implementing Classes:

Slf4jMDCLogConfigurator

public interface LogDiagnosticsConfigurator

Interface for configurators for logging dignostics context. Concrete subclasses can be used to configure context with additional information to appear in logging traces.

Method Summary

Methods

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()).

Method Detail

configureContext

void configureContext(Map<String,String> diagCtx)

Configure logging context for the current thread.

Parameters:

diagCtx - log diagnostics context

cleanUpContext

void cleanUpContext()

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.

cleanUpContext

void cleanUpContext(Collection<String> keys)

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

Parameters:

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

getContext

Map<String,String> getContext()

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

Returns:

Map representing the log diagnostics context