pinfirestudios/craft3-bugsnag

允许错误发送到Bugsnag(www.bugsnag.com)

1.1.1 2020-03-03 02:17 UTC

This package is auto-updated.

Last update: 2024-08-29 04:20:06 UTC


README

允许错误发送到 Bugsnag

需求

此插件需要Craft CMS 3.0.0-beta.23或更高版本。

安装

要安装此插件,请按照以下说明操作。

  1. 打开您的终端并转到您的Craft项目

    cd /path/to/project

  2. 然后告诉Composer加载插件

    composer require pinfirestudios/craft3-bugsnag

  3. 在控制面板中,转到设置→插件,然后点击craft3-bugsnag的“安装”按钮。

  4. 如果您想能够捕获早期初始化错误,您需要将此插件添加到项目的 引导配置 中。为此,在config/app.php中添加

    'bootstrap' => [
        '\pinfirestudios\craft3bugsnag\Bootstrap'
    ]
    

这将提前在项目初始化时加载Bugsnag组件和日志部分,使您对错误的可见性最大化。如果您不启用此功能,Bugsnag将在设置插件时初始化,在加载过程的较晚阶段。

配置craft3-bugsnag

您需要通过设置页面或config/env文件提供您的API密钥和可选的发布阶段。然而,建议的方法是将src/config.php复制到/APP_ROOT/config/craft3-bugsnag.php,然后直接编辑它或将其添加到您的.env文件中的BUGSNAG_API_KEY。对于发布阶段,如果没有直接设置,它将默认为CRAFT_ENVIRONMENT变量。

使用craft3-bugsnag

如果发生崩溃并且已启用此功能,请访问您的Bugsnag仪表板以了解原因。

获取JavaScript错误

如果您想在您的网站上使用Bugsnag的JavaScript,您需要安装 bower-asset/bugsnag

  1. 将以下内容添加到项目的composer.json中

    "repositories": [
        {
            "type": "composer",
            "url": "https://asset-packagist.org"
        }
    ]
    
  2. 需要bower-asset/bugsnag

    composer require bower-asset/bugsnag

  3. 安装完成后,将BugsnagAsset添加到您的TWIG文件中(或如果是在插件内工作,则添加到控制器中)

在TWIG中

{% do view.registerAssetBundle("\\pinfirestudios\\yii2bugsnag\\BugsnagAsset") %}

在插件资产中

class AppAsset extends AssetBundle
{
    public $depends = [
        'pinfirestudios\yii2bugsnag\BugsnagAsset',
    ];
}

如果您需要使用Bugsnag的JavaScript版本2,您可以在配置中指定版本。请参阅 自定义资产包