README

为Yii PHP框架提供的Sentry。

yii-sentry是Yii的一个扩展，允许将数据发送到Sentry。它包含一个应用程序组件，允许集中访问Raven客户端，一个错误处理器，将错误和异常发送到Sentry，以及一个日志路由器，将日志消息发送到Sentry。从未如此简单，可以专业地管理您的错误。

特性

• 用于轻松访问Raven客户端的应用程序组件
• 将错误发送到Sentry的错误处理器
• 将消息发送到Sentry的日志路由器

资源

• Sentry
• Sentry文档
• Raven项目

安装

安装此扩展的最简单方法是使用Composer，将以下内容添加到您的composer.json文件中

  "require": {
    "crisu83/yii-sentry": "<replace-with-latest-version>"
  }

在您的项目根目录中运行以下命令以安装扩展

php composer.phar install

提示：创建一个名为vendor的路径别名到Composer的vendor目录，以便通过将它们添加到您的应用程序配置中的aliases来简化依赖关系的类映射。

如果您不想使用Composer，可以下载扩展及其依赖项，然后手动设置一切。

下载扩展后，请将以下内容添加到您的应用程序配置中

  'components' => array(
    'sentry' => array(
      'class' => 'vendor.crisu83.yii-sentry.components.SentryClient',
      'dns' => '<replace-with-your-sentry-dns>'
    ),
  ),

以下配置参数可用于SentryClient

• dns: (字符串) 连接到Sentry时使用的dns
• environment: (字符串) 活动环境的名称
• 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' => 'vendor.crisu83.yii-sentry.components.SentryErrorHandler',
    ),
  ),

以下配置参数可用于SentryErrorHandler

• sentryClientID: (字符串) sentry客户端的组件ID

就是这样，现在错误和异常将被发送到Sentry。

将日志消息发送到Sentry

要启用SentryLogRoute，请将以下内容添加到您的应用程序配置中

  'components' => array(
    'log' => array(
      'class' => 'CLogRouter',
      'routes' => array(
        array(
          'class' => 'vendor.crisu83.yii-sentry.components.SentryLogRoute',
          'levels' => 'error, warning',
        ),
      ),
    ),
  ),

以下配置参数可用于SentryLogRoute

• sentryClientID: (字符串) sentry客户端的组件ID

就是这样，现在级别为error和warning的日志消息将被发送到Sentry。

提示：不要将级别为trace的消息记录到Sentry，因为它会极大地减慢您的应用程序。