Configuration options

All available options for configuring Bugsnag with PHP apps.

The Bugsnag client object has several properties which help you customize the content of error reports, and how the reports are delivered.

setAppVersion

If you tag your app releases with version numbers, Bugsnag can display these on your dashboard if you call setAppVersion:

$bugsnag->setAppVersion('1.2.3');

setAutoNotify

Controls whether bugsnag should automatically notify about any errors it detects in the PHP error handlers.

$bugsnag->setAutoNotify(false);

By default, this is set to true.

setBeforeNotifyFunction

Set a custom function to call before notifying Bugsnag of an error. You can use this to call your own error handling functions, to add custom tabs of data to each error on your Bugsnag dashboard, or to modify the stacktrace.

$bugsnag->setBeforeNotifyFunction(function ($error) {
    // Inspect or modify the error report here
});

See the customizing error reports reference for more details.

setContext

Bugsnag uses the concept of “contexts” to help display and group your errors. Contexts represent what was happening in your application at the time an error occurs. By default this will be set to the current request URL and HTTP method, eg “GET /pages/documentation”.

If you would like to set the bugsnag context manually, you can call setContext:

$bugsnag->setContext('Backport Job');

setEndpoint

Set the endpoint to which to send error reports. By default we’ll send reports to the standard https://notify.bugsnag.com endpoint, but you can override this if you are using Bugsnag Enterprise, to point to your own Bugsnag endpoint:

$bugsnag->setEndpoint("http://bugsnag.internal.example.com");

setErrorReportingLevel

Set the levels of PHP errors to report to Bugsnag, by default we’ll use the value of error_reporting from your php.ini or any value you set at runtime using the error_reporting(...) function.

If you’d like to send different levels of errors to Bugsnag, you can call setErrorReportingLevel:

$bugsnag->setErrorReportingLevel(E_ALL & ~E_NOTICE);

See PHP’s error reporting documentation for allowed values.

setFilters

Sets the strings to filter out from the metaData arrays before sending them to Bugsnag. Use this if you want to ensure you don’t send sensitive data such as passwords, and credit card numbers to our servers. Any keys which contain these strings will be filtered.

$bugsnag->setFilters(['password', 'credit_card']);

By default, this is set to be ["password"].

setMetaData

Sets additional metadata to send with every bugsnag notification

$bugsnag->setMetaData([
    'account' => [
        'paying' => true,
        'name' => 'Acme Co'
    ]
]);

setNotifyReleaseStages

By default, Bugsnag is notified of errors that happen in any releaseStage If you would like to change which release stages notify Bugsnag of errors you can call setNotifyReleaseStages:

$bugsnag->setNotifyReleaseStages(['development', 'production']);

setProjectRoot

Bugsnag marks stacktrace lines as in-project if they come from files inside your projectRoot.

You can set this manually by calling setProjectRoot:

$bugsnag->setProjectRoot('/path/to/your/app');

If your app has files in many different locations, you should consider using setProjectRootRegex instead.

setProjectRootRegex

If your app has files in many different locations, you can set the a regular expression for matching filenames in stacktrace lines that are part of your application:

$bugsnag->setProjectRootRegex('('.preg_quote('/app').'|'.preg_quote('/libs').')');

setProxySettings

Note: Proxy configuration is only possible if the PHP cURL extension is installed.

If your server is behind a proxy server, you can configure this as well:

$bugsnag->setProxySettings([
    'host' => 'bugsnag.com',
    'port' => 42,
    'user' => 'username',
    'password' => 'password123'
]);

Other than the host, none of these settings are mandatory.

setReleaseStage

If you would like to distinguish between errors that happen in different stages of the application release process (development, production, etc) you can set the releaseStage that is reported to Bugsnag.

$bugsnag->setReleaseStage('development');

By default this is set to “production”.

setSendCode

Bugsnag automatically sends a small snippet of the code that crashed to help you diagnose even faster from within your dashboard. If you don’t want to send this snippet, you can call setSendCode:

$bugsnag->setSendCode(false);

setSendEnvironment

Bugsnag can transmit your $_ENV environment to help diagnose issues. This can contain private/sensitive information, so we do not transmit this by default. To send your environment, you can call setSendEnvironment:

$bugsnag->setSendEnvironment(true);

setTimeout

Define a custom timeout in seconds for the connection when notifying Bugsnag.

$bugsnag->setTimeout(2);

By default, this is set to be 2.

setType

You can set the type of application executing the current code by using setType:

$bugsnag->setType('resque');

This is usually used to represent if you are running plain PHP code “php”, via a framework, eg “laravel”, or executing through delayed worker code, eg “resque”. By default this is null.

setUser

Bugsnag helps you understand how many of your users are affected by each error, and allows you to search for which errors affect a particular user using your Bugsnag dashboard. To send useful user-specific information you can call setUser:

$bugsnag->setUser([
    'id' => '123456',
    'name' => 'Leeroy Jenkins',
    'email' => 'leeeeroy@jenkins.com',
]);

The name, email and id fields are searchable, and everything you send in this array will be displayed on your Bugsnag dashboard.

The id field is used also used by Bugsnag to determine the number of impacted users. By default, we use the IP address of the request as the id.