log4js

Version:

Port of Log4js to work with node.

nomiddlename.github.io/log4js-node/

nomiddlename/log4js-node

112 lines (83 loc) • 9.61 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="frequently-asked-questions">Frequently Asked Questions</h1> <h2 id="i-want-errors-to-go-to-a-special-file-but-still-want-everything-written-to-another-file---how-do-i-do-that">I want errors to go to a special file, but still want everything written to another file - how do I do that?</h2> You’ll need to use the <a href="/logLevelFilter.html">logLevelFilter</a>. Here’s an example configuration: <div class="language-javascript highlighter-rouge"><pre class="highlight"><code>log4js.configure({ appenders: { everything: { type: 'file', filename: 'all-the-logs.log' }, emergencies: { type: 'file', filename: 'oh-no-not-again.log' }, 'just-errors': { type: 'logLevelFilter', appender: 'emergencies', level: 'error' } }, categories: { default: { appenders: ['just-errors', 'everything'], level: 'debug' } } }); const logger = log4js.getLogger(); logger.debug('This goes to all-the-logs.log'); logger.info('As does this.'); logger.error('This goes to all-the-logs.log and oh-no-not-again.log'); </code></pre> </div> <h2 id="i-want-to-reload-the-configuration-when-i-change-my-config-file---how-do-i-do-that">I want to reload the configuration when I change my config file - how do I do that?</h2> Previous versions of log4js used to watch for changes in the configuration file and reload when it changed. It didn’t always work well, sometimes leaving file handles or sockets open. This feature was removed in version 2.x. As a replacement, I’d suggest using a library like <a href="https://www.npmjs.com/package/watchr">watchr</a> to notify you of file changes. Then you can call <code class="highlighter-rouge">log4js.shutdown</code> followed by <code class="highlighter-rouge">log4js.configure</code> again. <h2 id="what-happened-to-replaceconsole---it-doesnt-work-any-more">What happened to <code class="highlighter-rouge">replaceConsole</code> - it doesn’t work any more?</h2> I removed <code class="highlighter-rouge">replaceConsole</code> - it caused a few weird errors, and I wasn’t entirely comfortable with messing around with a core part of node. If you still want to do this, then code like this should do the trick: <div class="language-javascript highlighter-rouge"><pre class="highlight"><code>log4js.configure(...); // set up your categories and appenders const logger = log4js.getLogger('console'); console.log = logger.info.bind(logger); // do the same for others - console.debug, etc. </code></pre> </div> <h2 id="im-using-pm2-but-im-not-getting-any-logs">I’m using PM2, but I’m not getting any logs!</h2> To get log4js working with PM2, you’ll need to install the <a href="https://www.npmjs.com/package/pm2-intercom">pm2-intercom</a> module. <div class="language-bash highlighter-rouge"><pre class="highlight"><code>pm2 install pm2-intercom </code></pre> </div> Then add the value <code class="highlighter-rouge">pm2: true</code> to your log4js configuration. If you’re also using <code class="highlighter-rouge">node-config</code>, then you’ll probably have renamed your <code class="highlighter-rouge">NODE_APP_INSTANCE</code> environment variable. If so, you’ll also need to add <code class="highlighter-rouge">pm2InstanceVar: '<NEW_APP_INSTANCE_ID>'</code> where <code class="highlighter-rouge"><NEW_APP_INSTANCE_ID></code> should be replaced with the new name you gave the instance environment variable. <div class="language-javascript highlighter-rouge"><pre class="highlight"><code>log4js.configure({ appenders: { out: { type: 'stdout'}}, categories: { default: { appenders: ['out'], level: 'info'}}, pm2: true, pm2InstanceVar: 'INSTANCE_ID' }); </code></pre> </div> <h2 id="npm-complains-about-nodemailer-being-deprecated-what-should-i-do">NPM complains about nodemailer being deprecated, what should I do?</h2> Nodemailer version 4.0.1 (the not-deprecated version) requires a node version >= 6, but log4js supports node versions >= 4. So until I stop supporting node versions less than 6 I can’t update the dependency. It’s only an optional dependency anyway, so you’re free to install nodemailer@4.0.1 if you want - as far as I know it should work, the API looks the same to me. If you know that the smtp appender definitely doesn’t work with nodemailer v4, then please create an issue with some details about the problem. </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>