sim1222/SyslogPro
1
0
Fork 0
mirror of https://github.com/misskey-dev/SyslogPro.git synced 2025-08-04 23:23:56 +09:00
Code Issues Packages Projects Releases Wiki Activity

Updated Readme

Browse Source
This commit is contained in:
Craig Yamato
2018-09-25 18:23:58 +00:00
parent b6a4870f1b
commit 00b72a3f57
28 changed files with 8448 additions and 253 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/module-SyslogPro-LEEF.html
View File

@ -53,7 +53,14 @@
of system messages are designed to work with security systems. Messages can
be saved to file (Saving to file if not part of this module but a LEEF
formated mesage produced by this module can be saved externaly to it) or
sent via Syslog.</div>
sent via Syslog.
Most APIs will return a promise. These APIs can be used using
`then(...)/catch(...)`
A Syslog class with a configured Syslog server target can also be used as
the input into the formating classes so that it may run independtly. The
LEEF format is designed to send event data to a SIEM system and should not
be as a logging stream. This class is ment to be used once per message.</div>
</header>
@ -80,7 +87,7 @@ sent via Syslog.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1669">line 1669</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1705">line 1705</a>
</li></ul></dd>
@ -126,7 +133,7 @@ sent via Syslog.</div>
<div class="description">
Construct a new LEEF object with user options
Construct a new LEEF formating object with user options
</div>
@ -564,7 +571,7 @@ sent via Syslog.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1707">line 1707</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1743">line 1743</a>
</li></ul></dd>
@ -633,7 +640,7 @@ sent via Syslog.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1693">line 1693</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1729">line 1729</a>
</li></ul></dd>
@ -692,7 +699,7 @@ sent via Syslog.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1702">line 1702</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1738">line 1738</a>
</li></ul></dd>
@ -761,7 +768,7 @@ sent via Syslog.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1698">line 1698</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1734">line 1734</a>
</li></ul></dd>
@ -830,7 +837,7 @@ sent via Syslog.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1758">line 1758</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1794">line 1794</a>
</li></ul></dd>
@ -889,7 +896,7 @@ sent via Syslog.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1704">line 1704</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1740">line 1740</a>
</li></ul></dd>
@ -958,7 +965,7 @@ sent via Syslog.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1696">line 1696</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1732">line 1732</a>
</li></ul></dd>
@ -1027,7 +1034,7 @@ sent via Syslog.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1700">line 1700</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1736">line 1736</a>
</li></ul></dd>
@ -1106,7 +1113,7 @@ sent via Syslog.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1769">line 1769</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1805">line 1805</a>
</li></ul></dd>
@ -1212,7 +1219,7 @@ sent via Syslog.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1797">line 1797</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1833">line 1833</a>
</li></ul></dd>
@ -1365,7 +1372,7 @@ sent via Syslog.</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Sep 24 2018 06:41:35 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Sep 25 2018 18:22:00 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>