node-crowsnest
NodeJS Crow's Nest SDK.
var cn = ; // Grab these from the profile sectioncnconfigproductKey = '8ygh638f3nn2937t';cnconfigproductSecret = 'p2f7j308dw0foie4'; cn;
Installation
Install node-crowsnest
by running:
$ npm install --save crowsnest
Documentation
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
Number
severity.DEBUG : Kind: static property of severity
Summary: Describe a debug event
Access: public
Number
severity.INFO : Kind: static property of severity
Summary: Describe an information event
Access: public
Number
severity.ERROR : Kind: static property of severity
Summary: Describe an error event
Access: public
Number
severity.CRITICAL : 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:
cnconfig { return ;};
Kind: static property of config
Summary: Get the serial number of a device
Access: public
Param | Type | Description |
---|---|---|
callback | function |
callback (error, serial) |
Example
cnconfig;
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
Param | Type | Description |
---|---|---|
severity | Number |
severity |
tag | Number |
tag |
message | * |
message |
callback | function |
callback (error, response) |
Example
var cn = ; // Grab these from the profile sectioncnconfigproductKey = '8ygh638f3nn2937t';cnconfigproductSecret = 'p2f7j308dw0foie4'; cn;
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.