Class: Log

Log(configurationopt, defaultMetaopt)

new Log(configurationopt, defaultMetaopt)

A log class to manage Console and Syslog transports
Parameters:
Name Type Attributes Default Description
configuration Object <optional>
 A configuration object
Properties
Name Type Description
host String Host to send logs
appName String An uniq name for app
protocol String A protocol to send logs (UPD or TCP)
port Number A port to connect
facility String An user
connection.path String A path to write logs
connection.timestamp String <optional>
 false Toggle on/off timestamp
connection.colors String <optional>
 true Toggle on/off console.log colors
defaultMeta Object <optional>
 {} A default metadata to send on every log
Author:
Source:

Methods

assingToDefaultMeta(defaultMeta)

Assing new properties to metadata object and override if already exists one or more properties
Parameters:
Name Type Description
defaultMeta Object A default metadata to bind
Source:

debug(type, namespace, msg, metadataopt, stackTraceopt)

Log level debug - priority 3
Parameters:
Name Type Attributes Description
type String A log level
namespace String The log namespace
msg String A message like a commit
metadata Object <optional>
 A JSON data with important information to find logs
stackTrace Error <optional>
 An error stack
Source:

error(type, namespace, msg, metadataopt, stackTraceopt)

Log level error - priority 0
Parameters:
Name Type Attributes Description
type String A log level
namespace String The log namespace
msg String A message like a commit
metadata Object <optional>
 A JSON data with important information to find logs
stackTrace Error <optional>
 An error stack
Source:

info(type, namespace, msg, metadataopt, stackTraceopt)

Log level info - priority 2
Parameters:
Name Type Attributes Description
type String A log level
namespace String The log namespace
msg String A message like a commit
metadata Object <optional>
 A JSON data with important information to find logs
stackTrace Error <optional>
 An error stack
Source:

setDefaultMeta(defaultMeta)

Override default metadata object
Parameters:
Name Type Description
defaultMeta Object A default metadata to send on every log
Source:

setParams(defaultMeta)

Override default metadata object
Parameters:
Name Type Description
defaultMeta Object A default metadata to send on every log
Deprecated:
  • Yes
Source:

toError(err) → {String}

Parse every property from error to string
Parameters:
Name Type Description
err Error
Source:
Returns:
Striginfied error
Type
String

warn(type, namespace, msg, metadataopt, stackTraceopt)

Log level warn - priority 1
Parameters:
Name Type Attributes Description
type String A log level
namespace String The log namespace
msg String A message like a commit
metadata Object <optional>
 A JSON data with important information to find logs
stackTrace Error <optional>
 An error stack
Source: