README.md

al-aws-collector-js

Alert Logic cloud collector AWS common library.

Overview

This repository contains the common JavaScript functions used by Node.js collectors in the AWS cloud.

HOWTO use this library in an AWS Lambda function

Create a package.json file for npm 2.7.0 (or greater) in the root of your AWS Lambda function Node.js root directory. Include this repo in the dependencies and devDependencies section as required.

For example:

{
  "name": "al-my-collector",
  "version": "1.0.0",
  "description": "Alert Logic My Collector",
  "repository": {},
  "private": true,
  "scripts": {
    "start": "node index.js",
    "lint": "jshint --exclude \"./node_modules/*\" **/*.js",
    "test": "JUNIT_REPORT_PATH=./test/report.xml nyc --reporter=cobertura mocha --colors --reporter mocha-jenkins-reporter"
  },
  "devDependencies": {
    "aws-sdk": "*",
    "aws-sdk-mock": "*",
    "dotenv": "*",
    "clone": "*",
    "jshint": "^2.9.5",
    "mocha": "^3.5.3",
    "mocha-jenkins-reporter": "^0.3.10",
    "nyc": "^11.3.0",
    "rewire": "^2.5.2",
    "sinon": "^3.3.0"
  },
  "dependencies": {
    "async": "*",
    "cfn-response": "*",
    "moment": "^2.19.2",
    "request": "*",
    "request-promise-native": "*",
    "al-aws-collector-js": "git://github.com/alertlogic/al-aws-collector-js#master"
  },
  "author": "Alert Logic Inc."
}

Debugging

To get a debug trace, set an Node.js environment variable called DEBUG and specify the JavaScript module/s to debug.

E.g.

export DEBUG=*
export DEBUG=index

Or set an environment variable called "DEBUG" in your AWS stack (using the AWS console) for the "alertlogic-cwe-collector" AWS Lambda function, with value "index" or "*".

See debug for further details.

Known Issues/ Open Questions

• TBD.

Useful Links

• Node.js static code analysis tool
• Node.js rewire testing tool
• Node.js sinon testing tool