README

一个简单的包，用于捕获和记录您的应用中的所有错误，并将其报告给我们的 Bug 管理和事件报告工具，以进行深入分析。

截图

安装

在您的应用中运行 composer require sagarchauhan/bugfile，然后按照以下步骤操作。

入门（PHP 框架）

• 访问我们的 Bug 管理和事件报告工具 并创建一个账户。
• 添加您的站点
• 您将收到用于 LIVE、STAGING 和 DEV 环境的三个密钥以及一个端点
• 对于任何基于 PHP 的框架，如 LARAVEL、LUMEN、Zend 等，将密钥粘贴到您的应用的 .env 文件中。
• 最后，将以下代码粘贴到您的 Handler.php 文件中的 report 函数下

$bug = new BugFile();
$bug->causedBy(BugFile::DEFAULT_USER);
$bug->causedAt(BugFile::DEFAULT_SOURCE);
$bug->setSeverity(BugFile::LOG_INFO);
$bug->customData(BugFile::DEFAULT_DATA);
$bug->log($e);
$bug->setMessage(BugFile::DEFAULT_MESSAGE);
$bug->loggedBy(BugFile::DEFAULT_LOGGER);
$bug->save();

• 这将捕获所有异常并自动报告给我们的工具。
• 要手动报告异常，在 try-catch 方法中的任何 catch 块中使用上述相同的代码，如下所示

try{
    // some logical code
}catch (Exception $e){
    $bug = new BugFile();
    $bug->causedBy(\Illuminate\Support\Facades\Auth::id());
    $bug->causedAt("Login Page");
    $bug->setSeverity(BugFile::LOG_INFO);
    $bug->customData(['last_login'=>'today']);
    $bug->log($e);
    $bug->setMessage('Something happened at login function');
    $bug->loggedBy('Sagar Chauhan - PM');
    $bug->save();
}

入门（核心 PHP）

• 访问我们的 Bug 管理和事件报告工具 并创建一个账户。
• 添加您的站点
• 您将收到用于 LIVE、STAGING 和 DEV 环境的三个密钥以及一个端点
• 确保在调用日志记录器类时传递以下配置数组

  #Add these lines just above the switch cases of pimresponse.php
  require './ExceptionHandler.php';
  $exceptionHandler = new ExceptionHandler(require 'config.php');
  $exceptionHandler->handleException();

• 这将捕获所有异常并自动报告给我们的工具。
• 要手动报告异常，在 try-catch 方法中的任何 catch 块中使用上述相同的代码，如下所示

$config = [
      'APP_ENV'=>'local',
      'BUGFILE_END_POINT'=>'https://:8002/api/logs',
      'BUGFILE_KEY_DEV'=>'',
      'BUGFILE_KEY_STAGING'=>'',
      'BUGFILE_KEY_LIVE'=>''
  ];
  
try{
    // some logical code
}catch (Exception $e){
    $bug = new BugFile($config);
    $bug->causedBy(\Illuminate\Support\Facades\Auth::id());
    $bug->causedAt("Login Page");
    $bug->setSeverity(BugFile::LOG_INFO);
    $bug->customData(['last_login'=>'today']);
    $bug->log($e);
    $bug->setMessage('Something happened at login function');
    $bug->loggedBy('Sagar Chauhan - PM');
    $bug->save();
}

方法

您可以使用所有这些方法将日志发送到我们的工具

日志严重性

作者

Sagar Chauhan 在 Greenhonchos 担任项目经理 - 技术。在业余时间，他作为 Bug Bounty Hunter 寻找 bug。在 Instagram、Twitter、Facebook、Github 上关注他。

贡献者

• Harish Rawat

许可证

MIT