README

SlashTrace在核心上是一个错误和异常处理器。您可以将它钩入错误处理流程（或让它自己设置以捕获所有错误和异常），它将捕获并显示有关错误的大量有用信息。它对普通浏览器请求做这件事，也对AJAX、CLI和JSON APIs做这件事。

当您完成本地调试后，您可以配置SlashTrace将错误发送到专门的错误报告服务，如Sentry、Raygun和Bugsnag。

使用方法

使用Composer安装
```
composer require slashtrace/slashtrace
```

捕获错误

use SlashTrace\SlashTrace;
use SlashTrace\EventHandler\DebugHandler;

$slashtrace = new SlashTrace();
$slashtrace->addHandler(new DebugHandler());

// Register the error and exception handlers
$slashtrace->register();

或者，您可以显式处理异常

try {
    // Your code
} catch (Exception $exception) {
    $slashtrace->handleException($exception);
}

处理器

SlashTrace附带用于上述示例的DebugHandler，但在生产环境中运行时，您通常会想要将其设置为将错误发送到错误跟踪服务。目前，已经实现了以下提供者的处理器，并且还有更多在路上。点击每个链接查看使用文档

捕获额外数据

除了SlashTrace自带捕获的复杂错误信息外，您还可以将其他类型的数据附加到每个报告中。这在使用上述外部处理器时非常有用。

这样，SlashTrace充当您和这些提供者之间的抽象层，并将您提供的数据规范化为单一格式。这有助于您避免供应商锁定，并让您可以通过切换处理器简单地切换错误报告提供者。

捕获用户数据

如果您想附加有关受影响用户的信息，可以这样做

use SlashTrace\Context\User;

$user = new User();
$user->setId(12345); 
$user->setEmail('pfry@planetexpress.com');
$user->setName('Philip J. Fry');

$slashtrace->addUser($user);

请注意，用户至少需要一个ID或电子邮件。姓名完全是可选的。

此功能对应于每个错误跟踪器中的相应实现

记录面包屑

有时堆栈跟踪不足以弄清楚导致错误的步骤。为此，SlashTrace允许您在执行过程中记录面包屑

$slashtrace->recordBreadcrumb("Router loaded");
$slashtrace->recordBreadcrumb("Matched route", [
    "controller" => "orders",
    "action" => "confirm",
]);

跟踪版本

通常，知道哪个版本引入了特定的错误或哪个版本触发了回归很有用。用特定的版本或版本号标记事件非常简单

$slashtrace->setRelease("1.0.0"); // <- Your version number, commit hash, etc.

跟踪器文档

Sentry - 版本
Raygun - 版本号
Bugsnag - 每个事件的发布版本不能显式设置。有关更多详细信息，请参阅Bugsnag文档。

调试渲染器

当您使用捆绑的调试处理器时，它将尝试根据其运行的运行环境选择合适的输出渲染器，如下所示

当php_sapi_name() === "cli"时，使用CLI渲染器。示例输出。
用于 AJAX 请求（带有 X-Requested-With: XMLHttpRequest 头部的请求）的纯文本渲染器。请参阅示例输出。
用于带有 Accept: application/json 头部的请求的 JSON 渲染器。如果同时存在这两个头，则优先于文本渲染器。请参阅示例输出。
用于所有其他请求的 Web 渲染器。请参阅示例输出。

或者，您可以强制调试处理器使用特定的渲染器

use SlashTrace\EventHandler\DebugHandler;
use SlashTrace\DebugRenderer\DebugJsonRenderer;

$handler = new DebugHandler();
$handler->setRenderer(new DebugJsonRenderer());

$slashtrace->addHandler($handler);

jerfeson/slashtrace

维护者

详细信息