sim1222/SyslogPro
1
0
Fork 0
mirror of https://github.com/misskey-dev/SyslogPro.git synced 2025-08-06 16:14:07 +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

39
docs/module-SyslogPro-CEF.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 CEF
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 CEF
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#line1826">line 1826</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1869">line 1869</a>
</li></ul></dd>
@ -126,7 +133,7 @@ sent via Syslog.</div>
<div class="description">
Construct a new CEF object with user options
Construct a new CEF formating object with user options
</div>
@ -603,7 +610,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#line1849">line 1849</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1892">line 1892</a>
</li></ul></dd>
@ -662,7 +669,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#line1858">line 1858</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1901">line 1901</a>
</li></ul></dd>
@ -731,7 +738,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#line1854">line 1854</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1897">line 1897</a>
</li></ul></dd>
@ -800,7 +807,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#line1852">line 1852</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1895">line 1895</a>
</li></ul></dd>
@ -869,7 +876,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#line1856">line 1856</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1899">line 1899</a>
</li></ul></dd>
@ -938,7 +945,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#line1864">line 1864</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1907">line 1907</a>
</li></ul></dd>
@ -1007,7 +1014,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#line1860">line 1860</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1903">line 1903</a>
</li></ul></dd>
@ -1076,7 +1083,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#line2026">line 2026</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line2069">line 2069</a>
</li></ul></dd>
@ -1135,7 +1142,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#line1862">line 1862</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1905">line 1905</a>
</li></ul></dd>
@ -1214,7 +1221,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#line2266">line 2266</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line2309">line 2309</a>
</li></ul></dd>
@ -1320,7 +1327,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#line2293">line 2293</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line2336">line 2336</a>
</li></ul></dd>
@ -1470,7 +1477,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#line2038">line 2038</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line2081">line 2081</a>
</li></ul></dd>
@ -1608,7 +1615,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>