You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by ck...@apache.org on 2019/06/18 01:25:51 UTC
[logging-log4j2] 02/02: LOG4J2-2606 documentation
This is an automated email from the ASF dual-hosted git repository.
ckozak pushed a commit to branch release-2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit 7908b79560c2ce9b115ca9ed6a7bfd3d311a6159
Author: Carter Kozak <ck...@apache.org>
AuthorDate: Mon Jun 17 21:11:09 2019 -0400
LOG4J2-2606 documentation
---
src/site/xdoc/manual/async.xml | 28 ++++++++++++++++++++++++++++
src/site/xdoc/manual/configuration.xml.vm | 22 ++++++++++++++++++++++
2 files changed, 50 insertions(+)
diff --git a/src/site/xdoc/manual/async.xml b/src/site/xdoc/manual/async.xml
index 48340b6..e50909b 100644
--- a/src/site/xdoc/manual/async.xml
+++ b/src/site/xdoc/manual/async.xml
@@ -255,6 +255,20 @@
</td>
</tr>
<tr>
+ <td>AsyncLogger.SynchronizeEnqueueWhenQueueFull</td>
+ <td>
+ <tt>true</tt>
+ </td>
+ <td>
+ Synchronizes access to the Disruptor ring buffer for blocking enqueue operations when the queue is full.
+ Users encountered excessive CPU utilization with Disruptor v3.4.2 when the application
+ was logging more than the underlying appender could keep up with and the ring buffer became full,
+ especially when the number of application threads vastly outnumbered the number of cores.
+ CPU utilization is significantly reduced by restricting access to the enqueue operation. Setting this value
+ to <tt>false</tt> may lead to very high CPU utilization when the async logging queue is full.
+ </td>
+ </tr>
+ <tr>
<td>log4j2.asyncLoggerThreadNameStrategy</td>
<td>
<tt>CACHED</tt>
@@ -434,6 +448,20 @@
in order to get the message logged to disk sooner.
</td>
</tr>
+ <tr>
+ <td>AsyncLoggerConfig.SynchronizeEnqueueWhenQueueFull</td>
+ <td>
+ <tt>true</tt>
+ </td>
+ <td>
+ Synchronizes access to the Disruptor ring buffer for blocking enqueue operations when the queue is full.
+ Users encountered excessive CPU utilization with Disruptor v3.4.2 when the application
+ was logging more than the underlying appender could keep up with and the ring buffer became full,
+ especially when the number of application threads vastly outnumbered the number of cores.
+ CPU utilization is significantly reduced by restricting access to the enqueue operation. Setting this value
+ to <tt>false</tt> may lead to very high CPU utilization when the async logging queue is full.
+ </td>
+ </tr>
</table>
<p>
There are also a few system properties that can be used to maintain application throughput even when
diff --git a/src/site/xdoc/manual/configuration.xml.vm b/src/site/xdoc/manual/configuration.xml.vm
index 0c7f60d..727a323 100644
--- a/src/site/xdoc/manual/configuration.xml.vm
+++ b/src/site/xdoc/manual/configuration.xml.vm
@@ -2162,6 +2162,17 @@ public class AwesomeTest {
</td>
</tr>
<tr>
+ <td><a name="AsyncLogger.SynchronizeEnqueueWhenQueueFull"/>AsyncLogger.SynchronizeEnqueueWhenQueueFull
+ </td>
+ <td>ASYNC_LOGGER_SYNCHRONIZE_ENQUEUE_WHEN_QUEUE_FULL</td>
+ <td>
+ true
+ </td>
+ <td>
+ See <a href="async.html#SysPropsAllAsync">Async Logger System Properties</a> for details.
+ </td>
+ </tr>
+ <tr>
<td><a name="asyncLoggerThreadNameStrategy"/>log4j2.asyncLoggerThreadNameStrategy
<br />
(<a name="AsyncLogger.ThreadNameStrategy"/>AsyncLogger.ThreadNameStrategy)
@@ -2210,6 +2221,17 @@ public class AwesomeTest {
</td>
</tr>
<tr>
+ <td><a name="AsyncLoggerConfig.SynchronizeEnqueueWhenQueueFull"/>AsyncLoggerConfig.SynchronizeEnqueueWhenQueueFull
+ </td>
+ <td>ASYNC_LOGGER_CONFIG_SYNCHRONIZE_ENQUEUE_WHEN_QUEUE_FULL</td>
+ <td>
+ true
+ </td>
+ <td>
+ See <a href="async.html#SysPropsMixedSync-Async">Mixed Async/Synchronous Logger System Properties</a> for details.
+ </td>
+ </tr>
+ <tr>
<td><a name="julLoggerAdapter"/>log4j2.julLoggerAdapter
<br />
(<a name="log4j.jul.LoggerAdapter"/>log4j.jul.LoggerAdapter)