Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brettlangdon/sleuth
Simple JavaScript metrics beacon library
https://github.com/brettlangdon/sleuth
Last synced: about 1 month ago
JSON representation
Simple JavaScript metrics beacon library
- Host: GitHub
- URL: https://github.com/brettlangdon/sleuth
- Owner: brettlangdon
- Created: 2014-06-16T16:10:13.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-06-21T22:20:08.000Z (over 10 years ago)
- Last Synced: 2024-10-12T22:44:54.952Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 141 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Sleuth.js
========
Simple JavaScript metrics beacon library.
## Configuration Settings
* `url` - url/endpoint where to send all data (default: `/track`)
* `unload` - whether or not to call `sendAllData` on `window.onbeforeunload` (default: `true`)
* `ajax` - whether or not to use ajax to send data to `url` (default: `true`)\
* `performance` - whether or not to include `window.performance` data on `window.onbeforeunload` (default: `true`)
* `useLocalStorage` - whether or not to use `window.localStorage` to store page data if supported (default: `true`)
### AJAX
If `true` a normal ajax POST request is sent to `url` with the page `tags` encoded as url
query string parameters and the page `data` is posted as a JSON object.
If `false` a javascript pixel is dropped pointing to `url` with the page `tags` encoded as url
query string parameters and where the page `data` is added to the query string `d` where the
value is a url escaped base64 encoded version of the JSON object.
### LocalStorage
If `useLocalStorage` is `true` and LocalStorage is supported on the client then `window.localStorage`
is used to store all page data, meaning data can be persisted between page requests.
Otherwise the data is stored in an object and is volatile.
## Usage
Include js on your page:
```html
```
### Configure
You can configure custom settings like so:
```html
Sleuth.init({
url: '/endpoint',
unload: false,
// other options here
});
```
### Tagging the Page
Add tags to the session:
```html
Sleuth.tag('user', 'guest');
```
### Tracking Data
Track some data:
```html
Sleuth.track('clicks', 5);
```
### Syncing Data
Manually send some data:
```html
Sleuth.sendData({
key: 'value',
});
```
Manually send all data:
```html
Sleuth.sendAllData();
```
Manually add `window.performance` data to `Sleuth`:
```html
Sleuth.captureWindowPerformance();
```
## License
```
The MIT License (MIT) Copyright (c) 2014 Brett Langdon (http://brett.is)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```