log4js

<!doctype html> <html> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="chrome=1"> <title>log4js-node by nomiddlename</title> <link rel="stylesheet" href="/assets/css/style.css?v=a7f232b4c6654881e6a8bd2ac48ee149603d74de"> <meta name="viewport" content="width=device-width">  </head> <body> <div class="wrapper"> <header> <h1>log4js-node</h1> A port of log4js to node.js <a href="http://github.com/nomiddlename/log4js-node">View the Project on GitHub </a> <ul> <li><a href="index.html">Home</a></li> <li><a href="api.html">API</a></li> <li><a href="appenders.html">Appenders</a></li> <li><a href="layouts.html">Layouts</a></li> <li><a href="terms.html">Terminology</a></li> <li><a href="faq.html">FAQ</a></li> <li><a href="contrib-guidelines.html">Want to help?</a></li> <li><a href="contributors.html">Contributors</a></li> </ul> </header> <section> <h1 id="connect--express-logger">Connect / Express Logger</h1> The connect/express logger was added to log4js by <a href="https://github.com/danbell">danbell</a>. This allows connect/express servers to log using log4js. See <code class="highlighter-rouge">example-connect-logger.js</code>. <div class="language-javascript highlighter-rouge"><pre class="highlight"><code>var log4js = require('./lib/log4js'); var express = require('express'); log4js.configure({ appenders: { console: { type: 'console' }, file: { type: 'file', filename: 'cheese.log' } }, categories: { cheese: { appenders: ['file'], level: 'info' }, default: { appenders: ['console'], level: 'info' } } }); var logger = log4js.getLogger('cheese'); var app = express(); app.use(log4js.connectLogger(logger, { level: 'info' })); app.get('/', function(req,res) { res.send('hello world'); }); app.listen(5000); </code></pre> </div> The log4js.connectLogger supports the passing of an options object that can be used to set the following: <ul> <li>log level</li> <li>log format string (the same as the connect/express logger)</li> <li>nolog expressions (represented as a string, regexp, or array)</li> </ul> The options object that is passed to log4js.connectLogger supports a format string the same as the connect/express logger. For example: <div class="language-javascript highlighter-rouge"><pre class="highlight"><code>app.use(log4js.connectLogger(logger, { level: log4js.levels.INFO, format: ':method :url' })); </code></pre> </div> Added automatic level detection to connect-logger, depends on http status response, compatible with express 3.x and 4.x. <ul> <li>http responses 3xx, level = WARN</li> <li>http responses 4xx & 5xx, level = ERROR</li> <li>else, level = INFO</li> </ul> <div class="language-javascript highlighter-rouge"><pre class="highlight"><code>app.use(log4js.connectLogger(logger, { level: 'auto' })); </code></pre> </div> The log4js.connectLogger also supports a nolog option where you can specify a string, regexp, or array to omit certain log messages. Example of 1.2 below. <div class="language-javascript highlighter-rouge"><pre class="highlight"><code>app.use(log4js.connectLogger(logger, { level: 'auto', format: ':method :url', nolog: '\\.gif|\\.jpg$' })); </code></pre> </div> <h2 id="example-nolog-values">Example nolog values</h2> <table> <thead> <tr> <th>nolog value</th> <th>Will Not Log</th> <th>Will Log</th> </tr> </thead> <tbody> <tr> <td><code class="highlighter-rouge">"\\.gif"</code></td> <td>http://example.com/hoge.gif http://example.com/hoge.gif?fuga</td> <td>http://example.com/hoge.agif</td> </tr> <tr> <td><code class="highlighter-rouge">"\\.gif\|\\.jpg$"</code></td> <td>http://example.com/hoge.gif http://example.com/hoge.gif?fuga http://example.com/hoge.jpg?fuga</td> <td>http://example.com/hoge.agif http://example.com/hoge.ajpg http://example.com/hoge.jpg?hoge</td> </tr> <tr> <td><code class="highlighter-rouge">"\\.(gif\|jpe?g\|png)$"</code></td> <td>http://example.com/hoge.gif http://example.com/hoge.jpeg</td> <td>http://example.com/hoge.gif?uid=2 http://example.com/hoge.jpg?pid=3</td> </tr> <tr> <td><code class="highlighter-rouge">/\.(gif\|jpe?g\|png)$/</code></td> <td>as above</td> <td>as above</td> </tr> <tr> <td><code class="highlighter-rouge">["\\.jpg$", "\\.png", "\\.gif"]</code></td> <td>same as <code class="highlighter-rouge">"\\.jpg\|\\.png\|\\.gif"</code></td> <td>same as <code class="highlighter-rouge">"\\.jpg\|\\.png\|\\.gif"</code></td> </tr> </tbody> </table> </section> <footer> This project is maintained by <a href="http://github.com/nomiddlename">nomiddlename</a> Hosted on GitHub Pages — Theme by <a href="https://github.com/orderedlist">orderedlist</a> </footer> </div> <script src="/assets/js/scale.fix.js"></script> </body> </html>