Skip to content

Commit 8e86f41

Browse files
committed
Add references to Copernik.eu Log4j components
This change adds references to the Log4j plugins from my personal "Extensions for Log4j and Tomcat" to the documentation.
1 parent 23290e4 commit 8e86f41

File tree

3 files changed

+55
-3
lines changed

3 files changed

+55
-3
lines changed

src/site/antora/modules/ROOT/pages/manual/lookups.adoc

+27-1
Original file line numberDiff line numberDiff line change
@@ -966,7 +966,10 @@ include::partial$features/servlet-support.adoc[]
966966
[#third-party]
967967
== Third-party lookups
968968
969-
The following additional lookups are available from third-party vendors:
969+
[IMPORTANT]
970+
====
971+
These lookups are provided by **third-party** vendors and are not maintained by the Apache Software Foundation.
972+
====
970973
971974
[#KubernetesLookup]
972975
=== Kubernetes Lookup
@@ -999,6 +1002,29 @@ The Spring Boot 3 Lookup conflicts with the <<#SpringBootLookup>>.
9991002
If you are upgrading to Spring Boot 3, make sure to remove the latter from your classpath.
10001003
====
10011004
1005+
[#TomcatLookup]
1006+
=== Tomcat Lookup
1007+
1008+
[cols="1h,4"]
1009+
|===
1010+
| Syntax
1011+
|
1012+
`tomcat:<key>`
1013+
1014+
where `key` is one of the
1015+
https://oss.copernik.eu/tomcat/3.x/components/log4j-tomcat#TomcatLookup-keys[supported Tomcat Lookup keys]
1016+
| Dependency | https://oss.copernik.eu/tomcat/3.x/components/log4j-tomcat#installation[`eu.copernik:log4j-tomcat`]
1017+
|===
1018+
1019+
The Tomcat Lookup allows retrieving the names of the currently active Tomcat engine, host and application context.
1020+
See
1021+
https://oss.copernik.eu/tomcat/3.x/components/log4j-tomcat#TomcatLookup[Copernik.eu Tomcat Lookup documentation] for more details.
1022+
1023+
[TIP]
1024+
====
1025+
If you wish your custom lookup to appear on this page, use the ``[Edit]`` link at the top and submit a pull request.
1026+
====
1027+
10021028
[#extending]
10031029
== Extending
10041030

src/site/antora/modules/ROOT/pages/manual/thread-context.adoc

+14-1
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,20 @@ You can provide a custom `ContextDataProvider` implementation as follows:
159159
----
160160
META-INF/services/org.apache.logging.log4j.core.util.ContextDataProvider
161161
----
162-
. Write the fully-qualified class name of your custom implementation (e.g., `com.mycompany.CustomContextDataProvider`) to the file created in the previous step
162+
. Write the fully-qualified class name of your custom implementation (e.g., `com.mycompany.CustomContextDataProvider`) to the file created in the previous step.
163+
164+
==== Third-party custom thread context data providers
165+
166+
[IMPORTANT]
167+
====
168+
These context data providers are supplied by **third-party** vendors and are not maintained by the Apache Software Foundation.
169+
====
170+
171+
https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/log4j/log4j-context-data/log4j-context-data-2.17/library-autoconfigure[OpenTelemetry Context Data Provider]::
172+
Injects trace context data into log events.
173+
174+
https://oss.copernik.eu/tomcat/3.x/components/log4j-tomcat#TomcatContextDataProvider[Copernik.eu Tomcat Context Data Provider]::
175+
Injects the name of the currently active Tomcat engine, host and web application into log events.
163176
164177
[#custom-ThreadContextMap]
165178
=== Custom thread context map

src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-context-selector.adoc

+14-1
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,17 @@ link:../javadoc/log4j-core/org/apache/logging/log4j/core/osgi/BundleContextSelec
5555
Creates a separate logger context per OSGi bundle and synchronous loggers
5656
5757
link:../javadoc/log4j-core/org/apache/logging/log4j/core/selector/JndiContextSelector.html[`org.apache.logging.log4j.core.selector.JndiContextSelector`]::
58-
Creates loggers contexts based on a JNDI lookup and synchronous loggers See xref:jakarta.adoc#jndi-configuration[Web application] for details.
58+
Creates loggers contexts based on a JNDI lookup and synchronous loggers See xref:jakarta.adoc#jndi-configuration[Web application] for details.
59+
60+
There are also third-party context selector implementations:
61+
62+
[IMPORTANT]
63+
====
64+
These context selectors are provided by **third-party** vendors and are not maintained by the Apache Software Foundation.
65+
====
66+
67+
https://oss.copernik.eu/tomcat/3.x/components/log4j-tomcat#TomcatContextSelector[`eu.copernik.log4j.tomcat.TomcatContextSelector`]::
68+
Selects the currently active Tomcat web application and creates synchronous loggers.
69+
70+
https://oss.copernik.eu/tomcat/3.x/components/log4j-tomcat#TomcatContextSelector[`eu.copernik.log4j.tomcat.TomcatAsyncContextSelector`]::
71+
Selects the currently active Tomcat web application and creates xref:manual/async.adoc[asynchronous loggers].

0 commit comments

Comments
 (0)