[
https://issues.apache.org/jira/browse/LOG4J2-2433?focusedWorklogId=178169&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-178169
]
ASF GitHub Bot logged work on LOG4J2-2433:
------------------------------------------
Author: ASF GitHub Bot
Created on: 21/Dec/18 22:47
Start Date: 21/Dec/18 22:47
Worklog Time Spent: 10m
Work Description: rocketraman commented on a change in pull request #8:
LOG4J2-2433 Coroutines Support
URL: https://github.com/apache/logging-log4j-kotlin/pull/8#discussion_r243708005
##########
File path:
log4j-api-kotlin/src/main/kotlin/org/apache/logging/log4j/kotlin/ThreadContextContext.kt
##########
@@ -0,0 +1,98 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.logging.log4j.kotlin
+
+import kotlinx.coroutines.ThreadContextElement
+import org.apache.logging.log4j.ThreadContext
+import kotlin.coroutines.AbstractCoroutineContextElement
+import kotlin.coroutines.CoroutineContext
+
+
+/**
+ * The value of [ThreadContext] map and stack.
+ * See [ThreadContext.getImmutableContext] and
[ThreadContext.getImmutableStack].
+ */
+public data class ThreadContextContents(
+ val map: Map<String, String>?,
+ val stack: Collection<String>?
+)
+
+/**
+ * Log4j2 [ThreadContext] element for [CoroutineContext]. The name is a bit
confusing
+ * because this is the Kotlin coroutines "Context" for the Log4j2
"ThreadContext",
+ * therefore [ThreadContextContext].
+ *
+ * This is based on the SLF4J MDCContext maintained by Jetbrains:
+ *
https://github.com/Kotlin/kotlinx.coroutines/blob/master/integration/kotlinx-coroutines-slf4j/src/MDCContext.kt
+ *
+ * Example:
+ *
+ * ```
+ * ThreadContext.put("kotlin", "rocks") // Put a value into the Thread context
+ *
+ * launch(ThreadContextContext()) {
+ * logger.info { "..." } // The Thread context contains the mapping here
+ * }
+ * ```
+ *
+ * Note, that you cannot update Thread context from inside of the coroutine
simply
+ * using [ThreadContext.put]. These updates are going to be lost on the next
suspension and
+ * reinstalled to the Thread context that was captured or explicitly specified
in
+ * [contextMap] when this object was created on the next resumption.
+ * Use `withContext(ThreadContext()) { ... }` to capture updated map of Thread
keys and values
+ * for the specified block of code.
+ *
+ * @param contextMap the value of [Thread] context map.
+ * Default value is the copy of the current thread's context map that is
acquired via
+ * [ThreadContext.getContext].
+ */
+public class ThreadContextContext(
Review comment:
I struggled with the name. It is actually a Kotlin coroutines "Context", for
a Log4j "ThreadContext". Calling it `ThreadContextHolder` doesn't seem quite
right, as it does a bit more than just hold the log4j `ThreadContext`. How
about `CoroutineThreadContext`?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 178169)
Time Spent: 50m (was: 40m)
> Support MDCs with Kotlin coroutines
> -----------------------------------
>
> Key: LOG4J2-2433
> URL: https://issues.apache.org/jira/browse/LOG4J2-2433
> Project: Log4j 2
> Issue Type: New Feature
> Components: Kotlin API
> Affects Versions: Kotlin 1.0.0
> Reporter: Raman Gupta
> Priority: Major
> Time Spent: 50m
> Remaining Estimate: 0h
>
> Create support for log4j2 MDC when used with Kotlin coroutines. Since
> coroutines do not guarantee which underlying thread is executing code after a
> continuation, a standard ThreadLocal is not sufficient to keep the MDC
> context.
> Kotlin coroutines have a mechanism by which "coroutine local" data can be
> stored. See the reference implementation for SLF4J here:
> https://github.com/Kotlin/kotlinx.coroutines/tree/master/integration/kotlinx-coroutines-slf4j
> We should implement an optional native module to add support for log4j2 MDC
> using the same pattern, that does not require having SLF4J and the
> slf4j-log4j2 implementation on the classpath.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
