Symfony integration guide

Add Bugsnag error monitoring to your Symfony applications.

This library supports Symfony versions 2, 3 and 4, running PHP 5.5+.

This guide is for Symfony 4. You can find information on how to get started with Symfony versions 2 and 3 in the legacy Symfony section.

Installation

Add bugsnag/bugsnag-symfony to your composer.json:

$ composer require "bugsnag/bugsnag-symfony:^1.5"

The Bugsnag bundle will automatically be registered in your config/bundles.php file.

Basic configuration

To associate your application with a project in your Bugsnag dashboard, you’ll need to set your Integration API Key in your config/packages/bugsnag.yaml file:

bugsnag:
    api_key: YOUR-API-KEY-HERE

You can find this key immediately after creating a new project from your Bugsnag dashboard, or later on your project’s settings page.

For a list of available options, see the configuration options reference.

Accessing Bugsnag’s client

In order to manually use the Bugsnag client in any of your controllers you will need to acquire it from the service container.

In a controller extending a Symfony Controller:

$this->get('bugsnag')->notifyException(
    new Exception('Example exception!')
);

If a controller extending an AbstractController the service can be acquired via Symfony’s dependency injection component following information in that guide.

Reporting unhandled exceptions

After completing installation and basic configuration, unhandled exceptions in your Symfony app will be automatically reported to your Bugsnag dashboard.

Reporting handled exceptions

Reporting handled exceptions can be accomplished as follows:

try {
    // Some potentially crashy code
} catch (Exception $ex) {
    $this->get('bugsnag')->notifyException($ex);
}

When reporting handled exceptions, it’s often helpful to send us custom diagnostic data or to adjust the severity of particular errors. For more information, see reporting handled errors.

Sending diagnostic data

Automatically captured diagnostics

Bugsnag will automatically capture the following data for every exception:

  • A full stacktrace
  • Request information, including ip, headers, URL, HTTP method, and HTTP params
  • Session and cookie data
  • Release stage (production, beta, staging, etc)
  • Hostname

Custom diagnostics

In order to quickly reproduce and fix errors, it is often helpful to send additional application-specific diagnostic data to Bugsnag. This can be accomplished by registering a function to be executed before an error report is sent.

In Symfony 4 application-wide callbacks should be registered within the boot function of your src/Kernel.php file:

public function boot()
{
    parent::boot();
    $this->container->get('bugsnag')->registerCallback(function ($report) {
        ...
    });
}

Logging breadcrumbs

In order to understand what happened in your application before each error, it can be helpful to leave short log statements that we call breadcrumbs. The last 25 breadcrumbs are attached to an error report to help diagnose what events lead to the error. Captured breadcrumbs are shown on your Bugsnag dashboard as a part of the error report.

Leaving breadcrumbs can be accomplished by using leaveBreadcrumb as follows:

$this->get('bugsnag')->leaveBreadcrumb('Something happened!');

You can optionally attach a type and metadata to a breadcrumb for additional context into the state of the application when the breadcrumb was captured. See the Breadcrumb class for the available types.

$this->get('bugsnag')->leaveBreadcrumb(
    'Something happened!',
    \Bugsnag\Breadcrumbs\Breadcrumb::ERROR_TYPE
);

And with additional diagnostic metadata:

$this->get('bugsnag')->leaveBreadcrumb(
    'Something happened!',
    \Bugsnag\Breadcrumbs\Breadcrumb::MANUAL_TYPE,
    ['foo' => 'bar']
);

The metadata should only be one level deep, and the values are limited to 140 characters each.

Identifying users

In order to correlate errors with customer reports, or to see a list of users who experienced each error, it is helpful to capture and display user information on your Bugsnag dashboard.

If you are using Symfony’s built-in authentication, we will automatically capture information about the currently authenticated user.

To disable this behavior, set user to false during configuration.

To set customized user information, register a callback and update the report object:

$this->get('bugsnag')->registerCallback(function ($report) {
    $report->setUser([
        'id' => '123456',
        'name' => 'Leeroy Jenkins',
        'email' => 'leeeeroy@jenkins.com',
    ]);
});

Tracking releases

By sending your source revision or application version to us when you release a new version of your app, you’ll be able to see in which release each error was introduced.

Release tracking is built into the Bugsnag PHP library and can be used by calling $this->get('bugsnag')->build(); with the following parameters:

  • $repository - the source repository for the code which you are releasing.
  • $revision - the source control revision you are currently releasing.
  • $provider - the provider of the git repository. Required for on-premise providers, one of: github-enterprise, bitbucket-server, gitlab-onpremise
  • $builderName - the name of the person or machine who initated the release. Defaults to whoami.

Release stage, API key, and the application version are automatically detected from your existing configuration.

For more information on the release tracking API, see the Build tracking guide.

Alternatively take a look at our build-tool integrations

Next steps