This is an automated email from the ASF dual-hosted git repository.

pkarwasz pushed a commit to branch 2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git


The following commit(s) were added to refs/heads/2.x by this push:
     new ca1a7c51e9 Add missing `log4j2.contextData` property
ca1a7c51e9 is described below

commit ca1a7c51e97a34339e3c4d4418f690ca5aecbe8a
Author: Piotr P. Karwasz <piotr.git...@karwasz.org>
AuthorDate: Thu May 16 17:34:28 2024 +0200

    Add missing `log4j2.contextData` property
---
 .../properties-log4j-core-misc.adoc                | 23 ++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git 
a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log4j-core-misc.adoc
 
b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log4j-core-misc.adoc
index 7bd46a8f4b..c0b736ee4e 100644
--- 
a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log4j-core-misc.adoc
+++ 
b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log4j-core-misc.adoc
@@ -39,6 +39,29 @@ See 
link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/CachedClock[Ja
 CoarseCachedClock:: alternative implementation of `CachedClock` with a 
slightly lower precision.
 See 
link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/CoarseCachedClock[JavaDoc]
 for details.
 
+[id=log4j2.contextData]
+== `log4j2.contextData`
+
+[cols="1h,5"]
+|===
+| Env. variable
+| LOG4J_CONTEXT_DATA
+
+| Type
+| 
link:../javadoc/log4j-api/org/apache/logging/log4j/util/StringMap.html[Class<? 
extends StringMap>]
+
+| Default value
+| 
link:../javadoc/log4j-api/org/apache/logging/log4j/util/SortedArrayStringMap.html[SortedArrayStringMap]
+|===
+
+Fully qualified class name of a
+link:../javadoc/log4j-api/org/apache/logging/log4j/util/StringMap.html[StringMap]
+implementation to use to store context data in log events.
+The implementation must have:
+
+* a no-arg contructor,
+* a constructor accepting a single `int` parameter that specifies the capacity 
of the string map.
+
 [id=log4j2.contextDataInjector]
 == `log4j2.contextDataInjector`
 

Reply via email to