Download the PHP package salines/cakephp-airbrake without Composer
On this page you can find all versions of the php package salines/cakephp-airbrake. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download salines/cakephp-airbrake
More information about salines/cakephp-airbrake
Files in salines/cakephp-airbrake
Package cakephp-airbrake
Short Description CakePHP 5.x plugin for Airbrake error tracking and exception monitoring
License MIT
Homepage https://github.com/salines/cakephp-airbrake
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package cakephp-airbrake
CakePHP Airbrake Plugin
A native CakePHP 5.x plugin for Airbrake error tracking and exception monitoring. Automatically captures and reports exceptions, PHP errors, and log messages to Airbrake using API v3. This plugin does not depend on the legacy phpairbrake SDK.
No external dependencies - uses CakePHP's built-in HTTP client.
Features
- Native implementation using Airbrake API v3
- No phpairbrake SDK dependency
- Automatic exception and error tracking
- Seamless integration with CakePHP's error handling system
- Log engine for sending log messages to Airbrake
- Request context (URL, HTTP method, route, user agent, etc.)
- CakePHP route information (controller, action, prefix)
- User identification support (CakePHP Authentication plugin)
- Sensitive data filtering (passwords, tokens, etc.)
- Support for self-hosted Airbrake (Errbit)
- Environment-based configuration
- Zero external dependencies
Requirements
- PHP 8.1 or higher
- CakePHP 5.x
- Airbrake account (or self-hosted Errbit)
Installation
Install the plugin using Composer:
Migration from phpairbrake
If your application previously used the phpairbrake SDK, you can remove it from composer.json and keep the same Airbrake credentials. This plugin provides its own notifier (CakeAirbrake\Notifier) and sends notices directly using CakePHP's HTTP client.
Configuration
1. Load the Plugin
Add the plugin to your src/Application.php:
2. Configure Airbrake
Add the Airbrake configuration to your config/app.php:
3. Configure Error Logger
To automatically send all exceptions and errors to Airbrake, configure the error logger in config/app.php:
4. Configure Log Engine (Optional)
To send log messages to Airbrake, add the log engine configuration:
The log engine automatically uses the global Airbrake configuration.
Environment Variables
You can configure the plugin using environment variables:
Usage
Automatic Error Tracking
Once configured with the error logger, all uncaught exceptions and PHP errors will automatically be sent to Airbrake.
Manual Exception Reporting
You can manually send exceptions to Airbrake:
Using the Log Engine
Send log messages to Airbrake:
Adding Custom Context
You can add custom context to your error reports using filters:
Filtering Notices
You can prevent certain notices from being sent by returning null from a filter:
Setting Severity
You can set the severity level for notices:
Testing With webhook.site
You can test delivery without a real Airbrake project by sending notices to a webhook.site URL.
- Create a new endpoint at https://webhook.site and copy the unique URL.
-
Configure a custom notices URL:
- Trigger a test notice:
Open the webhook.site page to inspect the JSON payload.
Configuration Options
| Option | Type | Default | Description |
|---|---|---|---|
projectId |
int | null | Your Airbrake project ID (required) |
projectKey |
string | null | Your Airbrake project key (required) |
environment |
string | 'production' | Environment name |
appVersion |
string | null | Application version |
host |
string | 'https://api.airbrake.io' | Airbrake API host |
enabled |
bool | true | Enable/disable Airbrake reporting |
keysBlocklist |
array | [...] | Regex patterns for sensitive keys to filter |
rootDirectory |
string | ROOT | Root directory for backtrace filtering |
httpClientOptions |
array | ['timeout' => 10] | Options for CakePHP HTTP Client |
Self-Hosted Airbrake (Errbit)
To use with a self-hosted Airbrake server like Errbit:
Filtering Sensitive Data
The plugin automatically filters sensitive data based on the keysBlocklist configuration. By default, it filters keys matching:
/password/i/secret/i/token/i/authorization/i/api_key/i/apikey/i/access_token/i
You can add your own patterns:
Disabling in Development
You can disable Airbrake in development:
Or using environment variables:
Notice Structure
The plugin sends notices to Airbrake in the following structure (API v3):
Testing
Run the tests:
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
License
This project is licensed under the MIT License - see the LICENSE file for details.
