Download the PHP package lordsimal/cakephp-sentry without Composer
On this page you can find all versions of the php package lordsimal/cakephp-sentry. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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-sentry
CakePHP Sentry Plugin
CakePHP integration for Sentry.
ℹ️ This is a refactored version of https://github.com/Connehito/cake-sentry to remove deprecation warnings introduced in CakePHP 4.4
ℹ️ If you are using CakePHP 4.4+ please use the 1.x version of this plugin
ℹ️ If you are using CakePHP 3.x or 4.0 - 4.3 please use the plugin from Connehito linked above
Requirements
- PHP 8.1+
- CakePHP 5+
- and a Sentry account
- if you use self-hosted sentry make sure you are on at least version
>= v20.6.0
- if you use self-hosted sentry make sure you are on at least version
Version table
| PHP | CakePHP | self-hosted Sentry | |
|---|---|---|---|
| 1.x | ^7.4 \|\| ^8.0 |
^4.4 |
🤷🏻 |
| 2.x | ^8.1 |
^5.0 |
🤷🏻 |
| 3.x | ^8.1 |
^5.0 |
>= v20.6.0 |
Installation
Usage
Set config files
Loading plugin
In Application.php
Or use the cake CLI.
That's all! 🎉
⚠️️ If events (error/exception) are not captured in Sentry try changing the order in which the plugins are loaded.
Advanced Usage
Ignore specific exceptions
You can filter out noisy exceptions which should not be debugged further.
Also see CakePHP Cookbook
Set Options
Everything inside the 'Sentry' configuration key will be passed to \Sentry\init().
Please check Sentry's official documentation on about configuration and about php-sdk's configuraion.
CakeSentry also provides custom event hooks to set dynamic values.
| Event Name | Description |
|---|---|
CakeSentry.Client.afterSetup |
General config for e.g. a release info |
CakeSentry.Client.beforeCapture |
Before an error or exception is being sent to sentry |
CakeSentry.Client.afterCapture |
After an error or exception has been sent to sentry |
Example for CakeSentry.Client.afterSetup
And in config/bootstrap.php
Example for CakeSentry.Client.beforeCapture
And in config/bootstrap.php
Example for CakeSentry.Client.afterCapture
Query logging (optional)
If you want sentry events to also have query logging enabled you can do this via your config:
If you want queries related to schema reflection also inside your events then you can enable that via
Performance monitoring (optional)
If you want to use the performance monitoring feature of sentry you have to enable these 2 settings
as well as set the corresponding Sentry SDK options
to see SQL query execution and duration inside the performance monitoring section of sentry make sure to enable logging for your desired datasource like so:
Upgrade from 2 to 3
There are a few major changes from 2.0 to 3.0
- The Sentry PHP SDK was upgraded from
^3.3to ^4.0 CakeSentryMiddlewarehas been renamed toCakeSentryQueryMiddleware- Properties are not prefixed
_anymore - The
CakeSentryPerformanceMiddlewarehas been added to add support for the Performance Monitoring Feature
License
The plugin is available as open source under the terms of the MIT License.
