co.cask.cdap.common.logging

Class LoggingContextAccessor

java.lang.Object

co.cask.cdap.common.logging.LoggingContextAccessor

public class LoggingContextAccessor
extends Object

Allows to store and access the logging context.

The logging context is injected into log messages emitted via standard logging APIs. This enables grouping logs based on the execution context of the place where log message was emitted and searching messages on the logs processing back-end.

Constructor Summary

Constructors

Constructor and Description
LoggingContextAccessor()

Method Summary

Methods

Modifier and Type	Method and Description
static LoggingContext	getLoggingContext()
static void	setLoggingContext(LoggingContext context) Sets the logging context.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingContextAccessor

public LoggingContextAccessor()

Method Detail

setLoggingContext

public static void setLoggingContext(LoggingContext context)

Sets the logging context.

NOTE: in work execution frameworks where threads are shared between workers (like Akka) we would have to init context very frequently (before every chunk of work is started). In that case we really want to re-use logging context object instance.

Parameters:

context - context to set

getLoggingContext

public static LoggingContext getLoggingContext()

Returns:

LoggingContext if it was set. Returns null otherwise.