communitales/log

Communitales Log Component

3.2.0 2024-04-19 18:02 UTC

Requires

• php: >=8.3
• psr/log: ^1|^2|^3

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.51
• monolog/monolog: ^3.6
• phpstan/phpstan: ^1.10
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-phpunit: ^1.3
• phpunit/phpunit: ^10.5
• psalm/plugin-phpunit: ^0.19.0
• rector/rector: ^1.0
• sentry/sentry: ^4.7
• vimeo/psalm: ^5.23

MIT

• log
• php

README

Convenient integration for logging of messages and exceptions.

Setup

Just use the LogAwareTrait.

Then set a logger via $this->setLogger($logger); or use the Psr\Log\LoggerAwareInterface as marker interface to let the Dependency Injection do the magic for you.

Symfony example:

services:

    _instanceof:
        Psr\Log\LoggerAwareInterface:
            calls:
                - [setLogger, ['@logger']]

Usage

use App\Component\Log\LogAwareTrait;
use Psr\Log\LoggerAwareInterface;
use \RuntimeException;

class SomeClass implements LoggerAwareInterface
{

    use LogAwareTrait;

    public function testLog(): void
    {
        // Log your message including debug information
        $this->log('Test message', LogLevel::DEBUG, ['param1' => 'useful debug information']);

        // Log an error
        $this->log('This should not happen');
    }

    public function testLogException(): void
    {
        try {
            throw new RuntimeException('Something gone wrong');
        } catch (RuntimeException $exception) {

            // Log with one line
            $this->logException($exception);
        }

    }
}

Sentry logging out of the box

If the \Sentry\captureException function is available, exceptions will be logged also to Sentry.