README

这是一个实现 Rollbar 通知器的 ZF2 模块。捕获并报告异常到 Rollbar.com 以进行警报、报告和分析。

要求

• Zend Framework 2（最新 master 版本）
• rollbar/rollbar-php

安装

通过克隆项目

1. 通过将其克隆到 ./vendor/ 中来安装 rollbar-php。
2. 将此项目克隆到您的 ./vendor/ 目录。

使用 composer

1. 在您的 composer.json 中添加此项目

   "require": {
       "yassa/rollbar": "dev-master"
   }

2. 运行以下命令来安装此包

   $ php composer.phar update

安装后

1. 在 application.config.php 文件中启用它。

   <?php
   return array(
       'modules' => array(
           'Yassa\Rollbar', // must be added as the first module
           // ...
       ),
       // ...
   );

2. 将 config/module.yassa.rollbar.global.php.dist 复制到 project/directory/config/autoload/ 并删除 .dist 扩展名。

选项

以下选项可用

• enabled - 开关模块
• access_token - 您的项目访问令牌
• base_api_url - 要发送的基本 API URL。 (默认: https://api.rollbar.com/api/1/)
• batch_size - 如果达到此大小则提前刷新批处理（以防止内存问题）。 (默认: 50)
• batched - true 将单个请求的报告一起批处理。 (默认: true)
• branch - 检出的分支名称。
• capture_error_stacktraces - 记录 PHP 错误的完整堆栈跟踪。 (默认: true)
• environment - 环境名称。任何长度最多为 255 个字符的字符串都是可以的。为了获得最佳效果，请使用“生产”作为您的生产环境。 (默认: production)
• error_sample_rates - 关联数组，将 PHP 错误号映射到样本比率。样本比率是 1 的比率，例如，0 是“从不报告”，1 是“始终报告”，0.1 是“10% 的时间报告”。采样是在每个错误的基础上进行的。 (默认: array()，表示报告所有错误。)
• errorhandler - 将 Rollbar 注册为错误处理器以记录 PHP 错误
• exceptionhandler - 将 Rollbar 注册为异常处理器以记录 PHP 异常
• host - 服务器主机名。 (默认: null，将推迟到 gethostname() 调用 (或 php_uname('n') 如果该函数不存在))
• logger - 具有日志($level, $message) 方法的对象。将被 RollbarNotifier 用于记录消息。
• max_errno - 要报告的最大 PHP 错误号。例如，1024 将忽略所有 E_USER_NOTICE 或更高级别的错误。 (默认: -1 (报告所有错误))
• person - 描述当前登录用户的关联数组。必需：id，可选：username，email。所有值都是字符串。
• person_fn - 函数引用（字符串等）- 任何 call_user_func 可以处理的内容
• root - 应用程序根目录的绝对路径，不包括最后的 /。
• scrub_fields - 需要从 POST 中清除的字段名数组。值将被星号替换。如果需要覆盖，请确保列出所有要清除的字段，而不仅仅是添加到默认设置中的字段。在比较清除列表之前，参数名称将转换为小写。(默认: array('passwd', 'password', 'secret', 'confirm_password', 'password_confirmation'))
• shift_function - 是否将堆栈跟踪中的函数名下移一个框架，以便函数名正确反映每个框架的上下文。(默认: true)
• shutdownfunction - 注册 Rollbar 为关闭函数
• timeout - 将请求发送到 Rollbar 的超时时间，以秒为单位。(默认: 3)