log4js
Version:
Port of Log4js to work with node.
89 lines (65 loc) • 4.09 kB
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">
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
</head>
<body>
<div class="wrapper">
<header>
<h1>log4js-node</h1>
<p>A port of log4js to node.js</p>
<p class="view"><a href="http://github.com/nomiddlename/log4js-node">View the Project on GitHub <small></small></a></p>
<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="mailgun-appender">Mailgun Appender</h1>
<p>This appender uses the <a href="https://www.mailgun.com">mailgun</a> service to send log messages as emails. It requires the <a href="https://www.npmjs.com/package/mailgun-js">mailgun-js</a> package to be added to your dependencies.</p>
<h2 id="configuration">Configuration</h2>
<ul>
<li><code class="highlighter-rouge">type</code> - <code class="highlighter-rouge">mailgun</code></li>
<li><code class="highlighter-rouge">apiKey</code> - <code class="highlighter-rouge">string</code> - your mailgun API key</li>
<li><code class="highlighter-rouge">domain</code> - <code class="highlighter-rouge">string</code> - your domain</li>
<li><code class="highlighter-rouge">from</code> - <code class="highlighter-rouge">string</code></li>
<li><code class="highlighter-rouge">to</code> - <code class="highlighter-rouge">string</code></li>
<li><code class="highlighter-rouge">subject</code> - <code class="highlighter-rouge">string</code></li>
<li><code class="highlighter-rouge">layout</code> - <code class="highlighter-rouge">object</code> (optional, defaults to basicLayout) - see <a href="/layouts.html">layouts</a></li>
</ul>
<p>The body of the email will be the result of applying the layout to the log event. Refer to the mailgun docs for how to obtain your API key.</p>
<h2 id="example">Example</h2>
<div class="language-javascript highlighter-rouge"><pre class="highlight"><code><span class="nx">log4js</span><span class="p">.</span><span class="nx">configure</span><span class="p">({</span>
<span class="na">appenders</span><span class="p">:</span> <span class="p">{</span>
<span class="na">type</span><span class="p">:</span> <span class="s1">'mailgun'</span><span class="p">,</span>
<span class="na">apiKey</span><span class="p">:</span> <span class="s1">'123456abc'</span><span class="p">,</span>
<span class="na">domain</span><span class="p">:</span> <span class="s1">'some.company'</span><span class="p">,</span>
<span class="na">from</span><span class="p">:</span> <span class="s1">'logging@some.service'</span><span class="p">,</span>
<span class="na">to</span><span class="p">:</span> <span class="s1">'important.bosses@some.company'</span><span class="p">,</span>
<span class="na">subject</span><span class="p">:</span> <span class="s1">'Error: Developers Need To Be Fired'</span>
<span class="p">}</span>
<span class="p">});</span>
</code></pre>
</div>
</section>
<footer>
<p>This project is maintained by <a href="http://github.com/nomiddlename">nomiddlename</a></p>
<p><small>Hosted on GitHub Pages — Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
</footer>
</div>
<script src="/assets/js/scale.fix.js"></script>
</body>
</html>