Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/niksy/kist-beacon

[UNMAINTAINED] - Front-end logging interface.
https://github.com/niksy/kist-beacon

Last synced: about 2 months ago
JSON representation

[UNMAINTAINED] - Front-end logging interface.

Host: GitHub
URL: https://github.com/niksy/kist-beacon
Owner: niksy
License: mit
Created: 2014-01-12T21:02:59.000Z (almost 11 years ago)
Default Branch: master
Last Pushed: 2017-04-23T06:53:59.000Z (over 7 years ago)
Last Synced: 2024-10-30T07:58:33.666Z (about 2 months ago)
Language: JavaScript
Homepage:
Size: 35.2 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

![Unmaintained project](https://img.shields.io/badge/status-unmaintained-red.svg)

**This project is unmaintained.**

---

# kist-beacon

Front-end logging interface.

## Installation

```sh
npm install kist-beacon --save

bower install kist-beacon --save
```

## API

### `new Beacon(options)`

Returns: `Object`

#### Options

##### url

Type: `String`
Default: ` `
*Required*

Endpoint where your application will pass query parameters from AJAX call and do with them what you desire: save them to database, logfile on server, etc.

Data is sent via `POST` request so if your endpoint is CORS-like, beacon won’t work properly in browsers without [CORS support](http://caniuse.com/#search=cors).

##### js

Type: `Boolean`
Default: `true`

Log JS errors.

##### console

Type: `Boolean`
Default: `false`

Log `console` calls.

### `.send(data)`

Returns: `Object`

Sends information to provided URL. Information will be send as standard `GET` request. Parsing should be done by back-end application.

#### data

Type: `Object`
*Required*

### `.destroy()`

Destroys logger instance.

## Examples

Create new instance.

```js
var Beacon = require('kist-beacon');
var beacon = new Beacon({
url: '/log',
js: true,
console: false
});
```

Message examples.

```json
{
"logType":"JS Error",
"userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/35.0.1916.153 Safari/537.36",
"time":1403629312238,
"errorMessage":"Uncaught ReferenceError: barfoo is not defined",
"url":"http://example.com/",
"lineNumber":12
}

{
"logType":"Console call",
"userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/35.0.1916.153 Safari/537.36",
"time":1403629312238,
"methodType":"log",
"url":"http://example.com/",
"message":"console call"
}
```

Destroy instance.

```js
beacon.destroy();
```

### AMD and global

```js
define(['kist-beacon'], cb);

window.kist.Beacon;
```

## Browser support

Tested in IE8+ and all modern browsers.

## Acknowledgments

* https://github.com/Lapple/ErrorBoard
* http://tobyho.com/2012/07/27/taking-over-console-log/
* http://stackoverflow.com/questions/8087240/if-i-override-window-onerror-in-javascript-should-i-return-true-or-false

## License