codex-team/hawk.symfony

Symfony errors Catcher module for Hawk.so

0.0.9 2024-11-28 11:45 UTC

Requires

• php: ^7.2 || ^8.0
• codex-team/hawk.php: ^2.2.5
• guzzlehttp/guzzle: ^6.0 || ^7.0
• guzzlehttp/psr7: ^2.1.1
• jean85/pretty-package-versions: ^1.5 || ^2.0
• monolog/monolog: ^2.2 || ^3.0
• php-http/discovery: ^1.15
• symfony/config: ^4.4.20||^5.0.11||^6.0||^7.0
• symfony/dependency-injection: ^4.4.20||^5.0.11||^6.0||^7.0
• symfony/http-kernel: ^4.4.20||^5.0.11||^6.0||^7.0
• symfony/psr-http-message-bridge: ^1.2||^2.0||^6.4||^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.19||^3.40

MIT

• symfony
• php
• monolog
• error
• hawk
• catcher

README

Symfony errors Catcher for Hawk.so.

Setup

1. Register an account, create a Project and get an Integration Token.

2. Install SDK via composer to install the Catcher

Catcher provides support for PHP 7.2 or later

$ composer require codex-team/hawk.symfony

Configuration

Add the following authorization information to your .env file:

HAWK_TOKEN=<your_token_from_the_control_panel>

Create a configuration file at config/packages/hawk.yaml with the following content:

hawk:
  integration_token: '%env(HAWK_TOKEN)%'

  # Optional: Configure a custom beforeSend service
  before_send_service: 'App\Hawk\BeforeSendService'

In the config/packages/monolog.yaml file, specify the handler settings under the appropriate section (dev or prod):

hawk:
  type: service
  id: HawkBundle\Monolog\Handler
  level: error

Adding User Information to Error Reports:

$this->catcher->setUser([
    'name' => 'user name',
    'photo' => 'user photo',
]);

$this->catcher->setContext([
    // Additional context information
]);

Sending Exceptions Manually:

To manually send exceptions, initialize __construct(\HawkBundle\Catcher $catcher) class via dependency injection (DI), and use the following method:

$this->catcher->sendException($exception);

Sending Custom Messages:

You can also send custom messages using the ->sendMessage(...) method:

$this->catcher->sendMessage(
    'your message', 
    [
        // Additional context information
    ]
);

Example: Sending Manually

private $catcher;

public function __construct(\HawkBundle\Catcher $catcher) 
{
    $this->catcher = $catcher;
}

public function test()
{
    try {
        // The code where you need to catch the error
    } catch (\Exception $exception) {
        $this->catcher->sendException($exception);
    }
}

Example: BeforeSendService Class

If you want to process or modify error data before sending it to Hawk, you can define a custom service by implementing the BeforeSendServiceInterface.

<?php

namespace App\Hawk;

use Hawk\EventPayload;
use HawkBundle\Service\BeforeSendServiceInterface;

class BeforeSendService implements BeforeSendServiceInterface
{
    public function __invoke(EventPayload $eventPayload): ?EventPayload
    {
        $user = $eventPayload->getUser();
        
        // Modify or add additional data to the error report
        if (!empty($user['email'])){
            unset($user['email']);
        
            $eventPayload->setUser($user);
        }
        
        // Return null to prevent the event from being sent to Hawk
        if ($eventPayload->getContext()['skip_sending'] ?? false) {
            return null;
        }

        return $eventPayload;
    }
}

Issues and improvements

Feel free to ask questions or improve the project.

Links

Repository: https://github.com/codex-team/hawk.symfony

Report a bug: https://github.com/codex-team/hawk.symfony/issues

Composer Package: https://packagist.org/packages/codex-team/hawk.symfony

CodeX Team: https://codex.so

License

MIT