Skip to content

alertlogic/al-collector-js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

c7d45fa · Apr 5, 2019

History

41 Commits
Nov 26, 2018
Mar 25, 2019
Jan 18, 2018
Mar 25, 2019
Jan 17, 2018
Mar 20, 2019
Nov 26, 2018
Jun 5, 2018
Nov 26, 2018
Mar 25, 2019
Dec 18, 2018
Dec 18, 2018
Jan 7, 2019
Mar 8, 2019
Apr 5, 2019
Mar 8, 2019

Repository files navigation

al-collector-js

Build Status

Alert Logic cloud collector common library.

Overview

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

HOWTO consume this library in Node.js

Create a package.json file for npm 2.7.0 (or greater) in the root of your Node.js 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": {
    "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": "*",
    "moment": "^2.19.2",
    "request": "*",
    "request-promise-native": "*",
    "al-collector-js": "git://github.com/alertlogic/al-collector-js#master"
  },
  "author": "Alert Logic Inc."
}

Compiling proto

You will need pbjs tool in order to compile protobuf definitions located in proto:

npm install -g protobufjs
make pb-clean
make pb

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