This is an automated email from the ASF dual-hosted git repository. vy pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit be1903febf98137e226839d40cae3d63296cc9c5 Author: Volkan Yazıcı <[email protected]> AuthorDate: Fri Mar 17 11:03:08 2023 +0100 Fix broken links in component docs (#1376) --- src/site/markdown/log4j-1.2-api.md | 2 +- src/site/markdown/log4j-couchdb.md.vm | 2 +- src/site/markdown/log4j-docker.md.vm | 2 +- src/site/markdown/log4j-flume-ng.md.vm | 2 +- src/site/markdown/log4j-iostreams.md | 7 ++++--- src/site/markdown/log4j-jakarta-web.md | 4 ++-- src/site/markdown/log4j-jcl.md | 2 +- src/site/markdown/log4j-jmx-gui.md | 4 ++-- src/site/markdown/log4j-jul.md | 23 ++++++++++------------ src/site/markdown/log4j-kubernetes.md.vm | 2 +- src/site/markdown/log4j-mongodb3.md.vm | 2 +- src/site/markdown/log4j-mongodb4.md.vm | 2 +- src/site/markdown/log4j-slf4j-impl.md | 2 +- src/site/markdown/log4j-slf4j2-impl.md | 2 +- src/site/markdown/log4j-spring-boot.md | 8 ++------ .../markdown/log4j-spring-cloud-config-client.md | 6 +----- src/site/markdown/log4j-taglib.md | 7 ++----- src/site/markdown/log4j-to-jul.md | 2 +- src/site/markdown/log4j-to-slf4j.md | 2 +- src/site/markdown/log4j-web.md | 4 ++-- 20 files changed, 37 insertions(+), 50 deletions(-) diff --git a/src/site/markdown/log4j-1.2-api.md b/src/site/markdown/log4j-1.2-api.md index 4eb2916a3c..4e1c1673e4 100644 --- a/src/site/markdown/log4j-1.2-api.md +++ b/src/site/markdown/log4j-1.2-api.md @@ -38,7 +38,7 @@ the Log4j 2 Core module is included then when it is not: If log4j-core is not present location information will not be accurate in calls using the Log4j 1.2 API. The config package which attempts to convert Log4j 1.x configurations to Log4j 2 is not supported without Log4j 2. -For more information, see [Runtime Dependencies](../runtime-dependencies.html). +For more information, see [Runtime Dependencies](runtime-dependencies.html). ## Usage diff --git a/src/site/markdown/log4j-couchdb.md.vm b/src/site/markdown/log4j-couchdb.md.vm index a6b9639e18..d4867f4bbd 100644 --- a/src/site/markdown/log4j-couchdb.md.vm +++ b/src/site/markdown/log4j-couchdb.md.vm @@ -45,4 +45,4 @@ $h1 CouchDB Appender $h2 Requirements The CouchDB Appender is dependent on the Log4j 2 API and implementation. -For more information, see [Runtime Dependencies](../runtime-dependencies.html). +For more information, see [Runtime Dependencies](runtime-dependencies.html). diff --git a/src/site/markdown/log4j-docker.md.vm b/src/site/markdown/log4j-docker.md.vm index 969e8e51af..c86a053e86 100644 --- a/src/site/markdown/log4j-docker.md.vm +++ b/src/site/markdown/log4j-docker.md.vm @@ -53,4 +53,4 @@ shouldn't be referenced with more than one '$' character. $h2 Requirements Log4j Docker requires Log4j Core, Log4j API and a minimum of Java 8. -For more information, see [Runtime Dependencies](../runtime-dependencies.html). +For more information, see [Runtime Dependencies](runtime-dependencies.html). diff --git a/src/site/markdown/log4j-flume-ng.md.vm b/src/site/markdown/log4j-flume-ng.md.vm index 1652d865c2..87a073a876 100644 --- a/src/site/markdown/log4j-flume-ng.md.vm +++ b/src/site/markdown/log4j-flume-ng.md.vm @@ -230,4 +230,4 @@ Flume Embedded Appender into an application. $h2 Requirements The Flume Appender requires the Log4J 2 API. -For more information, see [Runtime Dependencies](../runtime-dependencies.html). +For more information, see [Runtime Dependencies](runtime-dependencies.html). diff --git a/src/site/markdown/log4j-iostreams.md b/src/site/markdown/log4j-iostreams.md index 1eb4096c19..26693de965 100644 --- a/src/site/markdown/log4j-iostreams.md +++ b/src/site/markdown/log4j-iostreams.md @@ -20,11 +20,11 @@ ## Log4j IOStreams -The IOStreams component is a [Log4j API](../log4j-api/index.html) extension that provides numerous +The IOStreams component is a [Log4j API](javadoc/log4j-api/index.html) extension that provides numerous classes from [`java.io`](http://docs.oracle.com/javase/6/docs/api/java/io/package-summary.html) that can either write to a -[`Logger`](../log4j-api/apidocs/org/apache/logging/log4j/Logger.html) +[`Logger`](javadoc/log4j-api/org/apache/logging/log4j/Logger.html) while writing to another `OutputStream` or `Writer`, or the contents read by an `InputStream` or `Reader` can be [wiretapped](http://www.eaipatterns.com/WireTap.html) by a `Logger`. @@ -32,10 +32,11 @@ while writing to another `OutputStream` or `Writer`, or the contents read by an ## Requirements The Log4j IOStreams API extension requires the Log4j 2 API. This component was introduced in Log4j 2.1. +For more information, see [Runtime Dependencies](runtime-dependencies.html). ## Usage The main entry point for the IOStreams module is the builder class -[`IoBuilder`](apidocs/org/apache/logging/log4j/io/IoBuilder.html), and in particular, +`IoBuilder`, and in particular, the `IoBuilder.forLogger()` methods. One primary usage of this API extension is for setting up loggers in the JDBC API. For example: diff --git a/src/site/markdown/log4j-jakarta-web.md b/src/site/markdown/log4j-jakarta-web.md index 8da38f28b3..fb287b68c7 100644 --- a/src/site/markdown/log4j-jakarta-web.md +++ b/src/site/markdown/log4j-jakarta-web.md @@ -21,10 +21,10 @@ The Web module provides support for automatically enabling Log4j in Servlet containers. -See the user manual page on [Web Applications and JSPs](../manual/webapp.html) +See the user manual page on [Web Applications and JSPs](manual/webapp.html) for details on using Log4j 2 in Web Applications. ## Requirements The Web module requires Servlet 5.0 at minimum and is dependent on the Log4j 2 API and implementation. -For more information, see [Runtime Dependencies](../runtime-dependencies.html). +For more information, see [Runtime Dependencies](runtime-dependencies.html). diff --git a/src/site/markdown/log4j-jcl.md b/src/site/markdown/log4j-jcl.md index d7f302a3e1..fdb15bfbbe 100644 --- a/src/site/markdown/log4j-jcl.md +++ b/src/site/markdown/log4j-jcl.md @@ -24,7 +24,7 @@ Log4j 2 as the implementation. ## Requirements The Commons Logging Bridge is dependent on the Log4j 2 API and Commons Logging. -For more information, see [Runtime Dependencies](../runtime-dependencies.html). +For more information, see [Runtime Dependencies](runtime-dependencies.html). ## Usage diff --git a/src/site/markdown/log4j-jmx-gui.md b/src/site/markdown/log4j-jmx-gui.md index feb08ccf44..c34a4b62e2 100644 --- a/src/site/markdown/log4j-jmx-gui.md +++ b/src/site/markdown/log4j-jmx-gui.md @@ -26,8 +26,8 @@ The JMX GUI can be run as a stand-alone application or as a JConsole plug-in. ## Requirements The JMX GUI is dependent on Log4j 2 Core. -For more information, see [Runtime Dependencies](../runtime-dependencies.html). +For more information, see [Runtime Dependencies](runtime-dependencies.html). ## Usage -See the [JMX manual](../manual/jmx.html#ClientGUI) page for details. +See the [JMX manual](manual/jmx.html#ClientGUI) page for details. diff --git a/src/site/markdown/log4j-jul.md b/src/site/markdown/log4j-jul.md index 06e137ca51..5154e7727a 100644 --- a/src/site/markdown/log4j-jul.md +++ b/src/site/markdown/log4j-jul.md @@ -24,19 +24,19 @@ There are two possibilities: The JDK Logging Adapter is a custom implementation of [`java.util.logging.LogManager`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/LogManager.html) -that uses [Log4j](../log4j-core/index.html). This adapter can be used with either the Log4j API or +that uses [Log4j](javadoc/log4j-core/index.html). This adapter can be used with either the Log4j API or Log4j Core. When used with the API, there are a couple features of JUL that aren't supported. However, this does allow any other Log4j Provider besides the Core provider to be used with JUL. ## Requirements The JDK Logging Adapter is dependent on the Log4j API and optionally Log4j Core. -For more information, see [Runtime Dependencies](../runtime-dependencies.html). +For more information, see [Runtime Dependencies](runtime-dependencies.html). ## Usage To use the JDK Logging Adapter, you must set the system property `java.util.logging.manager` to -[`org.apache.logging.log4j.jul.LogManager`](apidocs/org/apache/logging/log4j/jul/LogManager.html) +`org.apache.logging.log4j.jul.LogManager`. This must be done either through the command line (i.e., using the `-Djava.util.logging.manager=org.apache.logging.log4j.jul.LogManager` argument) or by using @@ -47,20 +47,20 @@ This must be done either through the command line (i.e., using the The use of a [`java.util.logging.Filter`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Filter.html) is supported on a per-[`Logger`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Logger.html) -basis. However, it is recommended to use the standard [Filters](../manual/filters.html) feature in +basis. However, it is recommended to use the standard [Filters](manual/filters.html) feature in Log4j instead. The use of [`java.util.logging.Handler`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Handler.html) classes is _NOT_ supported. Custom Handlers should instead use an appropriate -[Appender](../manual/appenders.html) or code their own -[`Appender`](../log4j-core/apidocs/org/apache/logging/log4j/core/Appender.html) +[Appender](manual/appenders.html) or code their own +[`Appender`](javadoc/log4j-core/org/apache/logging/log4j/core/Appender.html) plugin. Java logging levels are translated into Log4j logging levels dynamically. The following table lists the conversions between a Java logging level and its equivalent Log4j level. Custom levels should be implemented as an implementation of -[`LevelConverter`](apidocs/org/apache/logging/log4j/jul/LevelConverter.html), and the +`LevelConverter`, and the Log4j property `log4j.jul.levelConverter` must be set to your custom class name. Using the default `LevelConverter` implementation, custom logging levels are mapped to whatever the current level of the `Logger` being logged to is using. @@ -73,10 +73,10 @@ Java Level | Log4j Level [`SEVERE`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#SEVERE) | `ERROR` [`WARNING`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#WARNING) | `WARN` [`INFO`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#INFO) | `INFO` -[`CONFIG`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#CONFIG) | [`CONFIG`](apidocs/org/apache/logging/log4j/jul/LevelTranslator.html#CONFIG) +[`CONFIG`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#CONFIG) | `CONFIG` [`FINE`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#FINE) | `DEBUG` [`FINER`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#FINER) | `TRACE` -[`FINEST`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#FINEST) | [`FINEST`](apidocs/org/apache/logging/log4j/jul/LevelTranslator.html#FINEST) +[`FINEST`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#FINEST) | `FINEST` [`ALL`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#ALL) | `ALL` @@ -85,7 +85,7 @@ Java Level | Log4j Level The LogManager is not always useable because you have to set a JVM wide effective system property - e.g. in web servers this is not possible if you are not the administrator. -The [`Log4jBridgeHandler`](apidocs/org/apache/logging/log4j/jul/Log4jBridgeHandler.html) is an +The `Log4jBridgeHandler` is an alternative that can be declaratively used via `logging.properties`. It is less performant than the LogManager but still okay to use: the LogManager replaces the JDK @@ -116,6 +116,3 @@ e.g. inside `ServletContextListener` or a `ServletFilter` static-class-init. or **Important:** Log levels of JDK should match the ones of log4j. You may do this manually or use the automatic level propagation via `Log4jBridgeHandler.propagateLevels = true`. - -Please, read the [JavaDoc](apidocs/org/apache/logging/log4j/jul/Log4jBridgeHandler.html) for detailed -configuration and limitation information! diff --git a/src/site/markdown/log4j-kubernetes.md.vm b/src/site/markdown/log4j-kubernetes.md.vm index d51e757dd6..12b28f3374 100644 --- a/src/site/markdown/log4j-kubernetes.md.vm +++ b/src/site/markdown/log4j-kubernetes.md.vm @@ -101,4 +101,4 @@ Note that Spring Boot initializes logging 3 times and only the last will have a $h2 Requirements Log4j Kubernetes requires Log4j Core, Log4j API and a minimum of Java 8. -For more information, see [Runtime Dependencies](../runtime-dependencies.html). +For more information, see [Runtime Dependencies](runtime-dependencies.html). diff --git a/src/site/markdown/log4j-mongodb3.md.vm b/src/site/markdown/log4j-mongodb3.md.vm index 312889cc13..19fa7eb377 100644 --- a/src/site/markdown/log4j-mongodb3.md.vm +++ b/src/site/markdown/log4j-mongodb3.md.vm @@ -45,4 +45,4 @@ $h1 MongoDB appender $h2 Requirements The MongoDB Appender is dependent on the Log4j 2 API and implementation. -For more information, see [Runtime Dependencies](../runtime-dependencies.html). +For more information, see [Runtime Dependencies](runtime-dependencies.html). diff --git a/src/site/markdown/log4j-mongodb4.md.vm b/src/site/markdown/log4j-mongodb4.md.vm index 6cc3f701e2..c246536836 100644 --- a/src/site/markdown/log4j-mongodb4.md.vm +++ b/src/site/markdown/log4j-mongodb4.md.vm @@ -45,4 +45,4 @@ $h1 MongoDB appender $h2 Requirements The MongoDB Appender is dependent on the Log4j 2 API and implementation. -For more information, see [Runtime Dependencies](../runtime-dependencies.html). +For more information, see [Runtime Dependencies](runtime-dependencies.html). diff --git a/src/site/markdown/log4j-slf4j-impl.md b/src/site/markdown/log4j-slf4j-impl.md index b81787fc38..282b3cff6d 100644 --- a/src/site/markdown/log4j-slf4j-impl.md +++ b/src/site/markdown/log4j-slf4j-impl.md @@ -31,7 +31,7 @@ Applications that take advantage of the Java Module System should use SLF4J 1.8. ## Requirements The Log4j 2 SLF4J Binding has a dependency on the Log4j 2 API as well as the SLF4J API. -For more information, see [Runtime Dependencies](../runtime-dependencies.html). +For more information, see [Runtime Dependencies](runtime-dependencies.html). ## Usage diff --git a/src/site/markdown/log4j-slf4j2-impl.md b/src/site/markdown/log4j-slf4j2-impl.md index 6e3f3f69d1..b88c3d9ff4 100644 --- a/src/site/markdown/log4j-slf4j2-impl.md +++ b/src/site/markdown/log4j-slf4j2-impl.md @@ -24,7 +24,7 @@ Log4j 2 as the implementation. ## Requirements The Log4j 2 SLF4J Binding has a dependency on the Log4j 2 API as well as the SLF4J API. -For more information, see [Runtime Dependencies](../runtime-dependencies.html). +For more information, see [Runtime Dependencies](runtime-dependencies.html). ## Usage diff --git a/src/site/markdown/log4j-spring-boot.md b/src/site/markdown/log4j-spring-boot.md index c8687c3250..dc8a4eb30b 100644 --- a/src/site/markdown/log4j-spring-boot.md +++ b/src/site/markdown/log4j-spring-boot.md @@ -44,7 +44,7 @@ Spring configuration. ### Spring Property Source Log4j uses property sources when resolving properties it uses internally. This support allows -most of Log4j's [System Properties](http://logging.apache.org/log4j/2.x/manual/configuration.html#SystemProperties) +most of Log4j's [System Properties](manual/configuration.html#SystemProperties) to be specified in the Spring Configuration. However, some properties that are only referenced during the first Log4j initialization, such as the property Log4j uses to allow the default Log4j implementation to be chosen, would not be available. @@ -84,8 +84,4 @@ this purpose. Below is an example: The Log4j 2 Spring Cloud Configuration integration has a dependency on Log4j 2 API, Log4j 2 Core, and Spring Boot versions 2.0.3.RELEASE or 2.1.1.RELEASE or later versions it either release series. -For more information, see [Runtime Dependencies](../../runtime-dependencies.html). - - - - +For more information, see [Runtime Dependencies](runtime-dependencies.html). diff --git a/src/site/markdown/log4j-spring-cloud-config-client.md b/src/site/markdown/log4j-spring-cloud-config-client.md index bb8892f861..4244f02cab 100644 --- a/src/site/markdown/log4j-spring-cloud-config-client.md +++ b/src/site/markdown/log4j-spring-cloud-config-client.md @@ -132,8 +132,4 @@ TLS can be enabled by adding the following system properties or defining them in The Log4j 2 Spring Cloud Configuration integration has a dependency on Log4j 2 API, Log4j 2 Core, and Spring Cloud Configuration versions 2.0.3.RELEASE or 2.1.1.RELEASE or later versions it either release series. -For more information, see [Runtime Dependencies](../../runtime-dependencies.html). - - - - +For more information, see [Runtime Dependencies](runtime-dependencies.html). diff --git a/src/site/markdown/log4j-taglib.md b/src/site/markdown/log4j-taglib.md index ea7174a745..809da1ef7a 100644 --- a/src/site/markdown/log4j-taglib.md +++ b/src/site/markdown/log4j-taglib.md @@ -32,7 +32,7 @@ the "logger" attribute in this library. The Log4j Tag Library requires at least Servlet 2.5 (or Java EE 5), at least JSP 2.1 (or Java EE 5), and is dependent on the Log4j 2 API. -For more information, see [Runtime Dependencies](../runtime-dependencies.html). +For more information, see [Runtime Dependencies](runtime-dependencies.html). <span class="label label-important">Important Note!</span> For performance reasons, containers often ignore certain JARs known not to @@ -43,7 +43,7 @@ will need to change `catalina.properties` and remove "log4j*.jar" from the `jars property. You may need to do something similar on other containers if they skip scanning Log4j JAR files. ## Usage -In accordance with the [Logger](../log4j-api/apidocs/org/apache/logging/log4j/Logger.html) +In accordance with the [Logger](javadoc/log4j-api/org/apache/logging/log4j/Logger.html) API, this tag library has tags to support the following logging calls: "catching", "entry", "exit", "log", "trace", "debug", "info", "warn", "error", and "fatal". The "trace" tag was not supported in Jakarta Commons Log @@ -65,6 +65,3 @@ available in this library, their uses are not nano-second order of magnitude wit that users may be used to with standard Log4j method calls. Therefore, they should be used sparingly. Use of the "ifEnabled" tag does not improve this performance; this tag is available to conditionally evaluate other actions in addition to logging actions. - -For detailed documentation of each tag, see the [Tag Library Reference](tagreference.html) or the -[TLDDoc Documentation](tlddoc/index.html). diff --git a/src/site/markdown/log4j-to-jul.md b/src/site/markdown/log4j-to-jul.md index ffa5af5da2..ece1b5b69f 100644 --- a/src/site/markdown/log4j-to-jul.md +++ b/src/site/markdown/log4j-to-jul.md @@ -27,7 +27,7 @@ formatted only when they are accessed by a Filter or Appender. ## Requirements The Log4j 2 to JUL adapter is dependent on the Log4j 2 API. -For more information, see [Runtime Dependencies](../runtime-dependencies.html). +For more information, see [Runtime Dependencies](runtime-dependencies.html). ## Usage diff --git a/src/site/markdown/log4j-to-slf4j.md b/src/site/markdown/log4j-to-slf4j.md index 34027e73a0..47a25146c1 100644 --- a/src/site/markdown/log4j-to-slf4j.md +++ b/src/site/markdown/log4j-to-slf4j.md @@ -26,7 +26,7 @@ formatted only when they are accessed by a Filter or Appender. ## Requirements The Log4j 2 to SLF4J adapter is dependent on the Log4j 2 API and the SLF4J API. -For more information, see [Runtime Dependencies](../runtime-dependencies.html). +For more information, see [Runtime Dependencies](runtime-dependencies.html). ## Usage diff --git a/src/site/markdown/log4j-web.md b/src/site/markdown/log4j-web.md index 9a87a57626..5628367146 100644 --- a/src/site/markdown/log4j-web.md +++ b/src/site/markdown/log4j-web.md @@ -21,10 +21,10 @@ The Web module provides support for automatically enabling Log4j in Servlet containers. -See the user manual page on [Web Applications and JSPs](../manual/webapp.html) +See the user manual page on [Web Applications and JSPs](manual/webapp.html) for details on using Log4j 2 in Web Applications. ## Requirements The Web module requires Servlet 2.5 at minimum and is dependent on the Log4j 2 API and implementation. -For more information, see [Runtime Dependencies](../runtime-dependencies.html). +For more information, see [Runtime Dependencies](runtime-dependencies.html).
