README

Catch every bug in your Symfony application

This package is used to send errors from your Symfony application to the Bug Catcher tool.

Bug Catcher is a central dashboard for tracking all errors in your PHP applications in one place. It offers features such as:

• Ping collector – monitoring the availability of your projects.
• Log viewer – log viewer with stack trace and code preview.
• Configurable notifications – alerts via email, sound, or other channels.
• Access control – ability to grant clients access to specific projects.

For more information, visit the main project: https://github.com/php-bug-catcher/bug-catcher

Installation

Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.

Applications that use Symfony Flex

Open a command console, enter your project directory and execute:

$ composer require php-sentinel/reporter-bundle

versions

Applications that don't use Symfony Flex

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require php-sentinel/bug-catcher-reporter-bundle

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

// config/bundles.php

return [
    BugCatcher\Reporter\BugCatcherReporterBundle::class => ['all' => true],
];

Configuration

If you want to send caught errors via HTTP request

composer require symfony/http-client

# config/packages/bug_catcher.yaml
services:
    app.chain_uri_catcher:
        class: BugCatcher\Reporter\UrlCatcher\ChainUriCatcher
        arguments:
            $uriCatchers:
                - '@bug_catcher.uri_catcher.http_catcher'
                - '@bug_catcher.uri_catcher.console_catcher'
framework:
    http_client:
        scoped_clients:
            # only requests matching scope will use these options
            bug_catcher.client:
                base_uri: 'https://your-bug-catcher-instance:8000'
bug_catcher:
    project: 'dev'
    http_client: 'bug_catcher.client'
    uri_catcher: 'app.chain_uri_catcher'

Automatic logging by Monolog

composer require symfony/monolog-bundle

# config/packages/monolog.yaml
monolog:
    handlers:
        bug_catcher:
            type: service
            id: bug_catcher.handler
            level: 500

Custom Logging

class Foo {
	public function __construct(private readonly BugCatcherInterface $bugCatcher) {
		
	}
	
	public function foo():void {
		$this->bugCatcher->log([
			"message"     => "My message",
			"level"       => 500,
			"projectCode" => "dev",
			"requestUri"  => "my uri",
		]);
		$this->bugCatcher->logRecord("My log record", 500);
		$this->bugCatcher->logException(new \Exception("My Exception"));
	}
}