https://github.com/burakson/sherlogjs

JavaScript error and event tracker application.
https://github.com/burakson/sherlogjs

Last synced: about 1 month ago
JSON representation

JavaScript error and event tracker application.

• Host: GitHub
• URL: https://github.com/burakson/sherlogjs
• Owner: burakson
• License: mit
• Created: 2014-06-30T10:00:39.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-11-19T02:21:20.000Z (about 9 years ago)
• Last Synced: 2024-10-19T10:36:23.190Z (about 2 months ago)
• Language: JavaScript
• Homepage:
• Size: 476 KB
• Stars: 476
• Watchers: 22
• Forks: 38
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-github-star - sherlogjs

README

        


  



# 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](https://github.com/burakson/sherlogjs/blob/images/screenshot1.png?raw=true "Dashboard Page")

![Tracking Details Page](https://github.com/burakson/sherlogjs/blob/images/screenshot2.png?raw=true "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

```

<script src="sherlog.min.js" data-environment="production">

```

- 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:**

```javascript

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](http://en.wikipedia.org/wiki/MIT_License) © [Burak Son](http://twitter.com/burakson)