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="log4js---appenders">Log4js - Appenders</h1> Appenders serialise log events to some form of output. They can write to files, send emails, send data over the network. All appenders have a <code class="highlighter-rouge">type</code> which determines which appender gets used. For example: <div class="language-javascript highlighter-rouge"><pre class="highlight"><code>const log4js = require('log4js'); log4js.configure({ appenders: { out: { type: 'stdout' }, app: { type: 'file', filename: 'application.log' } }, categories: { default: { appenders: [ 'out', 'app' ], level: 'debug' } } }); </code></pre> </div> This defines two appenders named ‘out’ and ‘app’. ‘out’ uses the <a href="/stdout.html">stdout</a> appender which writes to standard out. ‘app’ uses the <a href="/file.html">file</a> appender, configured to write to ‘application.log’. <h2 id="core-appenders">Core Appenders</h2> The following appenders are included with log4js. Some require extra dependencies that are not included as part of log4js (the <a href="/smtp.html">smtp</a> appender needs <a href="https://www.npmjs.org/packages/nodemailer">nodemailer</a> for example), and these will be noted in the docs for that appender. If you don’t use those appenders, then you don’t need the extra dependencies. <ul> <li><a href="/categoryFilter.html">categoryFilter</a></li> <li><a href="/console.html">console</a></li> <li><a href="/dateFile.html">dateFile</a></li> <li><a href="/file.html">file</a></li> <li><a href="/fileSync.html">fileSync</a></li> <li><a href="/gelf.html">gelf</a></li> <li><a href="/hipchat.html">hipchat</a></li> <li><a href="/logFaces-HTTP.html">logFaces-HTTP</a></li> <li><a href="/logFaces-UDP.html">logFaces-UDP</a></li> <li><a href="/loggly.html">loggly</a></li> <li><a href="/logLevelFilter.html">logLevelFilter</a></li> <li><a href="/logstashUDP.html">logstashUDP</a></li> <li><a href="/mailgun.html">mailgun</a></li> <li><a href="/multiFile.html">multiFile</a></li> <li><a href="/multiprocess.html">multiprocess</a></li> <li><a href="/recording.html">recording</a></li> <li><a href="/redis.html">redis</a></li> <li><a href="/slack.html">slack</a></li> <li><a href="/smtp.html">smtp</a></li> <li><a href="/stderr.html">stderr</a></li> <li><a href="/stdout.html">stdout</a></li> </ul> <h2 id="other-appenders">Other Appenders</h2> Log4js can load appenders from outside the core appenders. The <code class="highlighter-rouge">type</code> config value is used as a require path if no matching appender can be found. For example, the following configuration will attempt to load an appender from the module ‘cheese/appender’, passing the rest of the config for the appender to that module: <div class="language-javascript highlighter-rouge"><pre class="highlight"><code>log4js.configure({ appenders: { gouda: { type: 'cheese/appender', flavour: 'tasty' } }, categories: { default: { appenders: ['gouda'], level: 'debug' }} }); </code></pre> </div> Log4js checks the following places (in this order) for appenders based on the type value: <ol> <li>The core appenders: <code class="highlighter-rouge">require('./appenders/' + type)</code></li> <li>node_modules: <code class="highlighter-rouge">require(type)</code></li> <li>relative to the main file of your application: <code class="highlighter-rouge">require(path.dirname(require.main.filename) + '/' + type)</code></li> <li>relative to the process’ current working directory: <code class="highlighter-rouge">require(process.cwd() + '/' + type)</code></li> </ol> If you want to write your own appender, read the <a href="/writing-appenders.html">documentation</a> first. </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>