sim1222/SyslogPro

Fork 0

mirror of https://github.com/misskey-dev/SyslogPro.git synced 2025-04-28 18:27:27 +09:00

Craig Yamato 00b72a3f57 Updated Readme

2018-09-25 18:23:58 +00:00

60 KiB

Raw Blame History

API

back to README.md

API convention

SyslogPro

The SyslogPro module for sending syslog messages Most APIs will return a promise. These APIs can be used using then(...)/catch(...)

Syslog formating classes can be used as input into a Syslog class to be used simultatniusly to the same Syslog server. The Syslog Class with a configured Syslog server target can also be used as the input into each of the formating classes so that they may run independtly.

Version: 0.1.0
Author: Craig Yamato craig@kentik.com
Copyright: (c) 2018 - Craig Yamato

SyslogPro
- ~Syslog
  - new Syslog([options])
  - .target : string
  - .protocol : string
  - .port : number
  - .tcpTimeout : number
  - .tlsServerCerts : Array.<string>
  - .tlsClientCert : string
  - .tlsClientKey : string
  - .format : string
  - .rfc3164 : RFC3164
  - .rfc5424 : RFC5424
  - .leef : LEEF
  - .cef : CEF
- ~RFC3164
  - new RFC3164([options])
  - .color : boolean
  - .extendedColor : boolean
  - .setColor()
  - .buildMessage(msg, [options]) ⇒ Promise
  - .send(msg, [options]) ⇒ Promise
  - .emergency(msg) ⇒ Promise
  - .emer(msg) ⇒ Promise
  - .alert(msg) ⇒ Promise
  - .critical(msg) ⇒ Promise
  - .crit(msg) ⇒ Promise
  - .error(msg) ⇒ Promise
  - .err(msg) ⇒ Promise
  - .warning(msg) ⇒ Promise
  - .warn(msg) ⇒ Promise
  - .notice(msg) ⇒ Promise
  - .note(msg) ⇒ Promise
  - .informational(msg) ⇒ Promise
  - .info(msg) ⇒ Promise
  - .log(msg) ⇒ Promise
  - .debug(msg) ⇒ Promise
- ~RFC5424
  - new RFC5424([options])
  - .timestamp : boolean
  - .timestampUTC : boolean
  - .timestampTZ : boolean
  - .timestampMS : boolean
  - .encludeStructuredData : boolean
  - .utf8BOM : boolean
  - .color : boolean
  - .extendedColor : boolean
  - .setColor()
  - .buildMessage(msg, [options]) ⇒ Promise
  - .send(msg) ⇒ Promise
  - .emergency(msg) ⇒ Promise
  - .emer(msg) ⇒ Promise
  - .alert(msg) ⇒ Promise
  - .critical(msg) ⇒ Promise
  - .crit(msg) ⇒ Promise
  - .error(msg) ⇒ Promise
  - .err(msg) ⇒ Promise
  - .warning(msg) ⇒ Promise
  - .warn(msg) ⇒ Promise
  - .notice(msg) ⇒ Promise
  - .note(msg) ⇒ Promise
  - .informational(msg) ⇒ Promise
  - .info(msg) ⇒ Promise
  - .log(msg) ⇒ Promise
  - .debug(msg) ⇒ Promise
- ~LEEF
  - new LEEF([options])
  - .vendor : string
  - .product : string
  - .version : string
  - .eventId : string
  - .syslogHeader : boolean
  - .attrabutes : object
  - .buildMessage() ⇒ Promise
  - .send([options])
- ~CEF
  - new CEF([options])
  - .deviceVendor : string
  - .deviceProduct : string
  - .deviceVersion : string
  - .deviceEventClassId : string
  - .name : string
  - .severity : string
  - .extensions : object
  - .validate() ⇒ Promise
  - .buildMessage() ⇒ Promise
  - .send([options])

SyslogPro~Syslog

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 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. *

Kind: inner class of SyslogPro
Requires: module:moment
Since: 0.0.0
Version: 0.0.0

~Syslog
- new Syslog([options])
- .target : string
- .protocol : string
- .port : number
- .tcpTimeout : number
- .tlsServerCerts : Array.<string>
- .tlsClientCert : string
- .tlsClientKey : string
- .format : string
- .rfc3164 : RFC3164
- .rfc5424 : RFC5424
- .leef : LEEF
- .cef : CEF

new Syslog([options])

Construct a new Syslog transport object with user options

