pserwylo / bugsnag-agent

A forwarding agent for Bugsnag to guarantee minimal reporting impact.

The Bugsnag agent forwards reports from your server to bugsnag.com or an on-premise Bugsnag installation. It's used to avoid any latency impact that might occur if you need to make a call over the network in every exception handler.

Getting started

First you need to download the bugsnag-agent from here and make it executable on your server. For example:

curl -L http://git.io/q2AUSA | sudo tee /usr/bin/bugsnag-agent
sudo chmod +x /usr/bin/bugsnag-agent

Next you need to run it.

$ bugsnag-agent
Bugsnag Agent started. http://127.0.0.1:3829 -> https://notify.bugsnag.com/

You can verify that it's running using curl in another terminal:

$ curl http://127.0.0.1:3829
Bugsnag agent: 127.0.0.1:3829 -> https://notify.bugsnag.com/ (0/1000)%

Finally you need to configure the endpoint of your Bugsnag apps to be http://localhost:3829. This differs per notifier, but for example PHP is:

$bugsnag->setEndpoint("localhost:3829");
$bugsnag->setUseSSL(false);

Upstart

If you'd like to ensure Bugsnag is always running, you can save the following upstart script as /etc/init/bugsnag.conf and then run sudo start bugsnag.

#!upstart
description "Bugsnag forwarding agent"
author      "Bugsnag <[email protected]>"

start on (filesystem and net-device-up IFACE=lo)
stop on shutdown

respawn
respawn limit 99 5

console log

script
    exec bugsnag-agent
end script

Configuration

bugsnag-agent reads /etc/bugsnag.conf if it exists. The default configuration is:

# Default configuration for bugsnag.
[bugsnag]

# The port to listen on.
port = 3829

# The interfact to listen on. Set this to 0.0.0.0 if you want to allow anyone
# to forward to Bugsnag. If you do that, ensure that this process is firewalled
# off from the global internet.
listen = 127.0.0.1

# The endpoint to send exceptions to. This can be another `bugsnag-agent`,
# https://notify.bugsnag.com/ or your local on-premise Bugsnag.
endpoint = https://notify.bugsnag.com/

You can change which configuration file is used with the -c parameter:

bugsnag-agent -c /usr/local/etc/bugsnag.conf

All the options can also be set directly using command line flags:

bugsnag-agent --port 3829 --listen 127.0.0.1 --endpoint https://notify.bugsnag.com/

Meta

bugsnag-agent is copyright under the MIT license. See LICENSE.MIT for details.

Bug reports and pull requests are welcome.