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 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-LEEF.html
View File

@ -52,15 +52,15 @@
<div class="class-description">A class to work with IBM LEEF (Log Event Extended 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 LEEF
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
the input into the formatting classes so that it may run independently. 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>
be as a logging stream. This class is meant to be used once per message.</div>
</header>
@ -87,7 +87,7 @@ be as 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#line1705">line 1705</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1704">line 1704</a>
</li></ul></dd>
@ -133,7 +133,7 @@ be as a logging stream. This class is ment to be used once per message.</div>
<div class="description">
Construct a new LEEF formating object with user options
Construct a new LEEF formatting object with user options
</div>
@ -262,7 +262,7 @@ be as 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>
generated the event being reported</td>
</tr>
@ -389,7 +389,7 @@ be as a logging stream. This class is ment to be used once per message.</div>
<tr>
<td class="name"><code>attrabute</code></td>
<td class="name"><code>attributes</code></td>
<td class="type">
@ -419,8 +419,8 @@ be as a logging stream. This class is ment to be used once per message.</div>
</td>
<td class="description last">LEEF message attrabutes which
defualts to all base attrabutes with null values, new attrabutes should
<td class="description last">LEEF message attributes which
defaults to all base attributes with null values, new attributes should
be added as new elements to this object</td>
</tr>
@ -560,7 +560,7 @@ be as a logging stream. This class is ment to be used once per message.</div>
<h4 class="name" id="attrabutes"><span class="type-signature"></span>attrabutes<span class="type-signature"> :object</span></h4>
<h4 class="name" id="attributes"><span class="type-signature"></span>attributes<span class="type-signature"> :object</span></h4>
@ -571,7 +571,7 @@ be as 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#line1743">line 1743</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1742">line 1742</a>
</li></ul></dd>
@ -640,7 +640,7 @@ be as 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#line1729">line 1729</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1728">line 1728</a>
</li></ul></dd>
@ -699,7 +699,7 @@ be as 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#line1738">line 1738</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1737">line 1737</a>
</li></ul></dd>
@ -768,7 +768,7 @@ be as 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#line1734">line 1734</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1733">line 1733</a>
</li></ul></dd>
@ -837,7 +837,7 @@ be as 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#line1794">line 1794</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1793">line 1793</a>
</li></ul></dd>
@ -896,7 +896,7 @@ be as 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#line1740">line 1740</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1739">line 1739</a>
</li></ul></dd>
@ -965,7 +965,7 @@ be as 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#line1732">line 1732</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1731">line 1731</a>
</li></ul></dd>
@ -1034,7 +1034,7 @@ be as 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#line1736">line 1736</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1735">line 1735</a>
</li></ul></dd>
@ -1113,7 +1113,7 @@ be as 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#line1805">line 1805</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1804">line 1804</a>
</li></ul></dd>
@ -1153,7 +1153,7 @@ be as a logging stream. This class is ment to be used once per message.</div>
<div class="description">
Build a formated message
Build a formatted message
</div>
@ -1182,7 +1182,7 @@ be as a logging stream. This class is ment to be used once per message.</div>
<div class="param-desc">
- string with formated message
- string with formatted message
</div>
@ -1219,7 +1219,7 @@ be as 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#line1833">line 1833</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1832">line 1832</a>
</li></ul></dd>
@ -1372,7 +1372,7 @@ be as 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>