violet88 / bugsnag-silverstripe
用于在 SilverStripe 项目中使用 Bugsnag 的模块。
v1.4.3
2024-03-29 10:16 UTC
Requires
- php: ^7.4 || ^8.0
- bugsnag/bugsnag: ^3.0
- guzzlehttp/guzzle: ^5.0|^6.0|^7.0
- silverstripe/admin: ^1.0 || ^2.0
- silverstripe/framework: ^4.0 || ^5.0
- silverstripe/recipe-cms: ^4 || ^5
Requires (Dev)
- phpunit/phpunit: ^9.5.24
- squizlabs/php_codesniffer: ^3.0
This package is auto-updated.
Last update: 2024-09-29 11:28:07 UTC
README
要求
- SilverStripe ^4.0
- silverstripe/framework
- bugsnag/bugsnag
- guzzlehttp/guzzle
- silverstripe/admin
开发要求
安装
要安装,请运行以下命令
composer require violet88/bugsnag-silverstripe
注意:在使用模块之前,请确保已安装所需模块。
许可证
请参阅 许可证
文档
配置
对于基本使用,将以下内容添加到您的 .env 文件中
在本地运行时,为了防止 Bugsnag 被错误填满,将 BUGSNAG_ACTIVE 设置为 false 或不声明它。(如果不声明,消息也不会发送到 Bugsnag。
BUGSNAG_API_KEY=<YOUR BUGSNAG API KEY> BUGSNAG_STANDARD_SEVERITY=<STANDARD SEVERITY LEVEL FOR BUGSNAG (info OR warning OR error)> BUGSNAG_ACTIVE=<true OR false, depending on whether bugsnag should be ACTIVE> BUGSNAG_RELEASE_STAGE=<RELEASE STAGE FOR YOUR CURRENT REVISION>
要将 BugsnagLogger 用作标准错误记录器,将以下内容添加到您的配置 yaml 中
SilverStripe\Core\Injector\Injector: Psr\Log\LoggerInterface: calls: BugsnagHandler: [pushHandler, ['%$BugsnagHandler']] BugsnagHandler: class: Violet88\BugsnagModule\BugsnagLogger constructor: - '%$Violet88\BugsnagModule\Bugsnag' SilverStripe\SiteConfig\SiteConfig: extensions: - Violet88\BugsnagModule\BugsnagSiteConfigExtension
要使用 CLI 命令将您的当前发布修订版发送到 Bugsnag,将以下内容添加到您的 routes yaml 中
SilverStripe\Control\Director: rules: 'bugsnag//build': 'Violet88\BugsnagModule\BugsnagController' 'bugsnag//initial': 'Violet88\BugsnagModule\BugsnagController'
基本用法
要向 Bugsnag 发送基本错误,请使用以下代码
use Violet88\BugsnagModule\Bugsnag; use Exception; use SilverStripe\Core\Injector\Injector; try{ //do something } catch (Exception $e) { $bugsnag = Injector::inst()->get(Bugsnag::class); $bugsnag->sendException($e); }
维护者
- Sven van der Zwet s.vanderzwet@student.avans.nl
错误追踪
错误在此存储库的问题部分跟踪。在提交问题之前,请阅读现有问题以确保您的独特性。
如果问题看起来像是一个新的错误
- 创建一个新的问题
- 为 'Bugs' 选择问题模板
- 遵循模板中的说明
请直接向模块维护者报告安全问题。请勿在错误追踪器中提交安全问题。
开发和贡献
如果您想为此模块做出贡献,请确保您发起了一个拉取请求,并与模块维护者进行了讨论。
请随意加入 Slack 社区: 加入 Slack