npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2022 – Pkg Stats / Ryan Hefner

flagon-userale

v2.3.0

Published

UserALE.js is the UserALE client for DOM and JavaScript-based applications. It automatically attaches event handlers to log every user interaction on a web page, including rich JS single-page apps.

Downloads

107

Readme

Apache Flagon UserALE.js (Incubating)

Node.js CI Snyk Vulnerabilities for npm package Maintenance npm License

Apache UserALE.js is part of the Apache Flagon Project. It is a client side instrumentation library written in JavaScript designed for easy deployment and lightweight configuration in gathering logs from your web applications for user behavioral analytics.

Once included in your project, Apache UserALE.js provides a comprehensive behavioral logging capability, capturing every event on every element rendered in your DOM.

Additional documentation and a demonstration can be found at the Apache Flagon website.

Quickstart Guide

  1. Include UserALE.js in your project as either a module or script tag
  2. Set up a logging end-point. Try our example server utility or try out our Elasticsearch (ELK) stack example.
  3. Configure UserALE.js settings using our API, including where to POST logs to (port:8000 for UserALE example or port:8100 of ELK/Logstash)
  4. Further explore the UserALE.js API to customize your log feed, add filters, custom logs, and modify logs themselves. Explore a few examples here and a wider set in our example utility.
  5. Visualize and analyze your logs. See our sample kibana dahsboards for behavioral analytics.

Table of Contents

What's New
Installation
Configure
Usage
Examples
Indexing, Storing, and Visualizing Logs
Modifying Source
Contributing
License

What's New in Version 2.3.0?

  • Fixes issue in autostart configurations and start(), stop() export usage
  • Adds additional unit tests for autostart configurations
  • Adds React App.js example/test utility
  • Adds additional UserALE.js custom logging examples
  • Minor updates to update deprecated downstream dev dependencies
  • Minor changes to documentation, updated examples

See our CHANGELOG for a complete list of changes.

Installation

Either through cloning our source repo or by using npm:

npm install flagon-userale

To include UserALE.js as an object in your project, include as a module:

import * as userale from 'flagon-userale';

or

const userale = require('flagon-userale');

Our webpack example illustrates this use-case.

You can also include UserALE.js as a script-tag. A pre-built version of the userale script is included in our package and repositories:

<script src="./node_modules/flagon-userale/build/userale-2.3.0.min.js"></script>

Our script tag example illustrates this use-case

If you include UserALE.js as a script-tag, consider installing via npm as a development dependency:

npm install --save-dev flagon-userale

Or if you want to use a CDN, then you can use something like

<script src="https://cdn.jsdelivr.net/npm/[email protected]/build/userale-2.3.0.min.js"></script>

We also support a WebExtension that can be added to your browser in developer mode. Follow the link for instructions.

Once UserALE.js is installed in your project, your application will start generating logs automatically.

Configure

Some configuration is necessary. At minimum you will need to provide UserALE.js an end-point to ship logs to; default behavior is to ship logs to localhost:8000.

NOTE: In order to facilitate testing configuration and usage of UserALE.js, we have included an example logging server in our example directory. This is a very helpful utility that works with both included module examples and script-tag examples. We strongly recommend experimenting with it.

Configuration details follow:

If you have included UserALE.js in your project as a module, you will need to use our userale.options() function, which exposes library configuration options through our API.

For example, if you do not want UserALE.js to start logging automatically, you can modify this behavior through the userale.options() API (autostart config).

Then, you can use the userale.start() API export to begin logging at the appropriate time during page load or triggered from an event:

const changeMe = "me";
userale.options({
    "userId": changeMe,
    "autostart": false,
    "url": "http://localhost:8000/",
    "version": "next",
    "logDetails": false,
    "sessionID": "this one"
});

userale.start();

Additional examples of userale.options() can be found in our example directory.

The complete list of configurable parameters that can be configured via userale.options() is:

| Param | Description | Default | |---|---|---| | url | Logging URL | http://localhost:8000 | | autostart | Should UserALE.js start on page load | true | | transmitInterval | Delay between transmit checks | 5000 (ms) | | logCountThreshold | Minimum number of logs to send | 5 | | userId | User identifier | null | | sessionID | Session identifier | null | | version | Application version identifier | null | | logDetails | Toggle detailed logs (keys pressed and input/change values) | false | | resolution | Delay between instances of high frequency logs (mouseover, scroll, etc.) | 500 (ms) | | userFromParams | Query param in the page URL to fetch userId from | null | | toolName | Name of tool being logged | null | | authHeader | Authorization header to be passed to logging endpoint | null |

If you have included UserALE.js as a script-tag in your project, you can use HTML data parameters to pass configuration options to the library through the script tag. For example:

  <script
          src="./node_modules/flagon-userale/build/userale-2.3.0.min.js"
          data-url="http://localhost:8000/"
          data-user="example-user"
          data-version="2.3.0"
          data-tool="Apache UserALE.js Example"
  ></script>

You have access to the same parameters listed above, however, naming conventions vary slightly for use in HTML:

| Param | Description | Default | |---|---|---| | data-url | Logging URL | http://localhost:8000 | | data-autostart | Should UserALE.js start on page load | true | | data-interval | Delay between transmit checks | 5000 (ms) | | data-threshold | Minimum number of logs to send | 5 | | data-user | User identifier | null | | data-version | Application version identifier | null | | data-log-details | Toggle detailed logs (keys pressed and input/change values) | false | | data-resolution | Delay between instances of high frequency logs (mouseover, scroll, etc.) | 500 (ms) | | data-user-from-params | Query param in the page URL to fetch userId from | null | | data-tool | Name of tool being logged | null | | data-auth | Authorization header to be passed to logging endpoint | null |

