https://github.com/chidiwilliams/trackerr

Simple exception tracking for Express/Koa servers
https://github.com/chidiwilliams/trackerr

connectjs error-monitoring error-reporting express javascript koa nodejs

Last synced: 4 days ago
JSON representation

Simple exception tracking for Express/Koa servers

• Host: GitHub
• URL: https://github.com/chidiwilliams/trackerr
• Owner: chidiwilliams
• Created: 2020-02-15T19:47:37.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-02-23T22:24:09.000Z (almost 5 years ago)
• Last Synced: 2024-10-31T20:26:28.335Z (about 2 months ago)
• Topics: connectjs, error-monitoring, error-reporting, express, javascript, koa, nodejs
• Language: HTML
• Homepage:
• Size: 20.5 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# trackerr

Simple exception tracking for small Express/Koa servers.

## Features

- Log uncaught exceptions to a data store of your choice

- View exceptions in the browser with a password-protected middleware in your app

- Get notified via email when an exception occurs (TODO)

## Installation

Install with NPM:

```shell

npm install --save trackerr

```

or Yarn:

```shell

yarn add trackerr

```

## Usage

Create a new client with a data store:

```js

import { Client } from 'trackerr';

import { SQLiteStore } from 'trackerr-sqlite';

const trackerr = new Client(new SQLiteStore('db.sql'));

```

trackerr will automatically begin to watch for uncaught exceptions in your app's process.

To use the middleware:

```js

server.use(trackerr.middleware());

```

The middleware will serve the trackerr page at `/__exceptions`.

## Data stores

The exception data may be stored in any data store of your choice. You may use one of the following maintained data stores or write your own plugin by implementing the `ExceptionDataStore` interface in [tracker-abstract-datastore](https://github.com/chidiwilliams/trackerr-abstract-exception-store).

- [SQLite](https://github.com/chidiwilliams/trackerr-sqlite)

## Comparison with other exception trackers

trackerr is free and open-source. It provides a simple middleware that mounts on your app, instead of relying on a third-party solution (like Airbrake or Sentry) or managing another server (like Errbit).

## Roadmap to V1

- Add password protection to trackerr page

- Email notifications

## Notes

- The idea for this project was originally shared [here](https://github.com/open-source-ideas/open-source-ideas/issues/15#issue-183618259).