jeffersonsimaogoncalves / cakephp-bugsnag
CakePHP的Bugsnag日志引擎。
2.0.2
2018-07-10 23:21 UTC
Requires
- php: >=7.0
- bugsnag/bugsnag: ^3.0
- cakephp/cakephp: ^3.6
README
提供自定义日志引擎用于Bugsnag。
需求
- CakePHP 3.x
- PHP 5.4.16或更高版本
安装
[使用Composer]
composer require steefaan/cakephp-bugsnag:dev-master
启用插件
在应用配置文件config/bootstrap.php
中加载插件
Plugin::load('Bugsnag');
配置
在应用配置文件config/app.php
中配置Bugsnag的API密钥
'Bugsnag' => [
'apiKey' => 'YOUR_API_KEY'
]
使用方法
对于Bugsnag和 CakePHP的自定义日志引擎,API使用简单,这使得将插件集成到新项目甚至现有项目中变得出奇容易。如CakePHP文档中所述,您可以按以下方式配置日志引擎
'Log' => [
'bugsnag' => [
'className' => 'Bugsnag\Log\Engine\BugsnagLog',
'releaseStage' => 'development',
'filters' => [
'password'
]
... more options
]
],
有关所有可用选项的完整列表,请参阅Bugsnag文档。此插件没有了解任何限制,您可以使用Bugsnag文档中列出的所有配置设置。请注意,您需要为每个Bugsnag选项移除前缀set
。例如,setFilters
变为filters
,setReleaseStage
变为releaseStage
,依此类推。
如果您想在将通知发送到他们的API之前修改Bugsnag通知,您可以使用事件监听器轻松完成此操作。您只需要监听以下事件
Log.Bugsnag.beforeNotify
有关如何监听事件的详细信息,请参阅Cake文档。此插件提供了一个可用于提供最佳Bugsnag体验的现成监听器。我建议即使您编写自己的代码,也加载此监听器。您可以在应用的config/bootstrap.php
中按以下方式配置内置监听器
use Bugsnag\Listener\BugsnagListener;
EventManager::instance()->on(new BugsnagListener());