You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by rg...@apache.org on 2015/11/22 04:36:32 UTC
logging-log4j2 git commit: Add documentation for CronTriggeringPolicy
Repository: logging-log4j2
Updated Branches:
refs/heads/master cc2b074b1 -> 2a11b7b07
Add documentation for CronTriggeringPolicy
Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/2a11b7b0
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/2a11b7b0
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/2a11b7b0
Branch: refs/heads/master
Commit: 2a11b7b07bc7652586531d6bd41ad145281d2314
Parents: cc2b074
Author: Ralph Goers <rg...@apache.org>
Authored: Sat Nov 21 20:36:16 2015 -0700
Committer: Ralph Goers <rg...@apache.org>
Committed: Sat Nov 21 20:36:16 2015 -0700
----------------------------------------------------------------------
src/site/xdoc/manual/appenders.xml | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2a11b7b0/src/site/xdoc/manual/appenders.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/manual/appenders.xml b/src/site/xdoc/manual/appenders.xml
index 854ff47..549fed4 100644
--- a/src/site/xdoc/manual/appenders.xml
+++ b/src/site/xdoc/manual/appenders.xml
@@ -2177,6 +2177,24 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity {
<SizeBasedTriggeringPolicy size="20 MB" />
<TimeBasedTriggeringPolicy />
</Policies>]]></pre>
+ <h5>Cron Triggering Policy</h5>
+ <p>The <code>CronTriggeringPolicy</code> triggers rollover based on a cron expression.</p>
+ <table>
+ <caption align="top">CronTriggeringPolicy Parameters</caption>
+ <tr>
+ <th>Parameter Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>schedule</td>
+ <td>String</td>
+ <td>The cron expression. The expression is the same as what is allowed in the Quartz scheduler. See
+ <a href="../log4j-core/apidocs/org/apache/logging/log4j/core/util/CronExpression.html">CronExpression</a>
+ for a full description of the expression.
+ </td>
+ </tr>
+ </table>
<h5>OnStartup Triggering Policy</h5>
<p>
The <code>OnStartupTriggeringPolicy</code> policy takes no parameters and causes a rollover if the log