Add more Flogger details to release notes and deprecate use of SLF4J for plugins
Create more awareness for the system properties that need to be set for
Flogger by mentioning them in the "Important Notes" section.
Also deprecate the use of SLF4J in plugins so that we can remove the
dependency to SLF4J with the next release.
Change-Id: Ia59b46dc47890f65a9b246a6b325830b7e349e54
Signed-off-by: Edwin Kempin <ekempin@google.com>
diff --git a/pages/site/releases/2.16.md b/pages/site/releases/2.16.md
index af27eec..73e4d1b 100644
--- a/pages/site/releases/2.16.md
+++ b/pages/site/releases/2.16.md
@@ -28,6 +28,32 @@
java -jar gerrit.war init -d site_path
```
+### New logging framework
+
+For logging Gerrit is now using [Flogger](https://github.com/google/flogger)
+instead of SLF4J. The logging backend is still LOG4J.
+
+The Flogger LOG4J backend is configured by a system property
+(`flogger.backend_factory=com.google.common.flogger.backend.log4j.Log4jBackendFactory#getInstance`)
+that must be set for logging to work. There is an init step that automatically
+sets this system property in the `gerrit.config` file and in addition Gerrit
+tries to set this system property automatically on startup if it isn't set yet.
+However for some setups you may need to do additional actions to make sure that
+this system property is set.
+
+In addition there is a system property that needs to be set for
+[request tracing](https://gerrit-documentation.storage.googleapis.com/Documentation/2.16/user-request-tracing.html)
+(`flogger.logging_context=com.google.gerrit.server.logging.LoggingContext#getInstance`).
+Also this system property is automatically set in the `gerrit.config` file by an
+init step and in addition Gerrit tries to set this system property automatically
+on startup if it isn't set yet. However for some setups you may need to do
+additional actions to make sure that this system property is set.
+
+SLF4J can still be used by plugins, but using SLF4J in plugins is deprecated and
+with the next Gerrit release SLF4J will no longer be exported as part of the
+Gerrit plugin API jar. This means from the next release on plugins must either
+migrate to Flogger or have an own dependency on SLF4J.
+
### Reindex for new projects index and changed group index
Gerrit 2.16 introduces a new secondary index for projects. The initial version
@@ -96,11 +122,6 @@
easily. Detailed information about request tracing can be found in the
[request tracing documentation](https://gerrit-documentation.storage.googleapis.com/Documentation/2.16/user-request-tracing.html).
-For request tracing to work the system property
-`flogger.logging_context=com.google.gerrit.server.logging.LoggingContext#getInstance`
-must be set. Gerrit sets this system property automatically on startup if it
-isn't set yet.
-
## ACL Changes
### ACLs: refs/for/ namespace is now deprecated
@@ -164,11 +185,6 @@
[Flogger](https://github.com/google/flogger) is a fluent logging API for Java
and Gerrit is using Flogger instead of SLF4J now.
- The logging backend is still LOG4J. For this the Flogger LOG4J backend is
- configured by a system property
- (`flogger.backend_factory=com.google.common.flogger.backend.log4j.Log4jBackendFactory#getInstance`).
- Gerrit sets this system property automatically on startup if it isn't set yet.
-
* Update greenmail to 1.5.5
* Update gson to 2.8.2
