This package has been deprecated

Author message:

Use Beacon API.

kist-beacon

Front-end logging interface.

Installation

npm install kist-beacon --save
 
bower install kist-beacon --save

API

new Beacon(options)

Returns: Object

Options

url

Type: String
Default:
Required

Endpoint where your application will pass query parameters from AJAX call and do with them what you desire: save them to database, logfile on server, etc.

Data is sent via POST request so if your endpoint is CORS-like, beacon won’t work properly in browsers without CORS support.

js

Type: Boolean
Default: true

Log JS errors.

console

Type: Boolean
Default: false

Log console calls.

.send(data)

Returns: Object

Sends information to provided URL. Information will be send as standard GET request. Parsing should be done by back-end application.

data

Type: Object
Required

.destroy()

Destroys logger instance.

Examples

Create new instance.

var Beacon = require('kist-beacon');
var beacon = new Beacon({
    url: '/log',
    js: true,
    console: false
});

Message examples.

{
    "logType":"JS Error",
    "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/35.0.1916.153 Safari/537.36",
    "time":1403629312238,
    "errorMessage":"Uncaught ReferenceError: barfoo is not defined",
    "url":"http://example.com/",
    "lineNumber":12
}
 
{
    "logType":"Console call",
    "userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/35.0.1916.153 Safari/537.36",
    "time":1403629312238,
    "methodType":"log",
    "url":"http://example.com/",
    "message":"console call"
} 

Destroy instance.

beacon.destroy();

AMD and global

define(['kist-beacon'], cb);
 
window.kist.Beacon;

Browser support

Tested in IE8+ and all modern browsers.

Acknowledgments

• https://github.com/Lapple/ErrorBoard
• http://tobyho.com/2012/07/27/taking-over-console-log/
• http://stackoverflow.com/questions/8087240/if-i-override-window-onerror-in-javascript-should-i-return-true-or-false

License

MIT © Ivan Nikolić