Bunyan stream for sending automated crash reports to FogBugz
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.coveralls.yml
.gitignore
.travis.yml
README.md
package.json

README.md

#Bunyan-Fogbugz bunyan-fogbugz bunyan-fogbugz bunyan-fogbugz Build fogbugz Coveralls code climate

Bunyan stream for sending automated crash reports to FogBugz

First install bunyan...

npm install bunyan

Then install bunyan-fogbugz

npm install bunyan-fogbugz

##Basic Setup

var bunyan  = require("bunyan"),
	BunyanFogbugz = require('bunyan-fogbugz'),
	log;

log = bunyan.createLogger({
	name: "myApp",
	streams: [{
		stream: new BunyanFogbugz({
			user: "user-name",
			project: "project-name",
			area: "area-name",
			domain: "your-fogbugz-domain-name",
			email: "email",
			forceNewBug: false
		}),
		type: 'raw',
		level: 'error'
	}]
});

log.error("hello bunyan fogbugz");

Notice: bunyan-fogbugz requires a raw stream type as above type: 'raw'

####Available Constructor Options:

  • domain (required)
  • user (required)
  • project (required)
  • area (required)
  • forceNewBug (defaults to false)
  • email

##Custom Formatters

By default the formatter returns an object containing a description property formatted with record.err + " " + record.msg and a extra property formatted with record.msg.

You can also specify a customFormatter function as below.

log = bunyan.createLogger({
	name: "myApp",
	streams: [{
		stream: new BunyanFogbugz({
			user: "user-name",
			project: "project-name",
			area: "area-name",
			domain: "your-fogbugz-domain-name",
			email: "email",
			forceNewBug: false,
			customFormatter: function(record, levelName){
				return {
					description: util.format("%s %s", record.msg, record.err ? record.err : ""),
					extra: JSON.stringify(record, bunyan.safeCycles(), 2)
				};
			}
		}),
		type: 'raw',
		level: 'error'
	}]
});
log.error({err: "error"}, "message");

####Available Custom Formatter Options

  • description (required)
  • extra
  • defaultMessage

For more info on the BugzScout API see bugzscout for automatic crash reportings

Authors


The MIT License
Copyright (c) 2015 QualityBath.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.