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

96
docs/module-SyslogPro-Syslog.html
View File

@ -50,11 +50,11 @@
</h2>
<div class="class-description">A class to work with syslog messages using UDP, TCP, or TLS transport.
There is suport for Syslog message formating RFC-3164, RFC-5424 including
There is support for Syslog message formatting RFC-3164, RFC-5424 including
Structured Data, IBM LEEF (Log Event Extended Format), and HP CEF (Common
Event Format).
Syslog formating classes can be used as input into a Syslog class to be used
simultatniusly to the same Syslog server. *</div>
Syslog formatting classes can be used as input into a Syslog class to be used
simultaneously to the same Syslog server. *</div>
</header>
@ -81,7 +81,7 @@ simultatniusly to the same Syslog server. *</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#line106">line 106</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line107">line 107</a>
</li></ul></dd>
@ -194,7 +194,7 @@ simultatniusly to the same Syslog server. *</div>
<td class="description last">Options object
>>>Transport Configuraton
>>>Transport Configuration
<h6>Properties</h6>
@ -257,8 +257,8 @@ simultatniusly to the same Syslog server. *</div>
<td class="description last">The IP Address|FQDN of the
Syslog Server, this option if set will take prasdents over any target
set in a formating object</td>
Syslog Server, this option if set will take presidents over any target
set in a formatting object</td>
</tr>
@ -297,9 +297,9 @@ simultatniusly to the same Syslog server. *</div>
</td>
<td class="description last">L4 transport portocol
(udp|tcp|tls), this option if set will take prasdents over any transport
set in a formating object</td>
<td class="description last">L4 transport protocol
(udp|tcp|tls), this option if set will take presidents over any transport
set in a formatting object</td>
</tr>
@ -339,7 +339,7 @@ simultatniusly to the same Syslog server. *</div>
<td class="description last">IP port, this option if set will take
prasdents over any IP Port set in a formating object</td>
presidents over any IP Port set in a formatting object</td>
</tr>
@ -379,8 +379,8 @@ simultatniusly to the same Syslog server. *</div>
<td class="description last">Ignored for all other
transports, this option if set will take prasdents over any timeout
set in a formating object</td>
transports, this option if set will take presidents over any timeout
set in a formatting object</td>
</tr>
@ -417,9 +417,9 @@ simultatniusly to the same Syslog server. *</div>
</td>
<td class="description last">Array of authrized TLS server
certificates file locations, this option if set will take prasdents
over any certificates set in a formating object</td>
<td class="description last">Array of authorized TLS server
certificates file locations, this option if set will take presidents
over any certificates set in a formatting object</td>
</tr>
@ -458,7 +458,7 @@ simultatniusly to the same Syslog server. *</div>
<td class="description last">Client TLS certificate file
location that this client should use, this option if set will take
prasdents over any certificates set in a formating object</td>
presidents over any certificates set in a formatting object</td>
</tr>
@ -497,7 +497,7 @@ simultatniusly to the same Syslog server. *</div>
<td class="description last">Client TLS key file
location that this client should use, this option if set will take
prasdents over any certificates set in a formating object
presidents over any certificates set in a formatting object
>>>Syslog Format Settings</td>
</tr>
@ -686,7 +686,7 @@ simultatniusly to the same Syslog server. *</div>
</td>
<td class="description last"><a href="module-SyslogPro-CEF.html">HP CEF (Common Event Format) formating object</a></td>
<td class="description last"><a href="module-SyslogPro-CEF.html">HP CEF (Common Event Format) formatting object</a></td>
</tr>
@ -756,7 +756,7 @@ simultatniusly to the same Syslog server. *</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#line212">line 212</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line213">line 213</a>
</li></ul></dd>
@ -825,7 +825,7 @@ simultatniusly to the same Syslog server. *</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#line181">line 181</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line182">line 182</a>
</li></ul></dd>
@ -894,7 +894,7 @@ simultatniusly to the same Syslog server. *</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#line204">line 204</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line205">line 205</a>
</li></ul></dd>
@ -963,7 +963,7 @@ simultatniusly to the same Syslog server. *</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#line159">line 159</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line160">line 160</a>
</li></ul></dd>
@ -1032,7 +1032,7 @@ simultatniusly to the same Syslog server. *</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#line156">line 156</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line157">line 157</a>
</li></ul></dd>
@ -1101,7 +1101,7 @@ simultatniusly to the same Syslog server. *</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#line188">line 188</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line189">line 189</a>
</li></ul></dd>
@ -1170,7 +1170,7 @@ simultatniusly to the same Syslog server. *</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#line196">line 196</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line197">line 197</a>
</li></ul></dd>
@ -1239,7 +1239,7 @@ simultatniusly to the same Syslog server. *</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#line154">line 154</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line155">line 155</a>
</li></ul></dd>
@ -1308,7 +1308,7 @@ simultatniusly to the same Syslog server. *</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#line161">line 161</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line162">line 162</a>
</li></ul></dd>
@ -1377,7 +1377,7 @@ simultatniusly to the same Syslog server. *</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#line172">line 172</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line173">line 173</a>
</li></ul></dd>
@ -1446,7 +1446,7 @@ simultatniusly to the same Syslog server. *</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#line176">line 176</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line177">line 177</a>
</li></ul></dd>
@ -1515,7 +1515,7 @@ simultatniusly to the same Syslog server. *</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#line168">line 168</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line169">line 169</a>
</li></ul></dd>
@ -1584,7 +1584,7 @@ simultatniusly to the same Syslog server. *</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#line246">line 246</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line247">line 247</a>
</li></ul></dd>
@ -1653,7 +1653,7 @@ simultatniusly to the same Syslog server. *</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#line242">line 242</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line243">line 243</a>
</li></ul></dd>
@ -1699,9 +1699,9 @@ simultatniusly to the same Syslog server. *</div>
<div class="description">
Add a TLS server certificate which can be used to authentacat the server
this syslog client is connecting too. This function will valadate the
input as a file location straing and add it to an array of certificates
Add a TLS server certificate which can be used to authenticate the server
this syslog client is connecting too. This function will validate the
input as a file location string and add it to an array of certificates
</div>
@ -1943,7 +1943,7 @@ selected transport.
<td class="description last">The formated Syslog Message</td>
<td class="description last">The formatted Syslog Message</td>
</tr>
@ -2023,7 +2023,7 @@ selected transport.
<div class="param-desc">
- The Syslog formated string sent
- The Syslog formatted string sent
</div>
@ -2060,7 +2060,7 @@ selected transport.
<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#line294">line 294</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line295">line 295</a>
</li></ul></dd>
@ -2154,7 +2154,7 @@ selected transport.
<td class="description last">The formated Syslog Message</td>
<td class="description last">The formatted Syslog Message</td>
</tr>
@ -2234,7 +2234,7 @@ selected transport.
<div class="param-desc">
- The Syslog formated string sent
- The Syslog formatted string sent
</div>
@ -2271,7 +2271,7 @@ selected transport.
<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#line340">line 340</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line341">line 341</a>
</li></ul></dd>
@ -2365,7 +2365,7 @@ selected transport.
<td class="description last">The formated Syslog Message</td>
<td class="description last">The formatted Syslog Message</td>
</tr>
@ -2445,7 +2445,7 @@ selected transport.
<div class="param-desc">
- The Syslog formated string sent
- The Syslog formatted string sent
</div>
@ -2482,7 +2482,7 @@ selected transport.
<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#line264">line 264</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line265">line 265</a>
</li></ul></dd>
@ -2576,7 +2576,7 @@ selected transport.
<td class="description last">The formated Syslog Message</td>
<td class="description last">The formatted Syslog Message</td>
</tr>
@ -2629,7 +2629,7 @@ selected transport.
<div class="param-desc">
- The Syslog formated string sent
- The Syslog formatted string sent
</div>
@ -2669,7 +2669,7 @@ selected transport.
<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>