Param	Type	Default	Description
[options]	`object`		Options object >>>Transport Configuraton
[options.target]	`string`	`"'localhost'"`	The IP Address
[options.protocol]	`string`	`"'udp'"`	L4 transport portocol (udp
[options.port]	`number`	`514`	IP port, this option if set will take prasdents over any IP Port set in a formating object
[options.tcpTimeout]	`number`	`10000`	Ignored for all other transports, this option if set will take prasdents over any timeout set in a formating object
[options.tlsServerCerts]	`Array.<string>`		Array of authrized TLS server certificates file locations, this option if set will take prasdents over any certificates set in a formating object
[options.tlsClientCert]	`string`		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
[options.tlsClientKey]	`string`		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 >>>Syslog Format Settings
[options.format]	`string`	`"'none'"`	Valid syslog format options for this module are 'none', 'rfc3164', 'rfc5424', 'leef', 'cef'
[options.rfc5424]	`RFC3164`		{@link module:SyslogPro~RFC5424
[options.rfc5424]	`RFC5424`		{@link module:SyslogPro~RFC5424
[options.leef]	`LEEF`		{@link module:SyslogPro~LEEF
[options.cef]	`CEF`		{@link module:SyslogPro~CEF

syslog.target : `string`

Kind: instance property of Syslog

syslog.protocol : `string`

Kind: instance property of Syslog

syslog.port : `number`

Kind: instance property of Syslog

syslog.tcpTimeout : `number`

Kind: instance property of Syslog

syslog.tlsServerCerts : `Array.<string>`

Kind: instance property of Syslog

syslog.tlsClientCert : `string`

Kind: instance property of Syslog

syslog.tlsClientKey : `string`

Kind: instance property of Syslog

syslog.format : `string`

Kind: instance property of Syslog

syslog.rfc3164 : `RFC3164`

Kind: instance property of Syslog

syslog.rfc5424 : `RFC5424`

Kind: instance property of Syslog

syslog.leef : `LEEF`

Kind: instance property of Syslog

syslog.cef : `CEF`

Kind: instance property of Syslog

SyslogPro~RFC3164

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. 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 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.

Kind: inner class of SyslogPro
Requires: module:moment
Since: 0.0.0
Version: 0.0.0

~RFC3164
- new RFC3164([options])
- .color : boolean
- .extendedColor : boolean
- .setColor()
- .buildMessage(msg, [options]) ⇒ Promise
- .send(msg, [options]) ⇒ Promise
- .emergency(msg) ⇒ Promise
- .emer(msg) ⇒ Promise
- .alert(msg) ⇒ Promise
- .critical(msg) ⇒ Promise
- .crit(msg) ⇒ Promise
- .error(msg) ⇒ Promise
- .err(msg) ⇒ Promise
- .warning(msg) ⇒ Promise
- .warn(msg) ⇒ Promise
- .notice(msg) ⇒ Promise
- .note(msg) ⇒ Promise
- .informational(msg) ⇒ Promise
- .info(msg) ⇒ Promise
- .log(msg) ⇒ Promise
- .debug(msg) ⇒ Promise

new RFC3164([options])

Construct a new RFC3164 formated Syslog object with user options

Param	Type	Default	Description
[options]	`object`		Options object
[options.applacationName]	`string`	`"'NodeJSLogger'"`	Applacation
[options.hostname]	`string`	`"os.hostname"`	The name of this server
[options.facility]	`number`	`23`	Facility code to use sending this message
[options.color]	`boolean`	`false`	Apply color coding encoding tag with syslog message text
[options.extendedColor]	`boolean`	`false`	Use the extedned ANSI color set encoding tag with syslog message text
[options.colors]	`object`		User defended colors for severites
[options.colors.emergencyColor]	`string`		A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended)
[options.colors.alertColor]	`string`		A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended)
[options.colors.criticalColor]	`string`		A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended)
[options.colors.errorColor]	`string`		A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended)
[options.colors.warningColor]	`string`		A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended)
[options.colors.noticeColor]	`string`		A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended)
[options.colors.informationalColor]	`string`		A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended)
[options.colors.debugColor]	`string`		A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended)
[options.server]	`Syslog`	`false`	A {@link module:SyslogPro~Syslog

rfC3164.color : `boolean`

Kind: instance property of RFC3164

rfC3164.extendedColor : `boolean`

Kind: instance property of RFC3164

rfC3164.setColor()

Sets the color to be used for messages at a set priority

Kind: instance method of RFC3164
Throws:

Error A standard error object

Access: public

Param	Type	Description
[colors.emergencyColor]	`string`	A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended)
[colors.alertColor]	`string`	A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended)
[colors.criticalColor]	`string`	A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended)
[colors.errorColor]	`string`	A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended)
[colors.warningColor]	`string`	A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended)
[colors.noticeColor]	`string`	A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended)
[colors.informationalColor]	`string`	A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended)
[colors.debugColor]	`string`	A RGB Hex coded color in the form of #FFFFFF or as or the ANSI color code number (30-37 Standard & 0-255 Extended)

rfC3164.buildMessage(msg, [options]) ⇒ `Promise`

Building a formated message. Returns a promise with a formated message

Kind: instance method of RFC3164
Returns: Promise - A Syslog formated string acording to the selected RFC
Throws:

Error A standard error object

Access: public

Param	Type	Default	Description
msg	`string`		The Syslog Message
[options]	`object`		Options object
[options.severity]	`number`	`7`	An array of structure
[options.colorCode]	`number`	`36`	The ANSI color code to use if message coloration is selected

rfC3164.send(msg, [options]) ⇒ `Promise`

send a RFC5424 formated message. Returns a promise with the formated message that was sent. If no server connection was defined when the class was created a defualt Syslog connector will be used.

Kind: instance method of RFC3164
Returns: Promise - A Syslog formated string acording to the selected RFC
Throws:

Error A standard error object

Access: public
See: SyslogPro~Syslog

Param	Type	Default	Description
msg	`string`		The unformated Syslog message to send
[options]	`object`		Options object
[options.severity]	`number`	`7`	An array of structure
[options.colorCode]	`number`	`36`	The ANSI color code to use if