PHP Airbrake 项目技术文档

1. 安装指南

使用 Composer 安装

推荐使用 Composer 来安装 PHP Airbrake 库。在项目的根目录下，编辑 composer.json 文件，添加以下内容：

{
  "require": {
    "dbtlr/php-airbrake": "~1.1"
  }
}

然后在命令行中执行以下命令：

curl -s http://getcomposer.org/installer | php
php composer.phar install

安装完成后，使用生成的 vendor/autoload.php 文件来自动加载库类。

2. 项目的使用说明

通过异常处理器使用

推荐通过错误和异常处理器来使用 PHP Airbrake，这样可以避免每次手动调用配置和客户端类。只需调用内置的错误处理器，并将 API 密钥传递给 start() 方法，如下所示：

<?php
require_once 'vendor/autoload.php';
Airbrake\EventHandler::start('[your api key]');

可选地，您可以将第二个参数设置为 TRUE，以启用警告级别消息的日志记录。默认情况下，此功能是禁用的，因为它可能会被认为过于冗长，具体取决于代码库的质量。还可以传递一个选项数组作为第三个参数，该数组将加载许多常见的配置选项。

直接调用使用

如果直接调用类而不是通过异常处理器，可以按如下方式进行：

<?php
require_once 'vendor/autoload.php';

$apiKey  = '[your api key]'; // 这是必需的
$options = array(); // 这是可选的

$config = new Airbrake\Configuration($apiKey, $options);
$client = new Airbrake\Client($config);

// 发送错误消息
$client->notifyOnError('My error message');

// 发送捕获的异常
try {
    throw new Exception('This is my exception');

} catch (Exception $exception) {
    $client->notifyOnException($exception);
}

选项数组可以包含配置选项部分的数据，如果您想覆盖一些默认选项，可以填充该数组。否则，可以忽略它。

3. 项目API使用文档

配置选项

• timeout：默认值为 2，表示服务在放弃之前等待的时间。应设置为一个合理的限制，以避免在失败时页面加载时间过长。
• environmentName：默认值为 'production'。可以更改为与您正在工作的环境匹配，以帮助防止日志中充满非生产环境的问题。
• serverData：默认值为 $_SERVER 数组，但可以用任何数据数组覆盖。
• getData：默认值为 $_GET 数组。
• postData：默认值为 $_POST 数组。
• sessionData：默认值为 $_SESSION 数组。
• component：运行的组件或控制器的名称。
• action：调用的操作的名称。
• projectRoot：默认值为文档根目录。可能需要根据应用程序的上下文进行更改。
• url：请求的主 URL。
• hostname：请求的主机名。
• secure：可选 - 布尔值，允许您定义是否要使用安全的 Airbrake 端点。
• errorReportingLevel：可选 - 与 error_reporting php.ini 设置功能相同（此设置应用于 EventHandler::start 方法上的 show warnings 参数之上）。
• proxyHost：可选的 HTTP 代理主机，所有连接将通过该主机发送。
• proxyPort：HTTP 代理端口（仅在提供 proxyHost 时需要）。默认值为 80。
• proxyUser：HTTP 代理用户名（即使提供了 proxyHost，也可以选择）。
• proxyPass：HTTP 代理密码（仅在提供 proxyUser 时需要）。

过滤器

您可以通过调用 addFilter 或 addFilters 方法向发送到 Airbrake 服务器的请求数据添加过滤器。默认情况下，过滤器通过表单的 name 属性定义。例如，如果您有一个表单如下：

<form method="post" action="/login">
  <label for="username">Username</label>
  <input id="username" name="user[email]" type="text" />

  <label for="password">Password</label>
  <input id="password" name="user[password]" type="password" />
</form>

您可以使用以下代码过滤掉所有用户详细信息：

<?php

$config = Airbrake\EventHandler::getClient()->getConfiguration();
$config->addFilter('user');

或者只过滤密码：

<?php

$config = Airbrake\EventHandler::getClient()->getConfiguration();
$config->addFilter('user[password]');

您还可以通过实现 Airbrake\Filter\FilterInterface 接口来定义自己的过滤器类。

4. 项目安装方式

通过 Composer 安装

如前所述，推荐使用 Composer 来安装 PHP Airbrake 库。编辑 composer.json 文件并执行安装命令即可完成安装。

手动安装

如果您不使用 Composer，也可以手动下载库文件并将其包含在项目中。不过，这种方式不推荐，因为手动管理依赖关系较为繁琐。

---

通过以上文档，您应该能够顺利安装和使用 PHP Airbrake 项目，并了解如何配置和使用其 API。