README

错误API模块

对于稳固且安全的网站，了解发生的所有错误和异常非常重要。这有助于防止未注意到的重复错误，并让客户满意，因为他们不必投诉。

使用错误API模块，您可以将所有异常发送到您个人的错误API，并通过电子邮件或Slack接收通知。如果客户网站上发生异常，您将收到完整的错误堆栈和Slack通知（如果已配置）。

安装服务器

安装模块需要Composer

composer require luyadev/luya-module-errorapi

配置

通过Composer安装后，在配置文件的模块部分包含模块。

'modules' => [
    // ...
    'errorapi' => [
        'class' => 'luya\errorapi\Module',
        'adapters' => [
            [
                'class' => 'luya\errorapi\adapters\MailAdapter',
                'recipient' => ['errors@example.com'],
            ],
            [
                'class' => 'luya\errorapi\adapters\SlackAdapter',
                'token' => 'xyz.xyz.xyz.xyz',
            ],
            [
                'class' => 'luya\errorapi\adapters\SentryAdapter',
                'token' => 'YOUR_SENTRY_USER_AUTH_TOKEN',
                'organisation' => 'organisationslug',
                'team' => 'teamslug',
            ]
        ],
    ],
]

初始化

安装和配置成功后，运行迁移、导入和设置命令以初始化项目中的模块。

1.) 迁移您的数据库。

./vendor/bin/luya migrate

2.) 将模块和迁移导入到您的LUYA项目中。

./vendor/bin/luya import

运行 ./vendor/bin/luya migrate 和 ./vendor/bin/luya import 命令非常重要，以便这些更改生效。

设置客户端

为了启用您网站的错误API，您需要在配置文件的组件部分配置默认的LUYA错误处理器，并使用当前设置的服务器（错误API）。

'components' => [
    // ...
    'errorHandler' => [
        'api' => 'https://example.com/errorapi', // where example is the domain you have setup error api above
        'transferException' => true,
    ],
]