aws-cwlogs v2.5.1

aws-cwlogs

This module pulls the latest events from a specified log group in AWS CloudWatch Logs and prints the output to console. The module keeps pulling logs while its running.

Installation

You can install aws-cwlog both locally

npm install aws-cwlogs

or globally

npm install aws-cwlogs -g

Configuration

To use aws-cwlogs it's important that you have properly installed the aws-cli and configured it with your credentials.

Local Usage

If you installed aws-cwlogs locally you can simply use it like shown in the example:

  const CwLogs = require('aws-cwlogs');

  const options = {
    region: 'eu-west-1',
    logGroupName: '/aws/lambda/test-lambda',
    streamname: 'production',                //optional
    momentTimeFormat: 'hh:mm:ss:SSS',        //optional
    logFormat: 'lambda',                     //optional
    interval: 2000                           //optional
    credentials: new AWS.Credentials({       //optional
      accessKeyId: 'xxx',
      secretAccessKey: 'xxx'
    })
  };

  const lambdaLogger = new CwLogs(options);
  lambdaLogger.start();

If you want to stop aws-cwlogs from pulling the new data from the specified log group you can simply use the stop command:

lambdaLogger.stop();

Options

• region: required AWS region of the log group;
• logGroupName: required name of AWS CloudWatch Logs log group;
• streamname: logs will be printed from the last stream name found unless specified;
• momentTimeFormat: moment.js log timestamp format;
• logFormat: logs generated from AWS Lambda are more readable if you set this option to "lambda"; You can also pass a function(timestamp, message, event)) if you want to customize the format of your logs.
• interval: interval between every log request to AWS CloudWatch Logs in milliseconds (keep it at 2000 ms or greater);

Global Usage

If you installed aws-cwlogs globally you can use this commands:

• (logGroupName) (logStreamName) (options) - prints log data from the specified log group and log stream to console; all params are optional and if not set a list of all available options will be printed;

  • --region -r - Cloud Watch Logs region;
  • --timeformat -t - momentjs time format;
  • --logformat -f - logs generated from AWS Lambda are more readable if you set this option to "lambda";
  • --interval -i - interval between each log request;

• cwlogs configure - setup cwlogs default settings such us region, timeformat, logformat and interval;