codex-team/hawk.php

Hawk.so 的 PHP 错误捕获模块

维护者

详细信息

github.com/codex-team/hawk.php

源代码

问题

安装量: 15,171

依赖关系: 1

建议者: 0

安全性: 0

星标: 19

关注者: 8

分支: 3

开放问题: 7

2.2.2 2024-09-17 11:06 UTC

Requires

Requires (Dev)

MIT 654dc0a5b4eca40b2d2fd7a9a1df60953cdff15d

phperrorhawkcatcher

This package is auto-updated.

Last update: 2024-09-18 12:14:38 UTC

README

Hawk.so 的 PHP 错误捕获工具。

配置

  1. 注册 账户，创建项目并获取集成令牌。

  2. 通过 composer 安装 SDK 以安装捕获器

捕获器支持 PHP 7.2 或更高版本

$ composer require codex-team/hawk.php

配置

\Hawk\Catcher::init([
    'integrationToken' => 'your integration token'
]);

初始化后，您可以为将发送到 Hawk 的任何事件设置 user 或 context

\Hawk\Catcher::get()
    ->setUser([
        'name' => 'user name',
        'photo' => 'user photo',
    ])
    ->setContext([
        ...
    ]);

手动发送事件和异常

使用 sendException 方法发送任何捕获的异常

try {
    throw new Exception("Error Processing Request", 1);
} catch (Exception $e) {
    \Hawk\Catcher::get()->sendException($e);
}

使用 sendEvent 方法发送任何数据（日志、通知或其他内容）

\Hawk\Catcher::get()->sendMessage('your message', [
    ... // Context
]);

过滤敏感信息

使用 beforeSend 钩子过滤您不想发送到 Hawk 的任何数据。使用设置器清除任何属性。

\Hawk\Catcher::init([
    // ...
    'beforeSend' => function (\Hawk\EventPayload $eventPayload) {
        $user = $eventPayload->getUser();
        
        if (!empty($user['email'])){
            unset($user['email']);
        
            $eventPayload->setUser($user);
        }

        return $eventPayload;
    }
]);

问题和改进

随时提问或改进项目。

链接

仓库: https://github.com/codex-team/hawk.php

报告错误: https://github.com/codex-team/hawk.php/issues

Composer 包: https://packagist.org.cn/packages/codex-team/hawk.php

CodeX Team: https://codex.so

许可证

MIT