PHP Luminova: Application Logger Class

The Luminova Logger class is a PSR-3 compliant logging system that extends the LoggerInterface. It provides a unified and flexible interface for managing application logs and acts as a dispatcher, ensuring seamless compatibility with other PSR-compliant loggers.

Key Features

• PSR-3 Compliance: Adheres to LoggerInterface, enabling integration with third-party tools.
• Default Logger: Automatically configured as the default logger in Luminova applications.
• Versatile Dispatching: Supports logging to various destinations such as files, emails, or remote servers.
• Custom Logger Support: Can be replaced with a custom PSR-compliant logger via the application configuration.
• Convenient Helpers: Includes global functions and factory methods for easy access to the logger.

Usage

The Luminova Logger can be accessed and used in multiple ways, ensuring flexibility and convenience.

Using Global Helper Function

// Log an informational message
logger('info', 'This is an informational message');

// Log a message to a remote server
logger('https://example.com/api/log', 'This is a remote log message');

// Log a message to an email
logger('[email protected]', 'This is an email log message');

Accessing the Logger via Factory

$logger = factory('logger');

or using the application factory:

use Luminova\Application\Factory;

$logger = Factory::logger();

Creating a New Logger Instance

use Luminova\Logger\Logger;

$logger = new Logger();

Basic Logging Examples

// Log an informational message
$logger->info('This is an informational message.');

// Log an error message
$logger->dispatch('error', 'This is an error message.');

// Dispatch log to an email
$logger->dispatch('[email protected]', 'Critical error detected.');

// Dispatch log to a remote server
$logger->dispatch('https://example.com/api/log', 'Critical error detected.');

Note: The dispatch method automatically determines the appropriate destination (file, email, or remote server) based on the input type, making log management more intuitive.

Customization

To use a custom logger instead of the default:

1. Implement the App\Config\Logger class's getLogger method to return your preferred PSR-compliant logger.
2. The custom logger will automatically handle all logging operations in your application.

Example: Custom Logger Integration

public function getLogger(): ?LoggerInterface
{
    return new MonologLogger('custom-channel');
}

This makes it easy to switch logging implementations while maintaining PSR compliance.

Class Definition

• Class namespace: \Luminova\Logger\Logger
• This class implements:\Psr\Log\LoggerInterface

Properties

logger

PSR logger interface.

protected static ?\Psr\Log\LoggerInterface $logger = null;

Methods

constructor

Initialize logger instance

public __construct(): mixed

getLogger

Get shared instance of PSR logger class.

public static getLogger(): \Psr\Log\LoggerInterface

Return Value:

\Psr\Log\LoggerInterface - Return instance of logger class in-use.

emergency

Log an emergency message.

public emergency(string $message, array $context = []): void

Parameters:

alert

Log an alert message.

public alert(string $message, array $context = []): void

Parameters:

critical

Log a critical message.

public critical(string $message, array $context = []): void

Parameters:

error

Log an error message.

public error(string $message, array $context = []): void

Parameters:

warning

Log a warning message.

public warning(string $message, array $context = []): void

Parameters:

notice

Log a notice message.

public notice(string $message, array $context = []): void

Parameters:

info

Log an info message.

public info(string $message, array $context = []): void

Parameters:

debug

Log a debug message.

public debug(string $message, array $context = []): void

Parameters:

exception

Log an exception message.

public exception(string $message, array $context = []): void

Parameters:

php

Log an php message.

public php(string $message, array $context = []): void

Parameters:

metrics

Log an performance metric.

public metrics(string $message, array $context = []): void

Parameters:

log

Log a message at a specified log level.

public log(string $level, string $message, array $context = []): void

Parameters:

Throws:

• \Luminova\Exceptions\InvalidArgumentException - If logger does not implement LoggerInterface

dispatch

Sends a log message to a specified destination, either asynchronously or synchronously.

The method validates the logging destination and routes the log based on its type(log level, email address, or URL). Email and network logging are performed asynchronously by default.

public dispatch(string $to, string $message, array $context = []): void

Parameters:

Throws:

• \Luminova\Exceptions\InvalidArgumentException - If an invalid logging destination is provided.
• \Luminova\Exceptions\RuntimeException - If called logging for network or mail destination for non-novalogger class.