Created
October 9, 2014 13:23
-
-
Save yanns/f7da61c582ab1da3535d to your computer and use it in GitHub Desktop.
SLF4J MDC propagation in Play
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
package monitoring | |
import java.util.concurrent.TimeUnit | |
import akka.dispatch._ | |
import com.typesafe.config.Config | |
import org.slf4j.MDC | |
import scala.concurrent.ExecutionContext | |
import scala.concurrent.duration.{Duration, FiniteDuration} | |
/** | |
* Configurator for a MDC propagating dispatcher. | |
* | |
* To use it, configure play like this: | |
* {{{ | |
* play { | |
* akka { | |
* actor { | |
* default-dispatcher = { | |
* type = "monitoring.MDCPropagatingDispatcherConfigurator" | |
* } | |
* } | |
* } | |
* } | |
* }}} | |
* | |
* Credits to James Roper for the [[https://github.com/jroper/thread-local-context-propagation/ initial implementation]] | |
*/ | |
class MDCPropagatingDispatcherConfigurator(config: Config, prerequisites: DispatcherPrerequisites) | |
extends MessageDispatcherConfigurator(config, prerequisites) { | |
private val instance = new MDCPropagatingDispatcher( | |
this, | |
config.getString("id"), | |
config.getInt("throughput"), | |
FiniteDuration(config.getDuration("throughput-deadline-time", TimeUnit.NANOSECONDS), TimeUnit.NANOSECONDS), | |
configureExecutor(), | |
FiniteDuration(config.getDuration("shutdown-timeout", TimeUnit.MILLISECONDS), TimeUnit.MILLISECONDS)) | |
override def dispatcher(): MessageDispatcher = instance | |
} | |
/** | |
* A MDC propagating dispatcher. | |
* | |
* This dispatcher propagates the MDC current request context if it's set when it's executed. | |
*/ | |
class MDCPropagatingDispatcher(_configurator: MessageDispatcherConfigurator, | |
id: String, | |
throughput: Int, | |
throughputDeadlineTime: Duration, | |
executorServiceFactoryProvider: ExecutorServiceFactoryProvider, | |
shutdownTimeout: FiniteDuration) | |
extends Dispatcher(_configurator, id, throughput, throughputDeadlineTime, executorServiceFactoryProvider, shutdownTimeout ) { | |
self => | |
override def prepare(): ExecutionContext = new ExecutionContext { | |
// capture the MDC | |
val mdcContext = MDC.getCopyOfContextMap | |
def execute(r: Runnable) = self.execute(new Runnable { | |
def run() = { | |
// backup the callee MDC context | |
val oldMDCContext = MDC.getCopyOfContextMap | |
// Run the runnable with the captured context | |
setContextMap(mdcContext) | |
try { | |
r.run() | |
} finally { | |
// restore the callee MDC context | |
setContextMap(oldMDCContext) | |
} | |
} | |
}) | |
def reportFailure(t: Throwable) = self.reportFailure(t) | |
} | |
private[this] def setContextMap(context: java.util.Map[String, String]) { | |
if (context == null) { | |
MDC.clear() | |
} else { | |
MDC.setContextMap(context) | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
worked after adding the following configuration to application.conf for play 2.5.2
akka { actor { default-dispatcher = { type = "monitoring.MDCPropagatingDispatcherConfigurator" } } }