Apache SensSoft User Ale JS (Incubating)

Clone this repo:
  1. 0679b33 merge branch refactor into master by Clay Gimenez · 10 months ago master
  2. 8edd534 Fixed error with CORS requests. by Rob Foley · 12 months ago
  3. 4c5deec Added missing dev dependency for nodemon by Rob Foley · 12 months ago
  4. cd02c84 Updated logging output to create the log directory if it does not exist. by Rob Foley · 12 months ago
  5. a33490d Updated log file name to be Windows compatible. Made logs valid JSON. by Rob Foley · 12 months ago

UserAle.JS

The official JavaScript client for UserAle.

Additional documentation can be found at http://draperlaboratory.github.io/useralejs/

Use and Configure

To include Userale.js in your project:

<script src="http://draperlaboratory.github.io/useralejs/userale.min.js"></script>

HTML5 Data Parameters are used to configure Userale.js. For example, to set the logging URL:

<script src="userale.js" data-url="http://yourLoggingUrl"></script>

The complete list of configurable options is:

ParamDescriptionDefault
data-urlLogging URLhttp://localhost:8000/logs
data-autostartShould Userale.js start on page loadtrue
data-intervalDelay between transmit checks5000 (ms)
data-thresholdMinimum number of logs to send5
data-userUser identifiernull
data-versionApplication version identifiernull
data-log-detailsToggle detailed logs (keys pressed and input/change values)false
data-resolutionDelay between instances of high frequency logs (mouseover, scroll, etc.)500 (ms)
data-user-from-paramsQuery param in the page URL to fetch userId fromnull
data-toolName of tool being loggednull

Next Up

Our top priority is to improve the testing system and to complete test coverage. After that is complete:

  • Use web workers to remove load from main thread if available
  • Update the example server to present a simple test app/interface
  • Release Userale.js through channels like NPM, Bower, etc.

Contributing

Contributions are welcome! Simply submit an issue report for problems you encounter or a pull request for your feature or bug fix. The core team will review it and work with you to incorporate it into Userale.js.

License

Copyright 2016 The Charles Stark Draper Laboratory, Inc.

Userale.js is released under the Apache v2.0 License. See the LICENSE file for more information.