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

162
docs/module-SyslogPro-RFC3164.html
View File

@ -49,18 +49,18 @@
RFC3164
</h2>
<div class="class-description">A class to work with RFC3164 formated syslog messages. The meesaging is fully configurabule and Ansi foreground
colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.
<div class="class-description">A class to work with RFC3164 formatted syslog messages. The messaging is fully configurable and ANSI foreground
colors can be added. Both ANSI 8 and ANSI 256 color are fully supported.
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.
Syslog server target can also be used as the input into the formatting
classes so that it may run independently.
The RFC3164 Syslog logging format is ment to be used as a stream of log data
from a service or applacation. This class is designed to be used in this
fashion where new messages are writen to the class as needed.</div>
The RFC3164 Syslog logging format is meant to be used as a stream of log data
from a service or application. This class is designed to be used in this
fashion where new messages are written to the class as needed.</div>
</header>
@ -133,7 +133,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="description">
Construct a new RFC3164 formated Syslog object with user options
Construct a new RFC3164 formatted Syslog object with user options
</div>
@ -261,7 +261,7 @@ fashion where new messages are writen to the class as needed.</div>
</td>
<td class="description last">Applacation</td>
<td class="description last">Application</td>
</tr>
@ -419,7 +419,7 @@ fashion where new messages are writen to the class as needed.</div>
</td>
<td class="description last">Use the extedned ANSI
<td class="description last">Use the extended ANSI
color set encoding tag with syslog message text</td>
</tr>
@ -458,7 +458,7 @@ fashion where new messages are writen to the class as needed.</div>
<td class="description last">User defended colors for
severites
severities
<h6>Properties</h6>
@ -1614,7 +1614,7 @@ fashion where new messages are writen to the class as needed.</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#line865">line 865</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line864">line 864</a>
</li></ul></dd>
@ -1654,7 +1654,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="description">
Send a syslog message with a secerity level of 1 (Alert)
Send a syslog message with a severity level of 1 (Alert)
</div>
@ -1733,7 +1733,7 @@ fashion where new messages are writen to the class as needed.</div>
<dl>
<dt>
<div class="param-desc">
- Any bubbled up error
- Any bubbled-up error
</div>
</dt>
<dd></dd>
@ -1761,7 +1761,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="param-desc">
- The formated syslog message sent to the Syslog server
- The formatted syslog message sent to the Syslog server
</div>
@ -1838,7 +1838,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="description">
Building a formated message. Returns a promise with a formated message
Building a formatted message. Returns a promise with a formatted message
</div>
@ -2097,7 +2097,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="param-desc">
A Syslog formated string acording to the selected RFC
A Syslog formatted string according to the selected RFC
</div>
@ -2134,7 +2134,7 @@ fashion where new messages are writen to the class as needed.</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#line891">line 891</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line890">line 890</a>
</li></ul></dd>
@ -2174,7 +2174,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="description">
Send a syslog message with a secerity level of 2 (Critical)
Send a syslog message with a severity level of 2 (Critical)
</div>
@ -2253,7 +2253,7 @@ fashion where new messages are writen to the class as needed.</div>
<dl>
<dt>
<div class="param-desc">
- Any bubbled up error
- Any bubbled-up error
</div>
</dt>
<dd></dd>
@ -2281,7 +2281,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="param-desc">
- The formated syslog message sent to the Syslog server
- The formatted syslog message sent to the Syslog server
</div>
@ -2318,7 +2318,7 @@ fashion where new messages are writen to the class as needed.</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#line878">line 878</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line877">line 877</a>
</li></ul></dd>
@ -2358,7 +2358,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="description">
Send a syslog message with a secerity level of 2 (Critical)
Send a syslog message with a severity level of 2 (Critical)
</div>
@ -2437,7 +2437,7 @@ fashion where new messages are writen to the class as needed.</div>
<dl>
<dt>
<div class="param-desc">
- Any bubbled up error
- Any bubbled-up error
</div>
</dt>
<dd></dd>
@ -2465,7 +2465,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="param-desc">
- The formated syslog message sent to the Syslog server
- The formatted syslog message sent to the Syslog server
</div>
@ -2502,7 +2502,7 @@ fashion where new messages are writen to the class as needed.</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#line1003">line 1003</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1002">line 1002</a>
</li></ul></dd>
@ -2542,7 +2542,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="description">
Send a syslog message with a secerity level of 7 (Debug)
Send a syslog message with a severity level of 7 (Debug)
</div>
@ -2621,7 +2621,7 @@ fashion where new messages are writen to the class as needed.</div>
<dl>
<dt>
<div class="param-desc">
- Any bubbled up error
- Any bubbled-up error
</div>
</dt>
<dd></dd>
@ -2649,7 +2649,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="param-desc">
- The formated syslog message sent to the Syslog server
- The formatted syslog message sent to the Syslog server
</div>
@ -2686,7 +2686,7 @@ fashion where new messages are writen to the class as needed.</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#line855">line 855</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line854">line 854</a>
</li></ul></dd>
@ -2726,7 +2726,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="description">
Send a syslog message with a secerity level of 0 (Emergency)
Send a syslog message with a security level of 0 (Emergency)
</div>
@ -2780,7 +2780,7 @@ fashion where new messages are writen to the class as needed.</div>
<td class="description last">The emergancy message to send to the Syslog server</td>
<td class="description last">The emergency message to send to the Syslog server</td>
</tr>
@ -2805,7 +2805,7 @@ fashion where new messages are writen to the class as needed.</div>
<dl>
<dt>
<div class="param-desc">
- Any bubbled up error
- Any bubbled-up error
</div>
</dt>
<dd></dd>
@ -2833,7 +2833,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="param-desc">
- The formated syslog message sent to the Syslog server
- The formatted syslog message sent to the Syslog server
</div>
@ -2870,7 +2870,7 @@ fashion where new messages are writen to the class as needed.</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#line842">line 842</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line841">line 841</a>
</li></ul></dd>
@ -2910,7 +2910,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="description">
Send a syslog message with a secerity level of 0 (Emergency)
Send a syslog message with a security level of 0 (Emergency)
</div>
@ -2964,7 +2964,7 @@ fashion where new messages are writen to the class as needed.</div>
<td class="description last">The emergancy message to send to the Syslog server</td>
<td class="description last">The emergency message to send to the Syslog server</td>
</tr>
@ -2989,7 +2989,7 @@ fashion where new messages are writen to the class as needed.</div>
<dl>
<dt>
<div class="param-desc">
- Any bubbled up error
- Any bubbled-up error
</div>
</dt>
<dd></dd>
@ -3017,7 +3017,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="param-desc">
- The formated syslog message sent to the Syslog server
- The formatted syslog message sent to the Syslog server
</div>
@ -3054,7 +3054,7 @@ fashion where new messages are writen to the class as needed.</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#line914">line 914</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line913">line 913</a>
</li></ul></dd>
@ -3094,7 +3094,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="description">
Send a syslog message with a secerity level of 3 (Error)
Send a syslog message with a severity level of 3 (Error)
</div>
@ -3173,7 +3173,7 @@ fashion where new messages are writen to the class as needed.</div>
<dl>
<dt>
<div class="param-desc">
- Any bubbled up error
- Any bubbled-up error
</div>
</dt>
<dd></dd>
@ -3201,7 +3201,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="param-desc">
- The formated syslog message sent to the Syslog server
- The formatted syslog message sent to the Syslog server
</div>
@ -3238,7 +3238,7 @@ fashion where new messages are writen to the class as needed.</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#line901">line 901</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line900">line 900</a>
</li></ul></dd>
@ -3278,7 +3278,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="description">
Send a syslog message with a secerity level of 3 (Error)
Send a syslog message with a severity level of 3 (Error)
</div>
@ -3357,7 +3357,7 @@ fashion where new messages are writen to the class as needed.</div>
<dl>
<dt>
<div class="param-desc">
- Any bubbled up error
- Any bubbled-up error
</div>
</dt>
<dd></dd>
@ -3385,7 +3385,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="param-desc">
- The formated syslog message sent to the Syslog server
- The formatted syslog message sent to the Syslog server
</div>
@ -3422,7 +3422,7 @@ fashion where new messages are writen to the class as needed.</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#line983">line 983</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line982">line 982</a>
</li></ul></dd>
@ -3462,7 +3462,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="description">
Send a syslog message with a secerity level of 6 (Informational)
Send a syslog message with a severity level of 6 (Informational)
</div>
@ -3541,7 +3541,7 @@ fashion where new messages are writen to the class as needed.</div>
<dl>
<dt>
<div class="param-desc">
- Any bubbled up error
- Any bubbled-up error
</div>
</dt>
<dd></dd>
@ -3569,7 +3569,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="param-desc">
- The formated syslog message sent to the Syslog server
- The formatted syslog message sent to the Syslog server
</div>
@ -3606,7 +3606,7 @@ fashion where new messages are writen to the class as needed.</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#line970">line 970</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line969">line 969</a>
</li></ul></dd>
@ -3646,7 +3646,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="description">
Send a syslog message with a secerity level of 6 (Informational)
Send a syslog message with a severity level of 6 (Informational)
</div>
@ -3725,7 +3725,7 @@ fashion where new messages are writen to the class as needed.</div>
<dl>
<dt>
<div class="param-desc">
- Any bubbled up error
- Any bubbled-up error
</div>
</dt>
<dd></dd>
@ -3753,7 +3753,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="param-desc">
- The formated syslog message sent to the Syslog server
- The formatted syslog message sent to the Syslog server
</div>
@ -3790,7 +3790,7 @@ fashion where new messages are writen to the class as needed.</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#line993">line 993</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line992">line 992</a>
</li></ul></dd>
@ -3830,7 +3830,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="description">
Send a syslog message with a secerity level of 6 (Informational)
Send a syslog message with a severity level of 6 (Informational)
</div>
@ -3909,7 +3909,7 @@ fashion where new messages are writen to the class as needed.</div>
<dl>
<dt>
<div class="param-desc">
- Any bubbled up error
- Any bubbled-up error
</div>
</dt>
<dd></dd>
@ -3937,7 +3937,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="param-desc">
- The formated syslog message sent to the Syslog server
- The formatted syslog message sent to the Syslog server
</div>
@ -3974,7 +3974,7 @@ fashion where new messages are writen to the class as needed.</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#line960">line 960</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line959">line 959</a>
</li></ul></dd>
@ -4014,7 +4014,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="description">
Send a syslog message with a secerity level of 5 (Notice)
Send a syslog message with a severity level of 5 (Notice)
</div>
@ -4093,7 +4093,7 @@ fashion where new messages are writen to the class as needed.</div>
<dl>
<dt>
<div class="param-desc">
- Any bubbled up error
- Any bubbled-up error
</div>
</dt>
<dd></dd>
@ -4121,7 +4121,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="param-desc">
- The formated syslog message sent to the Syslog server
- The formatted syslog message sent to the Syslog server
</div>
@ -4158,7 +4158,7 @@ fashion where new messages are writen to the class as needed.</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#line947">line 947</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line946">line 946</a>
</li></ul></dd>
@ -4198,7 +4198,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="description">
Send a syslog message with a secerity level of 5 (Notice)
Send a syslog message with a severity level of 5 (Notice)
</div>
@ -4277,7 +4277,7 @@ fashion where new messages are writen to the class as needed.</div>
<dl>
<dt>
<div class="param-desc">
- Any bubbled up error
- Any bubbled-up error
</div>
</dt>
<dd></dd>
@ -4305,7 +4305,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="param-desc">
- The formated syslog message sent to the Syslog server
- The formatted syslog message sent to the Syslog server
</div>
@ -4342,7 +4342,7 @@ fashion where new messages are writen to the class as needed.</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#line815">line 815</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line814">line 814</a>
</li></ul></dd>
@ -4389,9 +4389,9 @@ fashion where new messages are writen to the class as needed.</div>
<div class="description">
send a RFC5424 formated message. Returns a promise with the formated
send a RFC5424 formatted message. Returns a promise with the formatted
message that was sent. If no server connection was defined when the
class was created a defualt Syslog connector will be used.
class was created a default Syslog connector will be used.
</div>
@ -4455,7 +4455,7 @@ fashion where new messages are writen to the class as needed.</div>
<td class="description last">The unformated Syslog message to send</td>
<td class="description last">The unformatted Syslog message to send</td>
</tr>
@ -4649,7 +4649,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="param-desc">
A Syslog formated string acording to the selected RFC
A Syslog formatted string according to the selected RFC
</div>
@ -5107,7 +5107,7 @@ fashion where new messages are writen to the class as needed.</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#line937">line 937</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line936">line 936</a>
</li></ul></dd>
@ -5147,7 +5147,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="description">
Send a syslog message with a secerity level of 4 (Warning)
Send a syslog message with a severity level of 4 (Warning)
</div>
@ -5226,7 +5226,7 @@ fashion where new messages are writen to the class as needed.</div>
<dl>
<dt>
<div class="param-desc">
- Any bubbled up error
- Any bubbled-up error
</div>
</dt>
<dd></dd>
@ -5254,7 +5254,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="param-desc">
- The formated syslog message sent to the Syslog server
- The formatted syslog message sent to the Syslog server
</div>
@ -5291,7 +5291,7 @@ fashion where new messages are writen to the class as needed.</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#line924">line 924</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line923">line 923</a>
</li></ul></dd>
@ -5331,7 +5331,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="description">
Send a syslog message with a secerity level of 4 (Warning)
Send a syslog message with a severity level of 4 (Warning)
</div>
@ -5410,7 +5410,7 @@ fashion where new messages are writen to the class as needed.</div>
<dl>
<dt>
<div class="param-desc">
- Any bubbled up error
- Any bubbled-up error
</div>
</dt>
<dd></dd>
@ -5438,7 +5438,7 @@ fashion where new messages are writen to the class as needed.</div>
<div class="param-desc">
- The formated syslog message sent to the Syslog server
- The formatted syslog message sent to the Syslog server
</div>
@ -5478,7 +5478,7 @@ fashion where new messages are writen to the class as needed.</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>