![JAR search and dependency download from the Maven repository](/logo.png)
co.cask.cdap.common.logging.LoggingContextAccessor Maven / Gradle / Ivy
/*
* Copyright © 2014 Cask Data, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package co.cask.cdap.common.logging;
/**
* 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.
*
*/
public class LoggingContextAccessor {
private static final InheritableThreadLocal loggingContext =
new InheritableThreadLocal<>();
/**
* 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.
*
* @param context context to set
*/
public static void setLoggingContext(LoggingContext context) {
loggingContext.set(context);
}
/**
* @return LoggingContext if it was set. Returns null otherwise.
*/
public static LoggingContext getLoggingContext() {
return loggingContext.get();
}
}