blankogmbh / kirby-sentry
3.1.0
2024-01-10 08:52 UTC
Requires
- getkirby/cms: ^3.6.1|^4.0.0
- getkirby/composer-installer: ^1.1
- sentry/sdk: ^3.1
This package is auto-updated.
Last update: 2024-01-10 08:53:30 UTC
README
这是一个为 Kirby (> 3.6.1) 开发的插件,可以将错误和异常记录到 Sentry 和其他兼容 Sentry 的错误追踪器(例如 GitLab)。
⚠️ 请注意: 由于 3.6.1 之前的 Kirby 版本不支持,因为从 Kirby 3.6.1 开始才提供 system.exception
钩子。
安装
使用 Composer
composer require thathoff/kirby-sentry
手动安装
- 下载此插件
- 解压缩存档
- 将文件夹移动到
site/plugins
目录 - 在此文件夹内运行
composer install
以安装插件所需的 Sentry SDK
配置
此插件提供了以下配置选项。将其添加到您的 site/config/config.php
DSN
此选项是必需的。如果未设置,则插件将禁用。要获取 DSN,请创建一个新的 PHP 类型的 Sentry 项目。
默认: null
'thathoff.sentry.dsn' => "https://df2c6f7afc1a58783e15f2ae0118ff039d8a4755@0123456.ingest.sentry.io/123456",
环境
您可以配置一个发送到 Sentry 的环境。例如,可以是 staging
或任何有助于您识别错误发生环境的字符串。
提示:使用 Kirby 多环境设置 来更改此选项。
默认: 'production'
'thathoff.sentry.environment' => 'production',
添加用户上下文
当 Kirby 用户登录时,插件会将用户的电子邮件地址和用户名发送到 Sentry 以追踪错误和异常到用户。
要禁用,将此选项设置为 false
。
默认: true
'thathoff.sentry.addUserContext' => true,