gold/craft-bugsnag

Craft Cms 的非官方 Bugsnag 通知器。

1.3 2017-01-27 10:41 UTC

This package is not auto-updated.

Last update: 2024-09-24 04:09:57 UTC


README

这基本上是官方 Bugsnag Laravel 包 的分支。感谢大家的优秀工作,希望你们不会介意 :)

Bugsnag 通知器为优秀的 Craft CMS 提供即时错误和异常通知。安装后,插件将监听 Yii 事件 onErroronException,如品牌推荐的那样。

Bugsnag 实时捕获您的网页、移动和桌面应用程序中的错误,帮助您尽可能快地理解和解决问题。 创建免费账户 开始捕获应用程序中的错误。

安装

  • 下载此仓库
  • 将文件夹重命名为 bugsnag 并将其放入您的 Craft CMS 插件目录 (craft/plugins)
  • 在新创建的 craft/plugins/bugsnag 目录中运行 composer install
  • 导航到您的插件页面 /settings/plugins 并点击安装
  • 确保按照下一节中的说明配置插件

配置

  1. 创建一个包含您的 API 密钥的文件 craft/config/bugsnag.php

  2. 配置您的 api_key

    <?php # craft/config/bugsnag.php
    
    return array(
        'api_key' => 'YOUR-API-KEY-HERE'
    );
  3. 可选地,您可以将 notify_release_stages 键添加到上面的同一文件中,以定义哪些 Craft 环境 将向 Bugsnag 发送异常。

    return array(
        'api_key' => 'YOUR-API-KEY-HERE',
        'notify_release_stages' => ['production', 'staging']
    );

钩子

discardBugsnagExceptionEvent($event)

给插件一个机会,丢弃某些类型的异常,例如 404。

/**
 * Stop an exception event from being reported to bugsnag
 * 
 * @param CExeptionEvent $event
 * @return boolean
 */
function discardBugsnagExceptionEvent($event)
{
	$exception = $event->exception;

	if (/* $exception should be discarded */){
		return true;
	}
}

其他

您始终可以从 bugsnag 服务中获取 bugsnag 实例来发送自己的错误和异常或注册 beforeNotifyFunction。

craft()->bugsnag->instance()->notifyError("ErrorType", "Something bad happened here too");

有关更多信息,请参阅 bugsnag-php 库的 附加配置 文档。