mouselog

Mouselog.js

Mouselog.js is the client-side agent for Microsoft's Mouselog, a user behavior monitoring platform for websites.

Embedded JS

Embed Mouselog in your HTML files:

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/mouselog@0.0.7-beta1/mouselog.js"></script>
<script>
    mouselog.run("Your_Server_Url", "Your_Website_Id");
</script>

You can also refer mouselog dynamically in Javascript:

(function() {
    var script = document.createElement("script");
    script.src = "https://cdn.jsdelivr.net/npm/mouselog@0.0.7-beta1/mouselog.js";
    script.onload = () => {
        mouselog.run("Your_Server_Url", "Your_Website_Id");
    }
    var t = document.getElementsByTagName("script");
    var s = t.length > 0 ? t[0].parentNode : document.body;
    s.appendChild(script, s);
})();

NPM

Install Mouselog.js via

npm i mouselog --save

Then load and configure mouselog

const mouselog = require('mouselog');
let config = {
    // Set upload mode: "periodic" or "event-triggered"
    uploadMode: "periodic",

    // If `uploadMode` == "periodic", data will be uploaded every `uploadPeriod` ms.
    // If no data are collected in a period, no data will be uploaded
    uploadPeriod: 5000,

    // If `uploadMode` == "event-triggered"
    // The website interaction data will be uploaded when every `frequency` events are captured.
    frequency: 50,

    // The website interaction data will be encoded by `encoder` before uploading to the server.
    encoder: JSON.stringify,
    // The response data will be decoded by `decoder` 
    decoder: x => x, 
    // Use GET method to upload data? (stringified data will be embedded in URI)
    enableGET: false, 
    // Time interval for resending the failed trace data
    resendInterval: 3000
};

Run Mouselog and it will automatically collect all you want.

mouselog.run("YOUR_SERVER_URL", "YOUR_WEBSITE_ID", config);

You can also deactivate Mouselog by calling mouselog.stop().

Demo

Mouselog-demo

Schema

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [e-mail] with any additional questions or comments.