sim1222/SyslogPro
1
0
Fork 0
mirror of https://github.com/misskey-dev/SyslogPro.git synced 2025-04-29 02:37:18 +09:00
Code Issues Packages Projects Releases Wiki Activity

Fix applicationName typo

Browse Source
This commit is contained in:
ajimix 2019-03-22 12:18:56 +08:00
parent aa99167814
commit 2cb30e652d
9 changed files with 40 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -50,7 +50,7 @@ create formatted messages or use directly
**RFC3164** **RFC3164**
```js ```js
let rfc3164 = new SyslogPro.RFC3164({ let rfc3164 = new SyslogPro.RFC3164({
applacationName: 'MyApp', applicationName: 'MyApp',
color: true, color: true,
extendedColor: true, extendedColor: true,
server: { server: {
@ -63,7 +63,7 @@ create formatted messages or use directly
**RFC5424** **RFC5424**
```js ```js
let rfc5424 = new SyslogPro.RFC5424({ let rfc5424 = new SyslogPro.RFC5424({
applacationName: 'MyApp', applicationName: 'MyApp',
timestamp: true, timestamp: true,
encludeStructuredData: true encludeStructuredData: true
color: true, color: true,

4
docs/api.md
View File

@ -263,7 +263,7 @@ Construct a new RFC3164 formatted Syslog object with user options
| Param | Type | Default | Description | | Param | Type | Default | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| [options] | <code>object</code> | | Options object | | [options] | <code>object</code> | | Options object |
| [options.applacationName] | <code>string</code> | <code>&quot;&#x27;NodeJSLogger&#x27;&quot;</code> | Application | | [options.applicationName] | <code>string</code> | <code>&quot;&#x27;NodeJSLogger&#x27;&quot;</code> | Application |
| [options.hostname] | <code>string</code> | <code>&quot;os.hostname&quot;</code> | The name of this server | | [options.hostname] | <code>string</code> | <code>&quot;os.hostname&quot;</code> | The name of this server |
| [options.facility] | <code>number</code> | <code>23</code> | Facility code to use sending this message | | [options.facility] | <code>number</code> | <code>23</code> | Facility code to use sending this message |
| [options.color] | <code>boolean</code> | <code>false</code> | Apply color coding encoding tag with syslog message text | | [options.color] | <code>boolean</code> | <code>false</code> | Apply color coding encoding tag with syslog message text |
@ -668,7 +668,7 @@ Construct a new RFC5424 formatted Syslog object with user options
| Param | Type | Default | Description | | Param | Type | Default | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| [options] | <code>object</code> | | Options object | | [options] | <code>object</code> | | Options object |
| [options.applacationName] | <code>string</code> | <code>&quot;&#x27;NodeJSLogger&#x27;&quot;</code> | Application | | [options.applicationName] | <code>string</code> | <code>&quot;&#x27;NodeJSLogger&#x27;&quot;</code> | Application |
| [options.hostname] | <code>string</code> | <code>&quot;os.hostname&quot;</code> | The name of this server | | [options.hostname] | <code>string</code> | <code>&quot;os.hostname&quot;</code> | The name of this server |
| [options.timestamp] | <code>boolean</code> | <code>false</code> | Included a Timestamp | | [options.timestamp] | <code>boolean</code> | <code>false</code> | Included a Timestamp |
| [options.timestampUTC] | <code>boolean</code> | <code>false</code> | RFC standard is for local time | | [options.timestampUTC] | <code>boolean</code> | <code>false</code> | RFC standard is for local time |

12
docs/docco/README.md
View File

@ -624,7 +624,7 @@ class RFC3164 {
* @public * @public
* @this RFC3164 * @this RFC3164
* @param {object} [options] - Options object * @param {object} [options] - Options object
* @param {string} [options.applacationName='NodeJSLogger'] - Application * @param {string} [options.applicationName='NodeJSLogger'] - Application
* @param {string} [options.hostname=os.hostname] - The name of this server * @param {string} [options.hostname=os.hostname] - The name of this server
* @param {number} [options.facility=23] - Facility code to use sending this * @param {number} [options.facility=23] - Facility code to use sending this
* message * message
@ -667,7 +667,7 @@ class RFC3164 {
this.constructor__ = true; this.constructor__ = true;
options = options || {}; options = options || {};
this.hostname = options.hostname || os.hostname(); this.hostname = options.hostname || os.hostname();
this.applacationName = options.applacationName || ''; this.applicationName = options.applicationName || '';
this.facility = options.facility || 23; this.facility = options.facility || 23;
if (options.color) { if (options.color) {
/** @type {boolean} */ /** @type {boolean} */
@ -1016,7 +1016,7 @@ Build message
fmtMsg = '<' + pri + '>'; fmtMsg = '<' + pri + '>';
fmtMsg += timestamp; fmtMsg += timestamp;
fmtMsg += ' ' + this.hostname; fmtMsg += ' ' + this.hostname;
fmtMsg += ' ' + this.applacationName; fmtMsg += ' ' + this.applicationName;
fmtMsg += ' ' + msg; fmtMsg += ' ' + msg;
fmtMsg += newLine; fmtMsg += newLine;
resolve(fmtMsg); resolve(fmtMsg);
@ -1258,7 +1258,7 @@ class RFC5424 {
* @public * @public
* @this RFC5424 * @this RFC5424
* @param {object} [options] - Options object * @param {object} [options] - Options object
* @param {string} [options.applacationName='NodeJSLogger'] - Application * @param {string} [options.applicationName='NodeJSLogger'] - Application
* @param {string} [options.hostname=os.hostname] - The name of this server * @param {string} [options.hostname=os.hostname] - The name of this server
* @param {boolean} [options.timestamp=false] - Included a Timestamp * @param {boolean} [options.timestamp=false] - Included a Timestamp
* @param {boolean} [options.timestampUTC=false] - RFC standard is for * @param {boolean} [options.timestampUTC=false] - RFC standard is for
@ -1308,7 +1308,7 @@ class RFC5424 {
this.constructor__ = true; this.constructor__ = true;
options = options || {}; options = options || {};
this.hostname = options.hostname || os.hostname(); this.hostname = options.hostname || os.hostname();
this.applacationName = options.applacationName || ''; this.applicationName = options.applicationName || '';
if (typeof options.timestamp === 'undefined' || options.timestamp) { if (typeof options.timestamp === 'undefined' || options.timestamp) {
/** @type {boolean} */ /** @type {boolean} */
this.timestamp = true; this.timestamp = true;
@ -1791,7 +1791,7 @@ Build the message
fmtMsg += '1'; // Version number fmtMsg += '1'; // Version number
fmtMsg += ' ' + timestamp; fmtMsg += ' ' + timestamp;
fmtMsg += ' ' + this.hostname; fmtMsg += ' ' + this.hostname;
fmtMsg += ' ' + this.applacationName; fmtMsg += ' ' + this.applicationName;
fmtMsg += ' ' + pid; fmtMsg += ' ' + pid;
fmtMsg += ' ' + id; fmtMsg += ' ' + id;
fmtMsg += ' ' + structuredData; fmtMsg += ' ' + structuredData;

12
docs/docco/index.html
View File

@ -637,7 +637,7 @@
* @public * @public
* @this RFC3164 * @this RFC3164
* @param {object} [options] - Options object * @param {object} [options] - Options object
* @param {string} [options.applacationName='NodeJSLogger'] - Application * @param {string} [options.applicationName='NodeJSLogger'] - Application
* @param {string} [options.hostname=os.hostname] - The name of this server * @param {string} [options.hostname=os.hostname] - The name of this server
* @param {number} [options.facility=23] - Facility code to use sending this * @param {number} [options.facility=23] - Facility code to use sending this
* message * message
@ -680,7 +680,7 @@
<span class="hljs-keyword">this</span>.constructor__ = <span class="hljs-literal">true</span>; <span class="hljs-keyword">this</span>.constructor__ = <span class="hljs-literal">true</span>;
options = options || {}; options = options || {};
<span class="hljs-keyword">this</span>.hostname = options.hostname || os.hostname(); <span class="hljs-keyword">this</span>.hostname = options.hostname || os.hostname();
<span class="hljs-keyword">this</span>.applacationName = options.applacationName || <span class="hljs-string">''</span>; <span class="hljs-keyword">this</span>.applicationName = options.applicationName || <span class="hljs-string">''</span>;
<span class="hljs-keyword">this</span>.facility = options.facility || <span class="hljs-number">23</span>; <span class="hljs-keyword">this</span>.facility = options.facility || <span class="hljs-number">23</span>;
<span class="hljs-keyword">if</span> (options.color) { <span class="hljs-keyword">if</span> (options.color) {
<span class="hljs-comment">/** @type {boolean} */</span> <span class="hljs-comment">/** @type {boolean} */</span>
@ -1024,7 +1024,7 @@ uses BSD timeformat</p>
<div class="content"><div class='highlight'><pre> fmtMsg = <span class="hljs-string">'&lt;'</span> + pri + <span class="hljs-string">'&gt;'</span>; <div class="content"><div class='highlight'><pre> fmtMsg = <span class="hljs-string">'&lt;'</span> + pri + <span class="hljs-string">'&gt;'</span>;
fmtMsg += timestamp; fmtMsg += timestamp;
fmtMsg += <span class="hljs-string">' '</span> + <span class="hljs-keyword">this</span>.hostname; fmtMsg += <span class="hljs-string">' '</span> + <span class="hljs-keyword">this</span>.hostname;
fmtMsg += <span class="hljs-string">' '</span> + <span class="hljs-keyword">this</span>.applacationName; fmtMsg += <span class="hljs-string">' '</span> + <span class="hljs-keyword">this</span>.applicationName;
fmtMsg += <span class="hljs-string">' '</span> + msg; fmtMsg += <span class="hljs-string">' '</span> + msg;
fmtMsg += newLine; fmtMsg += newLine;
resolve(fmtMsg); resolve(fmtMsg);
@ -1266,7 +1266,7 @@ uses BSD timeformat</p>
* @public * @public
* @this RFC5424 * @this RFC5424
* @param {object} [options] - Options object * @param {object} [options] - Options object
* @param {string} [options.applacationName='NodeJSLogger'] - Application * @param {string} [options.applicationName='NodeJSLogger'] - Application
* @param {string} [options.hostname=os.hostname] - The name of this server * @param {string} [options.hostname=os.hostname] - The name of this server
* @param {boolean} [options.timestamp=false] - Included a Timestamp * @param {boolean} [options.timestamp=false] - Included a Timestamp
* @param {boolean} [options.timestampUTC=false] - RFC standard is for * @param {boolean} [options.timestampUTC=false] - RFC standard is for
@ -1316,7 +1316,7 @@ uses BSD timeformat</p>
<span class="hljs-keyword">this</span>.constructor__ = <span class="hljs-literal">true</span>; <span class="hljs-keyword">this</span>.constructor__ = <span class="hljs-literal">true</span>;
options = options || {}; options = options || {};
<span class="hljs-keyword">this</span>.hostname = options.hostname || os.hostname(); <span class="hljs-keyword">this</span>.hostname = options.hostname || os.hostname();
<span class="hljs-keyword">this</span>.applacationName = options.applacationName || <span class="hljs-string">''</span>; <span class="hljs-keyword">this</span>.applicationName = options.applicationName || <span class="hljs-string">''</span>;
<span class="hljs-keyword">if</span> (<span class="hljs-keyword">typeof</span> options.timestamp === <span class="hljs-string">'undefined'</span> || options.timestamp) { <span class="hljs-keyword">if</span> (<span class="hljs-keyword">typeof</span> options.timestamp === <span class="hljs-string">'undefined'</span> || options.timestamp) {
<span class="hljs-comment">/** @type {boolean} */</span> <span class="hljs-comment">/** @type {boolean} */</span>
<span class="hljs-keyword">this</span>.timestamp = <span class="hljs-literal">true</span>; <span class="hljs-keyword">this</span>.timestamp = <span class="hljs-literal">true</span>;
@ -1792,7 +1792,7 @@ uses BSD timeformat</p>
fmtMsg += <span class="hljs-string">'1'</span>; <span class="hljs-comment">// Version number</span> fmtMsg += <span class="hljs-string">'1'</span>; <span class="hljs-comment">// Version number</span>
fmtMsg += <span class="hljs-string">' '</span> + timestamp; fmtMsg += <span class="hljs-string">' '</span> + timestamp;
fmtMsg += <span class="hljs-string">' '</span> + <span class="hljs-keyword">this</span>.hostname; fmtMsg += <span class="hljs-string">' '</span> + <span class="hljs-keyword">this</span>.hostname;
fmtMsg += <span class="hljs-string">' '</span> + <span class="hljs-keyword">this</span>.applacationName; fmtMsg += <span class="hljs-string">' '</span> + <span class="hljs-keyword">this</span>.applicationName;
fmtMsg += <span class="hljs-string">' '</span> + pid; fmtMsg += <span class="hljs-string">' '</span> + pid;
fmtMsg += <span class="hljs-string">' '</span> + id; fmtMsg += <span class="hljs-string">' '</span> + id;
fmtMsg += <span class="hljs-string">' '</span> + structuredData; fmtMsg += <span class="hljs-string">' '</span> + structuredData;

4
docs/index.html
View File

@ -85,7 +85,7 @@ and the <a href="https://nodejs.org/api/dns.html#dns_dns_promises_api">DNS Promi
create formatted messages or use directly</p> create formatted messages or use directly</p>
<p><strong>RFC3164</strong></p> <p><strong>RFC3164</strong></p>
<pre class="prettyprint source lang-js"><code> let rfc3164 = new SyslogPro.RFC3164({ <pre class="prettyprint source lang-js"><code> let rfc3164 = new SyslogPro.RFC3164({
applacationName: 'MyApp', applicationName: 'MyApp',
color: true, color: true,
extendedColor: true, extendedColor: true,
server: { server: {
@ -94,7 +94,7 @@ create formatted messages or use directly</p>
}); });
rfc3164.info('My Message');</code></pre><p><strong>RFC5424</strong></p> rfc3164.info('My Message');</code></pre><p><strong>RFC5424</strong></p>
<pre class="prettyprint source lang-js"><code> let rfc5424 = new SyslogPro.RFC5424({ <pre class="prettyprint source lang-js"><code> let rfc5424 = new SyslogPro.RFC5424({
applacationName: 'MyApp', applicationName: 'MyApp',
timestamp: true, timestamp: true,
encludeStructuredData: true encludeStructuredData: true
color: true, color: true,

12
docs/index.js.html
View File

@ -518,7 +518,7 @@ class RFC3164 {
* @public * @public
* @this RFC3164 * @this RFC3164
* @param {object} [options] - Options object * @param {object} [options] - Options object
* @param {string} [options.applacationName='NodeJSLogger'] - Application * @param {string} [options.applicationName='NodeJSLogger'] - Application
* @param {string} [options.hostname=os.hostname] - The name of this server * @param {string} [options.hostname=os.hostname] - The name of this server
* @param {number} [options.facility=23] - Facility code to use sending this * @param {number} [options.facility=23] - Facility code to use sending this
* message * message
@ -561,7 +561,7 @@ class RFC3164 {
this.constructor__ = true; this.constructor__ = true;
options = options || {}; options = options || {};
this.hostname = options.hostname || os.hostname(); this.hostname = options.hostname || os.hostname();
this.applacationName = options.applacationName || ''; this.applicationName = options.applicationName || '';
this.facility = options.facility || 23; this.facility = options.facility || 23;
if (options.color) { if (options.color) {
/** @type {boolean} */ /** @type {boolean} */
@ -840,7 +840,7 @@ class RFC3164 {
fmtMsg = '&lt;' + pri + '>'; fmtMsg = '&lt;' + pri + '>';
fmtMsg += timestamp; fmtMsg += timestamp;
fmtMsg += ' ' + this.hostname; fmtMsg += ' ' + this.hostname;
fmtMsg += ' ' + this.applacationName; fmtMsg += ' ' + this.applicationName;
fmtMsg += ' ' + msg; fmtMsg += ' ' + msg;
fmtMsg += newLine; fmtMsg += newLine;
resolve(fmtMsg); resolve(fmtMsg);
@ -1082,7 +1082,7 @@ class RFC5424 {
* @public * @public
* @this RFC5424 * @this RFC5424
* @param {object} [options] - Options object * @param {object} [options] - Options object
* @param {string} [options.applacationName='NodeJSLogger'] - Application * @param {string} [options.applicationName='NodeJSLogger'] - Application
* @param {string} [options.hostname=os.hostname] - The name of this server * @param {string} [options.hostname=os.hostname] - The name of this server
* @param {boolean} [options.timestamp=false] - Included a Timestamp * @param {boolean} [options.timestamp=false] - Included a Timestamp
* @param {boolean} [options.timestampUTC=false] - RFC standard is for * @param {boolean} [options.timestampUTC=false] - RFC standard is for
@ -1132,7 +1132,7 @@ class RFC5424 {
this.constructor__ = true; this.constructor__ = true;
options = options || {}; options = options || {};
this.hostname = options.hostname || os.hostname(); this.hostname = options.hostname || os.hostname();
this.applacationName = options.applacationName || ''; this.applicationName = options.applicationName || '';
if (typeof options.timestamp === 'undefined' || options.timestamp) { if (typeof options.timestamp === 'undefined' || options.timestamp) {
/** @type {boolean} */ /** @type {boolean} */
this.timestamp = true; this.timestamp = true;
@ -1517,7 +1517,7 @@ class RFC5424 {
fmtMsg += '1'; // Version number fmtMsg += '1'; // Version number
fmtMsg += ' ' + timestamp; fmtMsg += ' ' + timestamp;
fmtMsg += ' ' + this.hostname; fmtMsg += ' ' + this.hostname;
fmtMsg += ' ' + this.applacationName; fmtMsg += ' ' + this.applicationName;
fmtMsg += ' ' + pid; fmtMsg += ' ' + pid;
fmtMsg += ' ' + id; fmtMsg += ' ' + id;
fmtMsg += ' ' + structuredData; fmtMsg += ' ' + structuredData;

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

@ -229,7 +229,7 @@ fashion where new messages are written to the class as needed.</div>
<tr> <tr>
<td class="name"><code>applacationName</code></td> <td class="name"><code>applicationName</code></td>
<td class="type"> <td class="type">

2
docs/module-SyslogPro-RFC5424.html
View File

@ -230,7 +230,7 @@ fashion where new messages are written to the class as needed.</div>
<tr> <tr>
<td class="name"><code>applacationName</code></td> <td class="name"><code>applicationName</code></td>
<td class="type"> <td class="type">

21
index.js
View File

@ -475,7 +475,7 @@ class RFC3164 {
* @public * @public
* @this RFC3164 * @this RFC3164
* @param {object} [options] - Options object * @param {object} [options] - Options object
* @param {string} [options.applacationName='NodeJSLogger'] - Application * @param {string} [options.applicationName='NodeJSLogger'] - Application
* @param {string} [options.hostname=os.hostname] - The name of this server * @param {string} [options.hostname=os.hostname] - The name of this server
* @param {number} [options.facility=23] - Facility code to use sending this * @param {number} [options.facility=23] - Facility code to use sending this
* message * message
@ -518,7 +518,11 @@ class RFC3164 {
this.constructor__ = true; this.constructor__ = true;
options = options || {}; options = options || {};
this.hostname = options.hostname || os.hostname(); this.hostname = options.hostname || os.hostname();
this.applacationName = options.applacationName || ''; if (options.applicationName) {
this.applicationName = options.applicationName;
} else {
this.applicationName = options.applacationName || '';
}
this.facility = options.facility || 23; this.facility = options.facility || 23;
if (options.color) { if (options.color) {
/** @type {boolean} */ /** @type {boolean} */
@ -797,7 +801,7 @@ class RFC3164 {
fmtMsg = '<' + pri + '>'; fmtMsg = '<' + pri + '>';
fmtMsg += timestamp; fmtMsg += timestamp;
fmtMsg += ' ' + this.hostname; fmtMsg += ' ' + this.hostname;
fmtMsg += ' ' + this.applacationName; fmtMsg += ' ' + this.applicationName;
fmtMsg += ' ' + msg; fmtMsg += ' ' + msg;
fmtMsg += newLine; fmtMsg += newLine;
resolve(fmtMsg); resolve(fmtMsg);
@ -1039,7 +1043,7 @@ class RFC5424 {
* @public * @public
* @this RFC5424 * @this RFC5424
* @param {object} [options] - Options object * @param {object} [options] - Options object
* @param {string} [options.applacationName='NodeJSLogger'] - Application * @param {string} [options.applicationName='NodeJSLogger'] - Application
* @param {string} [options.hostname=os.hostname] - The name of this server * @param {string} [options.hostname=os.hostname] - The name of this server
* @param {boolean} [options.timestamp=false] - Included a Timestamp * @param {boolean} [options.timestamp=false] - Included a Timestamp
* @param {boolean} [options.timestampUTC=false] - RFC standard is for * @param {boolean} [options.timestampUTC=false] - RFC standard is for
@ -1089,7 +1093,11 @@ class RFC5424 {
this.constructor__ = true; this.constructor__ = true;
options = options || {}; options = options || {};
this.hostname = options.hostname || os.hostname(); this.hostname = options.hostname || os.hostname();
this.applacationName = options.applacationName || ''; if (options.applicationName) {
this.applicationName = options.applicationName;
} else {
this.applicationName = options.applacationName || '';
}
if (typeof options.timestamp === 'undefined' || options.timestamp) { if (typeof options.timestamp === 'undefined' || options.timestamp) {
/** @type {boolean} */ /** @type {boolean} */
this.timestamp = true; this.timestamp = true;
@ -1474,7 +1482,7 @@ class RFC5424 {
fmtMsg += '1'; // Version number fmtMsg += '1'; // Version number
fmtMsg += ' ' + timestamp; fmtMsg += ' ' + timestamp;
fmtMsg += ' ' + this.hostname; fmtMsg += ' ' + this.hostname;
fmtMsg += ' ' + this.applacationName; fmtMsg += ' ' + this.applicationName;
fmtMsg += ' ' + pid; fmtMsg += ' ' + pid;
fmtMsg += ' ' + id; fmtMsg += ' ' + id;
fmtMsg += ' ' + structuredData; fmtMsg += ' ' + structuredData;
@ -3374,4 +3382,3 @@ module.exports = {
CEF: CEF, CEF: CEF,
Syslog: Syslog, Syslog: Syslog,
}; };