LOG4J2-1412 document system property log4j.unbox.ringbuffer.size
Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/3aa04f96 Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/3aa04f96 Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/3aa04f96 Branch: refs/heads/LOG4J2-1395 Commit: 3aa04f96b04bf140cbd14bac6a180cbf1e056f1d Parents: 739f8f3 Author: rpopma <[email protected]> Authored: Mon Jun 6 22:16:56 2016 +0900 Committer: rpopma <[email protected]> Committed: Mon Jun 6 22:16:56 2016 +0900 ---------------------------------------------------------------------- src/site/xdoc/manual/configuration.xml.vm | 13 +++++++++++++ 1 file changed, 13 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/3aa04f96/src/site/xdoc/manual/configuration.xml.vm ---------------------------------------------------------------------- diff --git a/src/site/xdoc/manual/configuration.xml.vm b/src/site/xdoc/manual/configuration.xml.vm index d78c632..3808d4d 100644 --- a/src/site/xdoc/manual/configuration.xml.vm +++ b/src/site/xdoc/manual/configuration.xml.vm @@ -1985,6 +1985,19 @@ public class AwesomeTest { <td>In GC-free mode, this property determines the maximum size of the reusable StringBuilders where the message text is formatted and potentially passed to background threads.</td> </tr> + + <tr> + <td><a name="log4j.unbox.ringbuffer.size" />log4j.unbox.ringbuffer.size</td> + <td>32</td> + <td>The <tt>org.apache.logging.log4j.util.Unbox</tt> utility + manages a small thread-local ring buffer of StringBuilders. + Each time one of the <tt>box()</tt> methods is called, the next slot in the ring buffer is used, until the ring + buffer is full and the first slot is reused. By default the Unbox ring buffer has 32 slots, so user code can + have up to 32 boxed primitives in a single logger call. + <p> + If more slots are required, set system property <tt>log4j.unbox.ringbuffer.size</tt> to the desired ring buffer size. + Note that the specified number will be rounded up to the nearest power of 2.</p></td> + </tr> </table> </subsection>
