lesha888 / yii2-sentry
Yii2 PHP框架的Sentry。
1.3.2
2017-11-09 22:19 UTC
Requires
- sentry/sentry: ^1.8.1
- yiisoft/yii2: *
README
Yii PHP框架2的Sentry。
ecom/sentry是Yii2的一个扩展,允许将数据发送到Sentry。它包含一个应用组件,允许集中访问Raven客户端,一个错误处理器将错误和异常发送到Sentry,以及一个日志路由将日志消息发送到Sentry。现在专业管理错误从未如此简单。
功能
- 用于轻松访问Raven客户端的应用组件
- 将错误发送到Sentry的错误处理器
- 将消息发送到Sentry的日志路由
资源
设置
安装此扩展最简单的方法是使用Composer,将以下内容添加到您的composer.json文件中
"require": { "lesha888/yii2-sentry": "^1.3" }
在您项目的根目录中运行以下命令以安装扩展
php composer.phar install
提示:创建一个指向Composer的vendor目录的路径别名,名为vendor,通过将其添加到应用程序配置中的
aliases
中,以便简化依赖项的类映射。
如果您不想使用Composer,可以下载扩展及其依赖项,并手动设置一切。
下载扩展后,将以下内容添加到您的应用程序配置中
'components' => array( 'sentry' => array( 'class' => lesha888\sentry\Component::class, 'enabled' => true, 'dsn' => '<replace-with-your-sentry-dsn>' ), ),
以下配置参数可用于SentryClient
- dsn:(字符串) 连接到Sentry时使用的dsn
- environment:(字符串) 活动环境名称
- enable:(布尔值) 跳过收集错误
- enabledEnvironments:(数组) 要将数据发送到Sentry的环境名称列表
- options:(数组) 传递给Raven客户端的选项,其结构如下
- logger:(字符串) 日志记录器名称
- auto_log_stacks:(布尔值) 是否自动记录堆栈跟踪
- name:(字符串) 服务器名称
- site:(字符串) 安装名称
- tags:(数组) 描述事件的键/值对
- trace:(布尔值) 是否发送堆栈跟踪
- timeout:(整数) 连接到Sentry的超时时间(秒)
- exclude:(数组) 要排除的异常类名
- shift_vars:(布尔值) 创建回溯时是否移动变量
- processors:(数组) 数据处理器列表
将错误发送到Sentry
要启用SentryErrorHandler,请将以下内容添加到您的应用程序配置中
'components' => array( 'errorHandler' => array( 'class' => lesha888\sentry\ErrorHandler::class, ), ),
以下配置参数可用于SentryErrorHandler
- sentryClientID:(字符串) sentry客户端组件ID
就这样,现在错误和异常将发送到Sentry。
将日志消息发送到Sentry
要启用SentryLogRoute,请将以下内容添加到您的应用程序配置中
'components' => array( 'log' => array( 'class' => 'CLogRouter', 'routes' => array( array( 'class' => lesha888\sentry\LogRoute::class, 'levels' => 'error, warning', ), ), ), ),
以下配置参数可用于SentryLogRoute
- sentryClientID:(字符串) sentry客户端组件ID
就这样,现在具有级别error和warning的日志消息将发送到Sentry。
提示:不要将具有级别trace的消息记录到Sentry,因为它会大大减慢您的应用程序。