Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
3rd-Eden committed Apr 11, 2011
1 parent 0248d28 commit 34fc2e2
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
8 changes: 8 additions & 0 deletions Readme.md
Expand Up @@ -55,8 +55,16 @@ Options:

Or check the [examples](https://github.com/3rd-Eden/cluster.exception/tree/master/examples) folder for more examples.

## Templates

- `basic` This includes the **Stracktrace** and **Cluster instance** information.
- `history` This includes the **Stracktrace**, **Cluster instance**, **Log snapshot** and **graphs**.
- `default` This includes.. Everything you see in the screenshot below, you can never have to much information.

## Screenshots

![](http://dl.dropbox.com/u/1381492/shots/screeny-github-cluster-exception.png)

## Roadmap

The initial release will only contain support for email notifications. In the next iteration there will be support for multiple backends available. There are some use cases where you would want to store the details of the exception + the context in a database or somewhere else. So a configurable backend is something that would make a fine addition to the plugin.
Expand Down
25 changes: 25 additions & 0 deletions examples/template.js
@@ -0,0 +1,25 @@
var http = require('http')
, cluster = require('cluster')
, exception = require('../');

var app = http.createServer(function httpServer(req, res){
res.writeHead(200);
res.end("hello world");
if(req.url.match('favicon')){
console.info('Im a console.info');
console.warn('Im a console.warn');
console.log('Im a console.log');
console.error('Im a console.error');
console.info(req);

throw new Error("Omfg, uncaught error");
}
});

cluster = cluster(app)
.use(cluster.stats())
.use(cluster.pidfiles('pids'))
.use(cluster.cli())
.use(cluster.repl(8888))
.use(exception({to: 'info+cluster.exception@3rd-Eden.com', template:'history'}))
.listen(8080);

0 comments on commit 34fc2e2

Please sign in to comment.