https://github.com/statful/statful-browser-plugin
Statful Browser Plugin
https://github.com/statful/statful-browser-plugin
browser gather-metrics javascript metrics plugin statful
Last synced: 27 days ago
JSON representation
Statful Browser Plugin
- Host: GitHub
- URL: https://github.com/statful/statful-browser-plugin
- Owner: statful
- License: mit
- Created: 2018-10-22T10:43:24.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T00:59:20.000Z (over 3 years ago)
- Last Synced: 2026-05-14T09:37:45.030Z (30 days ago)
- Topics: browser, gather-metrics, javascript, metrics, plugin, statful
- Language: JavaScript
- Homepage: https://www.statful.com/
- Size: 877 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Statful Browser Plugin
Statful plugin to capture browser information and add it on your metrics.
[](https://travis-ci.org/statful/statful-browser-plugin)
[](https://david-dm.org/statful/statful-browser-plugin#info=devDependencies)
## Table of Contents
* [Installation](#installation)
* [Quick Start](#quick-start)
* [Tags](#tags)
* [Contribute](#contribute)
* [Authors](#authors)
* [License](#license)
## Installation
```
npm install --save statful-browser-plugin
```
## Quick Start
```javascript
// Init statful
statful.initialize({
dryrun: false,
debug: false,
app: 'exampleApp',
flushInterval: 5000
});
// Use Statful Browser Plugin
statful.use(new StatfulBrowserPlugin());
// Send a metric
statful.counter('page_load');
```
## Tags
These tags are only populated if available.
| Tag | Description |
|:---|:---|
| browser | browser name |
| browser_version | browser version |
| device_type | device type (desktop, tablet or mobile)|
| os | os name|
| os_version | os version|
## Contribute
Follow the standard *Fork and Pull Request* workflow and:
* Add tests for new feats
* Make sure the test suite passes
* Update or add documentation accordingly
### Installation
```bash
$ npm install
```
### Tests
```bash
$ npm test
```
## Authors
[Mindera - Software Craft](https://github.com/Mindera)
## License
Statful Javascript Client is available under the MIT license. See the [LICENSE](https://raw.githubusercontent.com/statful/statful-browser-plugin/master/LICENSE) file for more information.