The official JavaScript client for Apache Flagon.
Additional documentation can be found at http://flagon.incubator.apache.org/userale/
Several dependencies are required, simply execute the following and you are good to go.
npm install
To build UserALE.js:
npm run build
To test UserALE.js:
npm run test
... you should eventually see something as follows
...
26 passing (837ms)
1 pending
Any failing tests will also be logged in the terminal. If there are failing tests, please consider logging an issue in JIRA.
To include UserALE.js in your project:
<script src="/path/to/userale-1.0.0.min.js"></script>
HTML5 Data Parameters are used to configure UserALE.js. For example, to set the logging URL:
<script src="/path/to/userale-1.0.0.min.js" data-url="http://yourLoggingUrl"></script>
The complete list of configurable options is:
| 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 |
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.
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.
Apache Flagon UserALE.js is provided under Apache License version 2.0. See LICENSE file for more details.