README

SlashTrace的核心是一个错误和异常处理器。您可以将它连接到您的错误处理程序（或让它自动设置以捕获所有错误和异常），然后它会捕获并显示有关错误的大量有用信息。它不仅适用于正常的浏览器请求，还适用于AJAX、CLI和JSON API。

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

用法

使用Composer安装
```
composer require servdebt/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渲染器。如果同时存在这两个头，JSON渲染器将优先于文本渲染器。请参阅示例输出。
对于所有其他请求，使用 Web渲染器。请参阅示例输出。

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

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

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

$slashtrace->addHandler($handler);

servdebt / slashtrace

维护者

详细信息