155 lines
4.6 KiB
HTML
Executable File
155 lines
4.6 KiB
HTML
Executable File
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<title>LuaLogging: A simple API to use logging features in Lua</title>
|
|
<link rel="stylesheet" href="http://www.keplerproject.org/doc.css" type="text/css"/>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
|
</head>
|
|
<body>
|
|
|
|
<div id="container">
|
|
|
|
<div id="product">
|
|
<div id="product_logo"><a href="http://www.keplerproject.org">
|
|
<img alt="LuaLogging logo" src="images/lualogging-128.png"/>
|
|
</a></div>
|
|
<div id="product_name"><big><strong>LuaLogging</strong></big></div>
|
|
<div id="product_description">A simple API to use logging features in Lua. <a href="br/">Portuguese version.</a></div>
|
|
</div> <!-- id="product" -->
|
|
|
|
<div id="main">
|
|
|
|
<div id="navigation">
|
|
<h1>LuaLogging</h1>
|
|
<ul>
|
|
<li><a href="index.html">Home</a>
|
|
<ul>
|
|
<li><a href="index.html#overview">Overview</a></li>
|
|
<li><a href="index.html#status">Status</a></li>
|
|
<li><a href="index.html#download">Download</a></li>
|
|
<li><a href="index.html#dependencies">Dependencies</a></li>
|
|
<li><a href="index.html#history">History</a></li>
|
|
<li><a href="index.html#credits">Credits</a></li>
|
|
<li><a href="index.html#contact">Contact</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="manual.html">Manual</a>
|
|
<ul>
|
|
<li><a href="manual.html#introduction">Introduction</a></li>
|
|
<li><a href="manual.html#installation">Installation</a></li>
|
|
<li><a href="manual.html#logger">Logger objects</a></li>
|
|
<li><a href="manual.html#examples">Examples</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="manual.html#appenders">Appenders</a>
|
|
<ul>
|
|
<li><a href="console.html">Console</a></li>
|
|
<li><a href="file.html">File</a></li>
|
|
<li><a href="rolling_file.html">Rolling File</a></li>
|
|
<li><a href="sql.html">SQL</a></li>
|
|
<li><a href="socket.html">Socket</a></li>
|
|
<li><strong>Email</strong></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="https://github.com/Neopallium/lualogging">Project</a>
|
|
<ul>
|
|
<li><a href="https://github.com/Neopallium/lualogging/issues">Bug Tracker</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="license.html">License</a></li>
|
|
</ul>
|
|
</div> <!-- id="navigation" -->
|
|
|
|
<div id="content">
|
|
|
|
<h2>Email appender</h2>
|
|
|
|
<p>This appender can be used to send log requests through email. One email
|
|
message is sent for each log request.</p>
|
|
|
|
<pre class="example">
|
|
function logging.email {
|
|
from = <i>string</i>,
|
|
rcpt = <i>string</i> or <i>string-table</i>,
|
|
[user = <i>string</i>,]
|
|
[password = <i>string</i>,]
|
|
[server = <i>string</i>,]
|
|
[port = <i>number</i>,]
|
|
[domain = <i>string</i>,]
|
|
[headers = <i>table</i>,]
|
|
[logPattern = <i>string</i>,]
|
|
}
|
|
</pre>
|
|
|
|
<ul>
|
|
<li><code>from</code>:<br />
|
|
The sender of the email message.</li>
|
|
|
|
<li><code>rcpt</code>:<br />
|
|
The recipient of the email message. A string or a numerically indexed Lua table with strings.</li>
|
|
|
|
<li><code>user</code>:<br />
|
|
User for authentication.</li>
|
|
|
|
<li><code>password</code>:<br />
|
|
Password for authentication.</li>
|
|
|
|
<li><code>server</code>:<br />
|
|
Server to connect to. Default is <code>"localhost"</code>.</li>
|
|
|
|
<li><code>port</code>:<br />
|
|
Port to connect to. Default is <code>25</code>.</li>
|
|
|
|
<li><code>domain</code>:<br />
|
|
Domain name used to greet the server. Defaults to the local
|
|
machine host name.</li>
|
|
|
|
<li><code>headers.to</code>:<br />
|
|
The recipient of the message, as an extended description.</li>
|
|
|
|
<li><code>headers.from</code>:<br />
|
|
The sender of the message, as an extended description.</li>
|
|
|
|
<li><code>headers.subject</code>:<br />
|
|
The subject of the message sent. This can contain patterns like
|
|
the <code>logPattern</code> parameter.</li>
|
|
|
|
<li><code>logPattern</code>:<br />
|
|
A pattern can be specified to control how the message is
|
|
written.<br />
|
|
The default value is <code>"%date %level %message\n"</code>.</li>
|
|
</ul>
|
|
|
|
<h2>Example</h2>
|
|
|
|
<pre class="example">
|
|
require"logging.email"
|
|
|
|
local logger = logging.email {
|
|
rcpt = "mail@host.com",
|
|
from = "mail@host.com",
|
|
headers = {
|
|
subject = "[%level] logging.email test",
|
|
},
|
|
}
|
|
|
|
logger:info("logging.sql test")
|
|
logger:debug("debugging...")
|
|
logger:error("error!")
|
|
</pre>
|
|
|
|
</div> <!-- id="content" -->
|
|
|
|
</div> <!-- id="main" -->
|
|
|
|
<div id="about">
|
|
<p><a href="http://validator.w3.org/check?uri=referer">
|
|
<img src="http://www.w3.org/Icons/valid-xhtml10" alt="XHTML 1.0 válido!" height="31" width="88" /></a></p>
|
|
</div> <!-- id="about" -->
|
|
|
|
</div> <!-- id="container" -->
|
|
|
|
</body>
|
|
</html>
|