crowsnest v0.0.2

node-crowsnest

NodeJS Crow's Nest SDK.

var cn = require('crowsnest');

// Grab these from the profile section
cn.config.productKey = '8ygh638f3nn2937t';
cn.config.productSecret = 'p2f7j308dw0foie4';

cn.alert(cn.severity.DEBUG, 1, 'Hello World');

Installation

Install node-crowsnest by running:

$ npm install --save crowsnest

Documentation

• cn
  • .severity
    • .DEBUG : Number
    • .INFO : Number
    • .ERROR : Number
    • .CRITICAL : Number
  • .config
    • .getSerial
  • .alert(severity, tag, message, callback)

cn.severity

This severity table matches Crow's Nest v1 packet spec.

Kind: static property of cn
Summary: Crow's Nest severity table
Access: public

• .severity
  • .DEBUG : Number
  • .INFO : Number
  • .ERROR : Number
  • .CRITICAL : Number

severity.DEBUG : Number

Kind: static property of severity
Summary: Describe a debug event
Access: public

severity.INFO : Number

Kind: static property of severity
Summary: Describe an information event
Access: public

severity.ERROR : Number

Kind: static property of severity
Summary: Describe an error event
Access: public

severity.CRITICAL : Number

Kind: static property of severity
Summary: Describe a critical event
Access: public

cn.config

This object should be edited to add the following properties:

• String productKey.
• String productSecret.

Kind: static property of cn
Summary: Configuration object
Access: public

config.getSerial

This function returns the device MAC address by default. You may customise it to fit your needs as follows:

cn.config.getSerial = function(callback) {
	return callback(null, 'mySerial');
};

Kind: static property of config
Summary: Get the serial number of a device
Access: public

Example

cn.config.getSerial(function(error, serial) {
	if (error) throw error;
	console.log(serial);
});

cn.alert(severity, tag, message, callback)

Notice you must set cn.config.productKey and cn.config.productSecret before using this function.

The serial property defaults to the MAC address of the running device. You may set a new function to cn.config.getSerial to customise this.

Kind: static method of cn
Summary: Send an event to Crow's Nest
Access: public

Example

var cn = require('crowsnest');

// Grab these from the profile section
cn.config.productKey = '8ygh638f3nn2937t';
cn.config.productSecret = 'p2f7j308dw0foie4';

cn.alert(cn.severity.DEBUG, 1, 'Hello World', function(error, response) {
	if (error) throw error;
	console.log(response);
});

Support

If you're having any problem, please raise an issue on GitHub and I'll be happy to help.

Tests

Run the test suite by doing:

$ npm test

Contribute

• Issue Tracker: github.com/jviotti/node-crowsnest/issues
• Source Code: github.com/jviotti/node-crowsnest

Before submitting a PR, please make sure that you include tests, and that coffeelint runs without any warning:

$ gulp lint

License

The project is licensed under the MIT license.