log4js

Version:

Port of Log4js to work with node.

nomiddlename.github.io/log4js-node/

99 lines (75 loc) • 6.88 kB

HTML

<!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="multiprocess-appender">Multiprocess Appender</h1> The multiprocess appender sends log events to a master server over TCP sockets. It can be used as a simple way to centralise logging when you have multiple servers or processes. It uses the node.js core networking modules, and so does not require any extra dependencies. Remember to call <code class="highlighter-rouge">log4js.shutdown</code> when your application terminates, so that the sockets get closed cleanly. Note that if you’re just using node core’s <code class="highlighter-rouge">cluster</code> module then you don’t need to use this appender - log4js will handle logging within the cluster transparently. <h2 id="configuration">Configuration</h2> <ul> <li><code class="highlighter-rouge">type</code> - <code class="highlighter-rouge">multiprocess</code></li> <li><code class="highlighter-rouge">mode</code> - <code class="highlighter-rouge">master|worker</code> - controls whether the appender listens for log events sent over the network, or is responsible for serialising events and sending them to a server.</li> <li><code class="highlighter-rouge">appender</code> - <code class="highlighter-rouge">string</code> (only needed if <code class="highlighter-rouge">mode</code> == <code class="highlighter-rouge">master</code>)- the name of the appender to send the log events to</li> <li><code class="highlighter-rouge">loggerPort</code> - <code class="highlighter-rouge">integer</code> (optional, defaults to <code class="highlighter-rouge">5000</code>) - the port to listen on, or send to</li> <li><code class="highlighter-rouge">loggerHost</code> - <code class="highlighter-rouge">string</code> (optional, defaults to <code class="highlighter-rouge">localhost</code>) - the host/IP address to listen on, or send to</li> </ul> <h2 id="example-master">Example (master)</h2> <div class="language-javascript highlighter-rouge"><pre class="highlight"><code>log4js.configure({ appenders: { file: { type: 'file', filename: 'all-the-logs.log' }, server: { type: 'multiprocess', mode: 'master', appender: 'file', loggerHost: '0.0.0.0' } }, categories: { default: { appenders: ['file'], level: 'info' } } }); </code></pre> </div> This creates a log server listening on port 5000, on all IP addresses the host has assigned to it. Note that the appender is not included in the appenders listed for the categories. Also note that the multiprocess master appender will send every event it receives to the underlying appender, regardless of level settings. <h2 id="example-worker">Example (worker)</h2> <div class="language-javascript highlighter-rouge"><pre class="highlight"><code>log4js.configure({ appenders: { network: { type: 'multiprocess', mode: 'worker', loggerHost: 'log.server' } }, categories: { default: { appenders: ['network'], level: 'error' } } }); </code></pre> </div> This will send all error messages to <code class="highlighter-rouge">log.server:5000</code>. </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>