Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hscells/bigbro
Website interaction logging service
https://github.com/hscells/bigbro
interaction logging website
Last synced: 7 days ago
JSON representation
Website interaction logging service
- Host: GitHub
- URL: https://github.com/hscells/bigbro
- Owner: hscells
- License: mit
- Created: 2018-06-12T05:55:36.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-20T14:09:03.000Z (about 1 year ago)
- Last Synced: 2024-08-01T02:26:55.151Z (4 months ago)
- Topics: interaction, logging, website
- Language: TeX
- Homepage: https://ielab.io/bigbro
- Size: 2.01 MB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Big Brother
_bigbro_ is a website interaction logging service. Logging can currently be written directly to a file (i.e. CSV) or ingested to Elasticsearch.
## Client
To use _bigbro_ on a website, include the following Javascript snippet (this repository hosts `bigbro.js` in the [js folder](js/bigbro.js)):
```html
BigBro.init("username", "localhost:1984");
```
This will allow the page to capture most events that occur by interacting with the page.
The arguments to `BigBro.init` are as follows:
- `actor`: A unique identifier of the current user.
- `server`: The address _bigbro_ is running on (please omit protocol; this is determined automatically).
- (optional) `events`: A list of events that will be listened on globally (at the window level); e.g. "click", "mousemove".
Additional events can also be loaded in at initiation:
```html
BigBro.init("username", "localhost:1984", ["mousemove", "onload"]);
```
Custom logging events can also be added, for example:
```html
let bb = BigBro.init("username", "localhost:1984");
window.addEventListener("click", function (e) {
bb.log(e, "custom_event");
})
```
## Server
_bigbro_ is written in Go. To install locally, please use:
```bash
$ go install github.com/hscells/bigbro/cmd/bigbro
```
Alternatively, download a [prebuilt binary](https://github.com/hscells/bigbro/releases).
For help with the server, run:
```bash
$ bigbro --help
```
```
Usage: bigbro [--filename FILENAME] [--index INDEX] [--v V] [--url URL] FORMAT
Positional arguments:
FORMAT how events should be formatted and written
Options:
--filename FILENAME filename to output logs to
--index INDEX index for Elasticsearch to use
--v V version for Elasticsearch event type
--url URL URL for Elasticsearch
--help, -h display this help and exit
--version display version and exit
```
To output logs to a CSV file, use:
```bash
$ bigbro --filename my_application.log csv
```
To output logs to Elasticsearch, use:
```bash
$ bigbro --index bigbro --v 1 --url http://localhost:9200 elasticsearch
```
## Tools
To perform analysis, one may create heatmaps with the _bbheat_ tool. To install this tool, use:
```bash
$ go install github.com/hscells/bigbro/cmd/bbheat
```
For help with this tool, run:
```bash
$ bbheat --help
```
```bash
Usage: bbheat --log LOG --heatmap HEATMAP [--image IMAGE] [--start START] [--end END] [--interval INTERVAL] [--location LOCATION] [--actor ACTOR] [--method METHOD] [--width WIDTH] [--height HEIGHT]
Options:
--log LOG path to log file produced by bigbro
--heatmap HEATMAP path to output heatmap to
--image IMAGE path to image file for analysis
--start START time to start analysis
--end END time to end analysis
--interval INTERVAL create an animation every n seconds
--location LOCATION URL to limit analysis (regex)
--actor ACTOR actor to limit analysis
--method METHOD method to limit analysis
--width WIDTH width to limit analysis
--height HEIGHT height to limit analysis
--help, -h display this help and exit
--version display version and exit
```
_bbheat_ can create both static heatmaps and animations. The image format accepted for input is png. The output format
of static heatmaps is png. The output format of animations is gif. To make a gif use the `interval` argument to specify
how many seconds must pass the log for a new heatmap to be made. The start time, end time, actor, location, and method
can be specified to limit aspects of the log used in the heatmap. The location accepts a regular expression. To
overlay the heatmap over an image, use the `image` option. This image must be a png. To create a heatmap, the screen
width and height must be the same. If there are multiple screen sizes in the log, limit this with the `width` and
`height` arguments.