close
Skip to content
This repository was archived by the owner on Apr 17, 2024. It is now read-only.

seek-oss/splunk-logger

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

63 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logger

Generates Splunk consumable logs in node 4.3.2 AWS Lambdas.

Install

npm install --save @seek/splunk-logger

Usage

Provides the usual error, warn, info, and debug

Log messages are formatted like this where the name component will only be used if given in the logger's constructor :

name=<name>, level=<level>, msg=<msg>

Kind: global class

new Logger([name], [level])

Create a logger

Param Type Default Description
[name] string Optional name to give the logger. This will be added to all log bodies.
[level] string "info" Optional minimum level to output. Defaults to info

logger.setLevel(level) ⇒ Logger

Set the minimum log level to output

Kind: instance method of Logger
Returns: Logger - this Logger instance

Param Type Description
level string Should be one of error, warn, info, debug

logger.log(msg, level)

Emit a log message at the given level

Kind: instance method of Logger

Param Type Description
msg * Thing to be logged. If given an object literal it will be appended to the log in the format <code>key1=value1, key2=value2</code>
level string log level to be used in error, warn, info, debug. Defaults to info.

logger.error(msg)

Emit error level log

Kind: instance method of Logger

Param Type Description
msg * Thing to be logged. See log

logger.warn(msg)

Emit warn level log

Kind: instance method of Logger

Param Type Description
msg * Thing to be logged. See log

logger.info(msg)

Emit info level log

Kind: instance method of Logger

Param Type Description
msg * Thing to be logged. See log

logger.debug(msg)

Emit debug level log

Kind: instance method of Logger

Param Type Description
msg * Thing to be logged. See log

About

Generates Splunk consumable logs in Node JS 4.3.2 AWS Lambda functions.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors