Download the PHP package airbrake/phpbrake without Composer
On this page you can find all versions of the php package airbrake/phpbrake. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package phpbrake
PHPBrake
Features
PHPBrake is the official Airbrake PHP error notifier. PHPBrake supports PHP 8.2 and higher. PHPBrake includes many useful features that give you control over when and what you send to Airbrake, you can:
- Send notices from try-catch blocks in your code
- Add custom data to a notice
- Filter sensitive data from the notice
- Ignore specific exceptions
- Configure an error handler to capture uncaught exceptions
- Integrate with monolog
- Integrate with Laravel
- Integrate with CakePHP 3.x
- Integrate with Symfony
- Integrate with Zend
- and more
Installation
Quickstart
API
Notifier API consists of 4 methods:
buildNotice
- builds Airbrake notice.sendNotice
- sends notice to Airbrake.notify
- shortcut forbuildNotice
andsendNotice
.addFilter
- adds filter that can modify and/or filter notices.
Adding custom data to the notice
Filtering sensitive data from the notice
Ignoring specific exceptions
Add user data to the notice
Setting severity
Severity allows
categorizing how severe an error is. By default, it's set to error
. To
redefine severity, simply overwrite context/severity
of a notice object. For
example:
Error handler
Notifier can handle PHP errors, uncaught exceptions and shutdown. You can register appropriate handlers using following code:
Under the hood $handler->register
does following:
Laravel integration
See https://github.com/TheoKouzelis/laravel-airbrake
Symfony integration
See https://github.com/aminin/airbrake-bundle
CakePHP 3.x integration
See https://gist.github.com/mauriciovillalobos/01a97f9ee6179ad70b17d54f37cc5010
Zend Framework integration
See https://github.com/FrankHouweling/zend-airbrake
Monolog integration
Extra configuration options
appVersion
The version of your application that you can pass to differentiate exceptions between multiple versions. It's not set by default.
host
By default, it is set to api.airbrake.io
. A host
is a web address containing a
scheme ("http" or "https"), a host and a port. You can omit the port (80 will be
assumed) and the scheme ("https" will be assumed).
remoteConfig
Configures the remote configuration feature. Every 10 minutes the notifier will make a GET request to Airbrake servers to fetching a JSON document containing configuration settings for your project. The notifier will apply these new settings at runtime. By default, it is enabled.
To disable this feature, configure your notifier with:
Note: it is not recommended to disable this feature. It might negatively impact how your notifier works. Please use this option with caution.
rootDirectory
Configures the root directory of your project. Expects a String or a Pathname, which represents the path to your project. Providing this option helps us to filter out repetitive data from backtrace frames and link to GitHub files from our dashboard.
environment
Configures the environment the application is running in. Helps the Airbrake dashboard to distinguish between exceptions occurring in different environments. By default, it's not set.
httpClient
Configures the underlying http client that must implement GuzzleHttp\ClientInterface
.
Filtering keys
With keysBlocklist
option you can specify list of keys containing sensitive information that must be filtered out, e.g.:
Running tests
Run via docker:
Or run locally
PHPDoc
Contact
In case you have a problem, question or a bug report, feel free to:
- file an issue
- send us an email
License
PHPBrake is licensed under The MIT License (MIT).