sherlogjs

by burakson

burakson / sherlogjs

JavaScript error and event tracker application.

465 Stars 38 Forks Last release: Not found MIT License 40 Commits 1 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Sherlogjs

Sherlog.js

JavaScript error and event tracker application.

Features

  • Tracks JavaScript errors
  • Tracks faulty ajax requests
  • Tracks custom events
  • Reporting dashboard
  • Lightweight tracking framework (~2KB Minified)

Prerequisites

  • Node
  • Npm
  • Bower
  • Gulp
  • MongoDB

Screenshots

Dashboard Page Tracking Details Page

Installation

$ git clone git://github.com/burakson/sherlogjs.git
$ cd sherlogjs
$ npm install && bower install

Configuration & Usage

  • Copy
    config/config.json.example
    in
    config/config.json
    and configure the application
  • Hit
    gulp
    to prepare the framework
  • Start the server:

$ npm start
- Add the following script into your web document before any other
 tag

- Done! Sherlog is now tracking errors.

API

Sherlog provides a public method for event tracking as shown in the below examples.

Sherlog.push( String/Object , callback )

Example 1:

Sherlog.push({
    username: 'John Doe',
    age: 35,
    action: 'Clicked on an image'
}, function() {
    // event tracking pixel is fired.
});

Example 2:

javascript
Sherlog.push('User has clicked to the button', function() {
    // event tracking pixel is fired.
});

License

MIT License © Burak Son

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.