If you are using our WebExtension, you can modify some of these parameters via the extensions' options page.

Usage

Including UserALE.js in your project as a module attaches the UserALE.js script as an object to the page.

We have exposed a number of functions that assist you in modifying, filtering, and customizing logs

A complete list of available functions are as follows:

| Function | Description | Notes | |---|---|---| | userale.options | modify userale's configuration option | see top level README for complete list of options | | userale.filter | filters out logs from logging queue by keys or values | filters are callbacks with global scope | | userale.map | modify/add log keys or values | mappings are callbacks with global scope | | userale.log | appends a custom log to the log queue | the custom log object is an object key:value pairs | | userale.packageLog | transforms the provided event into a log and appends it to the log queue | designed for HTML events | | userale.packageCustomLog | packages the provided customLog to include standard meta data and appends it to the log queue | designed for non HTML events| | userale.details | defines the way information is extracted from various events | supports packageLog/packageCustomLog 'details' | | userale.getSelector | builds a string CSS selector from the provided HTML element id | populates 'target' field in packaged logs | | userale.buildPath| builds an array of elements from the provided event target, to the root element (DOM path) | populates the 'path' field in packaged logs | | userale.start | used to start the logging process if | unecessary if 'autostart' is set to true in initial setting (default) | | userale.stop | halts the logging process. Logs will no longer be sent | will need to invoke userale.start to restart logging |

Including UserALE.js as a script-tag provides you access to the same functions listed above. However, UserALE.js essentially becomes a property of the DOM. As such, you'll need to call functions as a window property:

userale.options = window.userale.options

Examples

We provide a number of examples to illustrate how the functions above can be used with sample webpages and logging servers. These are tailored for module examples and script-tag examples. Select examples are below:

Filter your logs with userale.filter:

userale.filter(function (log) {
    var type_array = ['mouseup', 'mouseover', 'mousedown', 'keydown', 'dblclick', 'blur', 'focus', 'input', 'wheel'];
    var logType_array = ['interval'];
    return !type_array.includes(log.type) && !logType_array.includes(log.logType);
});

Modify (add/remove) log fields with surgical precision using userale.map:

userale.map(function (log) {
        var targetsForLabels = ["button#test_button"];
        if (targetsForLabels.includes(log.target)) {
            return Object.assign({}, log, { CustomLabel: "Click me!" });
        } else {
            return log;  
        } 
      });

(Additional examples illustrate precision custom labeling, using a variety of functions.)

Generate custom logs with userale.log:

document.addEventListener('change', function(e) {
    if (e.target.value === 'log') {
        userale.log({
            target: userale.getSelector(e.target),
            path: userale.buildPath(e),
            type: e.type,
            logType: 'custom',
            userAction: false,
            details: 'I can make this log look like anything I want',
            customField1: 'foo',
            customField2: 'bar',
            userId: userale.options().userId,
            toolVersion: userale.options().version,
            toolName: userale.options().toolName,
            useraleVersion: userale.options().useraleVersion,
            sessionID: userale.options().sessionID,
            customLabel: "(custom) Log Example"
        });
    }
});

User our own log packaging pipeline to streamline custom HTML event logging with userale.packageLog:

document.addEventListener('change', function(e){
    if (e.target.value === 'packageLog') {
        /**You can then use the 'Mapping' API function to modify custom logs created with the packageLog function*/
        userale.map(function (log) {
            var targetsForLabels = ['change'];
            if (targetsForLabels.includes(log.type)) {
                return Object.assign({}, log, { logType: 'custom', customLabel: 'packageLog Example' });
            } else {
                return log;
            }
        });
        /**You can also use the details function to package additional log meta data, or add custom details*/
        userale.packageLog(e, userale.details(userale.options(),'change'));
    } else {
        return false
    }
});

Again, see Usage for differences in invoking these functions with module and script-tag includes.

You can find additional examples on our website.

Indexing, Storing and Visualizing Logs

We recommend Elastic products, specifically an ELK cluster, for indexing and storing logs in productions.

You can find a 'sand-box' ELK build, configuration files, and visualization/dashboards tailored for UserALE.js in the Apache Flagon parent repository.

We also provide some documentation about stack-considerations on our project website.

Modifying Source

You may wish to modify UserALE.js to suite your needs. After making modification to UserALE.js src, you will need to rebuild the UserALE.js script (and run tests).

To (re)build UserALE.js:

npm run build

To run UserALE.js unit tests:

npm run test

We use gulp-mocha for unit tests. The results will print to your terminal:

...
    attachHandlers
    ✓ attaches all the event handlers without duplicates
    ✓ debounces bufferedEvents (505ms)
    defineDetails
      - configures high detail events correctly
...

  45 passing (954ms)
  1 pending

Any failing tests will also be logged in the terminal. If there are failing tests, please consider submitting an issue report.

For more guidance on modifying Flagon UserALE src code, check out the guide on our website.

Contributing

Contributions are welcome! Simply submit an issue. Pull requests are welcome. The core team will review it and work with you to incorporate it into UserALE.js. If you want to become a contributor to the project, see our contribution guide.

Join the conversation: tell us your needs, wishes, and interests by joining our mailing list!

License

Apache Flagon UserALE.js is provided under Apache License version 2.0. See LICENSE and NOTICE files at MASTER for more details.

Disclaimer

Apache Flagon is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator project. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

A copy of this disclaimer can also be found in UserALE's source repository.