ipsense-logger v1.0.26

ipsense-logger

ipsense-logger is heavily based on dashbot-logger which allows you to log to a specific log group in CloudWatch Logs apart from the default log group that Lambda functions set up. The logger works around the 5 putLogEvent/s limit by batching up log events and using a pool of log streams to put log events to.

This version adds a couple of new methods to bufferize, and flush logs allowing you to keep information together in the logstream.

Setup

This package uses the aws-sdk, and will require an AWS account.

npm install --save ipsense-logger

Pass in your AWS credentials and a region as follows, or configure using one of the options listed here

• region - string aws region
• accessKeyId - string access key
• secretAccessKey - string secret key

• logGroupName - (required) string user specified log group name

const configuration = {
  region: <REGION>,
  accessKeyId: <ACCESS-KEY>,
  secretAccessKey: <SECRET-KEY>,
  logGroupName: <LOG-GROUP-NAME>,
}

const Logger = require('ipsense-logger')
const logger = new Logger(configuration)

You can also pass in additional configuration options to specify the behavior of the resource pool for log streams and naming of log streams.

Configuration Options

Available options:

• debug - (default: false, boolean) logs helpful debugging information
• logStreamPrefix - (default: dashbot, string) user specified log stream prefix
• maxStreams - (default: 10, number) max number of log streams to use concurrently

• minStreams - (default: 1, number) min number of log streams to use concurrently

Optionally, you can use the following environment variables to set certain options:

• for logGroupName set DASHBOT_LOG_GROUP_NAME
• for logStreamPrefix set DASBOT_LOG_STREAM_PREFIX
• for maxStreams set DASHBOT_LOG_MAX_STREAMS
• for minStreams set DASHBOT_LOG_MIN_STREAMS

Example

const configuration = {
  'logGroupName': 'test-group',
  'logStreamPrefix': 'test-stream',
  'maxStreams': 5,
  'minStreams': 2,
  'debug': true,
  'printErrors': true,
}

const Logger = require('ipsense-logger')
const logger = new Logger(configuration)

logger.buffer('test1') // add string test1 to log buffer
logger.buffer('test2') // add string test2 to log buffer
logger.buffer('test3') // add string test3 to log buffer
logger.buffer('test4') // add string test4 to log buffer
...
logger.flush() //logs buffer's content to log-group 'test-group', and clear the buffer