lastw/snitch

Client-side log-sending tool

snitch

Periodically sends client-side logs to specified url.

• Zero-dependency;
• IE9+;
• Cordova/PhoneGap apps compatible;
• Easy integration with Segment.IO server HTTP API.

installation

bower install snitch

usage

var snitch = new Snitch('/path/to/log/service');

snitch.log('snitch enabled');

Full config:

var snitch = new Snitch({
  url: '/path/to/log/service', // do not forget about cross-origin policy
  interval: 1000 * 60 * 5, // send logs every 5 minutes
  ttl: 1000 * 60 * 24, // time to live
  solidMode: false, // weak consistency, do not try to send every single log
  capacity: 100 // how much log records could be stored before syncing to server
});

contribute

npm install
npm test

license

MIT.

snitch's Issues

Uncaught QuotaExceededError: Failed to execute 'setItem' on 'Storage': Setting the value of 'snitch' exceeded the quota.

Looks like it is very easy to pass large amount data to Snitch.log() without any validation to throw this error.

Prepare snitch for module systems

https://github.com/umdjs/umd

There are some wrappers for build systems:
https://github.com/alexlawrence/grunt-umd
https://github.com/phated/gulp-wrap-umd

Use sinon.js or similar library

For timeouts testing, spying, xhr etc.

https://github.com/lastw/snitch/blob/master/tests/main.js#L161
http://sinonjs.org/