logging-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ihabu...@apache.org
Subject [2/5] git commit: LOG4PHP-153: Updated LoggerAppenderMail docs
Date Mon, 07 Jan 2013 14:34:18 GMT
LOG4PHP-153: Updated LoggerAppenderMail docs

Added docs for bufferSize parameter and buffering.

Removed bit which recommended using LoggerAppenderMailEvent which will
soon be made deprecated.

Signed-off-by: Ivan Habunek <ihabunek@apache.org>

Project: http://git-wip-us.apache.org/repos/asf/logging-log4php/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4php/commit/549e88c5
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4php/tree/549e88c5
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4php/diff/549e88c5

Branch: refs/heads/LOG4PHP-153
Commit: 549e88c5aa5813986a8e2f6b2361f54125d803cb
Parents: a513de0
Author: Ivan Habunek <ihabunek@apache.org>
Authored: Mon Jan 7 14:56:49 2013 +0100
Committer: Ivan Habunek <ihabunek@apache.org>
Committed: Mon Jan 7 14:56:49 2013 +0100

 src/site/xdoc/docs/appenders/mail.xml |   38 ++++++++++++++++++++++++---
 1 files changed, 33 insertions(+), 5 deletions(-)

diff --git a/src/site/xdoc/docs/appenders/mail.xml b/src/site/xdoc/docs/appenders/mail.xml
index 2eb46f1..21a6636 100644
--- a/src/site/xdoc/docs/appenders/mail.xml
+++ b/src/site/xdoc/docs/appenders/mail.xml
@@ -26,11 +26,6 @@
 		<section name="LoggerAppenderMail">
 			<p><code>LoggerAppenderMail</code> appends log events via email.</p>
-			<p>This appender does not send individual emails for each logging requests but will
collect them in a 
-			buffer and send them all in a single email once the appender is closed (i.e. when the
script exists). 
-			Because of this, it may not appropriate for long running scripts, in which case
-			<code><a href="mail-event.html">LoggerAppenderMailEvent</a></code>
might be a better choice.</p>
 			<p class="alert alert-warning"><strong>Note:</strong> When working in
Windows, make sure that the 
 			<code>SMTP</code> and <code>smpt_port</code> values in php.ini
are set to the correct values for 
@@ -77,11 +72,44 @@
 							<td>Log4php Report</td>
 							<td>Subject of the email message.</td>
+						<tr>
+							<td>bufferSize</td>
+							<td>integer</td>
+							<td>No</td>
+							<td>null</td>
+							<td>If set, determines how many messages will be buffered before sending them
to the 
+							recipient. If not set, all messages will be sent when the appender is closed.</td>
+						</tr>
+			</subsection>
+			<subsection name="Changelog">
+				<table class="table table-striped table-bordered table-not-wide">
+					<thead>
+						<tr>
+							<th>Version</th>
+							<th>Description</th>
+						</tr>
+					</thead>
+					<tbody>
+                        <tr>
+                            <td><code>3.0.0</code></td>
+                            <td>Added buffering and the <em>bufferSize</em>
+                        </tr>
+					</tbody>
+				</table>
+			<subsection name="Buffering">
+				<p>The <code>bufferSize</code> parameter determines how many messages
will be buffered before sending
+				them together in a single email. When not set, all messages will be buffered, and the
email will not
+				be sent until the script exits.</p>
+				<p>Setting the <code>bufferSize</code> to 1 means that each message
will be sent in it's own email.
+				Setting it to 5 means that messages will be sent in batches of 5, etc...</p>
+			</subsection>
 			<subsection name="Examples">
 				<p>This example shows how to configure <code>LoggerAppenderMail</code>
to send the log to two email 

View raw message