@linkorb/activity-tracker v1.1.1

activity-tracker

activity-tracker.js is a simple way to track browser side user behavior. It is helpful for analyzing users' behavior when reading your web articles.

Installation

npm install @linkorb/activity-tracker

To build activity-tracker into your lib with webpack:

require('@linkorb/activity-tracker');

Demo

Check the demo/ directory for an demonstration + example on how to use activity-tracker. To run the demo for test:

php -S 127.0.0.1:8888

Then you can access the demo from: http://localhost:8888/demo

It is possible to configure the activity-tracker:

<!-- platform.js is used for reporting the agent info. optional -->
<script src="node_modules/platform/platform.js"></script>
<!-- load activity-tracker -->
<script src="dist/at.min.js"></script>
<!-- configuread activity-tracker -->
<script>
    // turn on debug mode. Optional
    at('debug')

    // serverUri is required
    // without serverUri nothing is recorded, nor reported

    // server address to report to - websocket
    // at('sender', 'websocket'); // optional, the default sender is websocket
    at('serverUri', 'ws://127.0.0.1:7777')

    // server address to report to - ajax
    at('sender', 'xmlhttp')
    at('serverUri', 'http://localhost/myWebserver')
    
    // time interval to report to the server, in ms. Optional, default 5000
    at('reportInterval', 6000) 

    // custom/meta variables. Optional
    at('meta', 'meRock')
    at('meta', 'contentId', 6)
    at('meta', 'userGroup', 'Cool people')
    at('meta', 'requestId', 'aa-bb-cc-dd-eee')
</script>

Re-provision

When new content/page is loaded without page reload, e.g. AJAX, you can re-provision the activity-tracker:

<script>
at('meta', 'contentId', 7);
at('meta', 'requestId', 'ff-gg-hh-ii-jjj');
atProvision();
</script>

Subscribe only to certain events

By default, activity-tracker reports the following events: mousemove, click, dblclick, keyup, scroll. You can specify only certain events are reported:

// only report click and scroll events
at('subscribe', 'click, scroll');
atProvision();

Inspect local activity stack

<script>
// list all the activity objects recorded
atStack()
</script>

Build from source

To change the source file and build, simply use webpack.

# generates dist/at.js
webpack -d
# generates dist/at.min.js
webpack -p