Repository: logging-log4j2 Updated Branches: refs/heads/master f3ddb8398 -> b4150daa4
LOG4J2-1595 document current status of Filter garbage-freedom on the site Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/b4150daa Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/b4150daa Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/b4150daa Branch: refs/heads/master Commit: b4150daa47e47b10092e15b47362412fdbbddff6 Parents: f3ddb83 Author: rpopma <rpo...@apache.org> Authored: Sun Sep 18 20:19:44 2016 +0900 Committer: rpopma <rpo...@apache.org> Committed: Sun Sep 18 20:19:44 2016 +0900 ---------------------------------------------------------------------- src/site/site.xml | 1 + src/site/xdoc/manual/garbagefree.xml | 16 ++++++++++++++++ 2 files changed, 17 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/b4150daa/src/site/site.xml ---------------------------------------------------------------------- diff --git a/src/site/site.xml b/src/site/site.xml index 971e444..9db99eb 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -183,6 +183,7 @@ <item name="Configuration" href="/manual/garbagefree.html#Config"/> <item name="Supported Appenders" href="/manual/garbagefree.html#Appenders"/> <item name="Supported Layouts" href="/manual/garbagefree.html#Layouts"/> + <item name="Supported Filters" href="/manual/garbagefree.html#Filters"/> <item name="API Changes" href="/manual/garbagefree.html#api"/> <item name="Impact on Application Code" href="/manual/garbagefree.html#codeImpact"/> <item name="Performance" href="/manual/garbagefree.html#Performance"/> http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/b4150daa/src/site/xdoc/manual/garbagefree.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/manual/garbagefree.xml b/src/site/xdoc/manual/garbagefree.xml index fb683fe..9a71ccc 100644 --- a/src/site/xdoc/manual/garbagefree.xml +++ b/src/site/xdoc/manual/garbagefree.xml @@ -306,6 +306,22 @@ </td></tr></table> + <a name="Filters" /> + <h4>Supported Filters</h4> + <p> + The following <a href="filters.html">filters</a> are garbage-free during steady-state logging: + </p> + <ul> + <li>CompositeFilter (adding and removing element filters creates temporary objects for thread safety)</li> + <li>DynamicThresholdFilter</li> + </ul> + <p>Currently the other filter implementations allocate temporary objects during steady state logging. + We expect to be able to make the following filters garbage-free in a subsequent release: + LevelRangeFilter, MapFilter, MarkerFilter, ThreadContextMapFilter and ThresholdFilter.</p> + <p> + Other filters like BurstFilter, RegexFilter and ScriptFilter are not trivial to make garbage free, + and there is currently no plan to change them. + </p> <a name="api" /> <h4>API Changes</h4> <p>
