README

Sentry for the Yii PHP 框架。

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

提示：创建一个指向 Composer 的 vendor 目录的路径别名，名为 vendor，通过将其添加到应用程序配置中的 aliases 以简化类到依赖项的映射。

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

下载扩展后，将其添加到您的应用程序配置中

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

以下配置参数可用于 SentryClient

• dns: (string) 连接到 Sentry 时使用的 DNS
• environment: (string) 活动环境名称
• enabledEnvironments: (array) 将数据发送到 Sentry 的环境名称列表
• options: (array) 以以下结构传递给 Raven 客户端的可选参数
  • logger: (string) 日志记录器名称
  • auto_log_stacks: (bool) 是否自动记录堆栈跟踪
  • name: (string) 服务器名称
  • site: (string) 安装名称
  • tags: (array) 描述事件的键/值对
  • trace: (bool) 是否发送堆栈跟踪
  • timeout: (int) 连接到 Sentry 的超时时间（以秒为单位）
  • exclude: (array) 要排除的异常类名
  • shift_vars: (bool) 在创建回溯时是否移位变量
  • processors: (array) 数据处理器列表

将错误发送到 Sentry

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

  'components' => array(
    'errorHandler' => array(
      'class' => 'vendor.crisu83.yii-sentry.components.SentryErrorHandler',
    ),
  ),

以下配置参数可用于 SentryErrorHandler

• sentryClientID: (string) 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: (string) sentry 客户端组件 ID

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

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