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

updated documents

Browse Source
This commit is contained in:
Craig Yamato
2018-09-25 19:12:40 +00:00
parent eb3d0b5470
commit 1b83a3e15d
14 changed files with 1292 additions and 1316 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
docs/module-SyslogPro-CEF.html
View File

@ -52,15 +52,15 @@
<div class="class-description">A class to work with HP CEF (Common Event Format) messages. This form
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
formatted message produced by this module can be saved externally to it) or
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
the input into the formatting classes so that it may run independently. 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>
a logging stream. This class is meant to be used once per message.</div>
</header>
@ -87,7 +87,7 @@ a logging stream. This class is ment to be used once per message.</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#line1869">line 1869</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1868">line 1868</a>
</li></ul></dd>
@ -133,7 +133,7 @@ a logging stream. This class is ment to be used once per message.</div>
<div class="description">
Construct a new CEF formating object with user options
Construct a new CEF formatting object with user options
</div>
@ -262,7 +262,7 @@ a logging stream. This class is ment to be used once per message.</div>
<td class="description last">The vendor of the system
that genrated the event being reported</td>
that generated the event being reported</td>
</tr>
@ -421,7 +421,7 @@ a logging stream. This class is ment to be used once per message.</div>
</td>
<td class="description last">Name of the service genrating
<td class="description last">Name of the service generating
the notice</td>
</tr>
@ -500,7 +500,7 @@ a logging stream. This class is ment to be used once per message.</div>
</td>
<td class="description last">Any CEF Key=Value extentions</td>
<td class="description last">Any CEF Key=Value extensions</td>
</tr>
@ -610,7 +610,7 @@ a logging stream. This class is ment to be used once per message.</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#line1892">line 1892</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1891">line 1891</a>
</li></ul></dd>
@ -669,7 +669,7 @@ a logging stream. This class is ment to be used once per message.</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#line1901">line 1901</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1900">line 1900</a>
</li></ul></dd>
@ -738,7 +738,7 @@ a logging stream. This class is ment to be used once per message.</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#line1897">line 1897</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1896">line 1896</a>
</li></ul></dd>
@ -807,7 +807,7 @@ a logging stream. This class is ment to be used once per message.</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#line1895">line 1895</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1894">line 1894</a>
</li></ul></dd>
@ -876,7 +876,7 @@ a logging stream. This class is ment to be used once per message.</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#line1899">line 1899</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1898">line 1898</a>
</li></ul></dd>
@ -945,7 +945,7 @@ a logging stream. This class is ment to be used once per message.</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#line1907">line 1907</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1906">line 1906</a>
</li></ul></dd>
@ -1014,7 +1014,7 @@ a logging stream. This class is ment to be used once per message.</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#line1903">line 1903</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1902">line 1902</a>
</li></ul></dd>
@ -1083,7 +1083,7 @@ a logging stream. This class is ment to be used once per message.</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#line2069">line 2069</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line2068">line 2068</a>
</li></ul></dd>
@ -1142,7 +1142,7 @@ a logging stream. This class is ment to be used once per message.</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#line1905">line 1905</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1904">line 1904</a>
</li></ul></dd>
@ -1221,7 +1221,7 @@ a logging stream. This class is ment to be used once per message.</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#line2309">line 2309</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line2308">line 2308</a>
</li></ul></dd>
@ -1327,7 +1327,7 @@ a logging stream. This class is ment to be used once per message.</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#line2336">line 2336</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line2335">line 2335</a>
</li></ul></dd>
@ -1477,7 +1477,7 @@ a logging stream. This class is ment to be used once per message.</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#line2081">line 2081</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line2080">line 2080</a>
</li></ul></dd>
@ -1547,7 +1547,7 @@ a logging stream. This class is ment to be used once per message.</div>
<dl>
<dt>
<div class="param-desc">
- First element to fail valadation
- First element to fail validation
</div>
</dt>
<dd></dd>
@ -1575,7 +1575,7 @@ a logging stream. This class is ment to be used once per message.</div>
<div class="param-desc">
- True if valadated
- True if validated
</div>
@ -1615,7 +1615,7 @@ a logging stream. This class is ment to be used once per message.</div>
<br class="clear">
<footer>
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.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Sep 25 2018 19:11:53 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>