jmrashed/logger

A lightweight, production-ready logging utility for development environments

Maintainers

Package info

github.com/jmrashed/logger

pkg:composer/jmrashed/logger

Statistics

Installs: 2

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

v1.0.2 2025-11-19 07:59 UTC

Requires

Requires (Dev)

MIT b38507849fa022dfdc0b6931be091a072731909d

This package is auto-updated.

Last update: 2026-04-03 10:53:29 UTC

README

Latest Version PHP Version License Build Status Code Coverage

A lightweight, production-ready logging utility for development environments.

Requirements

  • PHP 7.4 or higher
  • Composer (recommended for installation)

Table of Contents

Features

  • Multiple log levels (DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY)
  • Automatic log rotation (10MB max, keeps 5 files)
  • Context data support with sanitization
  • Log injection prevention
  • Log level filtering (set minimum level)
  • JSON output format option
  • Channel naming support (PSR-3)
  • Fluent/chainable API for context
  • Log reader methods (readLogs, clear)
  • Thread-safe file writing
  • Git-ignored log files
  • PSR-4 autoloading
  • PSR-3 compliant
  • Composer package support
  • Comprehensive test suite
  • GitHub Actions CI/CD
  • PHP 7.4 - 8.4 support

Installation

Via Composer (Recommended)

composer require jmrashed/logger

Manual Installation

Download the Logger.php file and include it in your project.

Usage

// Using Composer autoload
require_once 'vendor/autoload.php';

use DevLogger\Logger;

// Basic logging
$logger = new Logger();
$logger->info('User logged in');
$logger->error('Database connection failed');
$logger->warning('Deprecated function used');

// Logging with context
$logger->info('User action', ['user_id' => 123, 'action' => 'login']);
$logger->error('Query failed', ['query' => 'SELECT * FROM users', 'error' => $e->getMessage()]);

// Configuration options
$logger = new Logger([
    'logDirectory' => '/var/log/myapp',
    'defaultLogFile' => 'app.log',
    'maxFileSize' => 10485760, // 10MB
    'maxFiles' => 5,
    'minLevel' => 'DEBUG', // Only log WARNING and above
    'jsonFormat' => false,
]);

// Chainable API
$logger->withContext(['user_id' => 123])->info('User logged in');

// Set minimum log level dynamically
$logger->setMinLevel('ERROR'); // Only log ERROR and above

// JSON output format
$logger->setJsonFormat(true)->info('JSON formatted log');

// Channel naming (PSR-3)
$namedLogger = $logger->withName('payment-service');
$namedLogger->info('Payment processed');

// Read last 100 log lines
$logs = $logger->readLogs(100);

// Read in reverse order (newest first)
$recentLogs = $logger->readLogs(50, true);

// Clear log file
$logger->clear();

// Get log file path
$path = $logger->getLogPath();

// Check last error
$error = $logger->getLastError();

Log Levels

  • DEBUG - Detailed debug information
  • INFO - General information messages
  • WARNING - Warning messages
  • ERROR - Error conditions
  • CRITICAL - Critical conditions

Log Format

[2024-01-15 14:30:25] [INFO] User logged in {"user_id":123,"action":"login"}

File Structure

_Logger/
├── Logger.php              # Main logger class
├── example.php             # Usage example
├── composer.json           # Composer package configuration
├── phpunit.xml.dist        # PHPUnit configuration
├── .gitignore              # Git ignore rules
├── CHANGELOG.md            # Change log
├── CODE_OF_CONDUCT.md      # Code of conduct
├── CONTRIBUTING.md         # Contributing guidelines
├── LICENSE                 # License file
├── README.md               # This file
├── SECURITY.md             # Security policy
├── .github/                # GitHub workflows and templates
├── docs/                   # Documentation
│   ├── API.md              # API documentation
│   └── INSTALL.md          # Installation guide
└── tests/                  # Test files
    └── LoggerTest.php      # Unit tests

Configuration

The logger automatically:

  • Creates log directory if it doesn't exist
  • Rotates logs when they exceed 10MB
  • Keeps maximum 5 log files
  • Uses thread-safe file writing

Configuration Options

Option Type Default Description
logDirectory string __DIR__ . '/logs' Directory for log files
defaultLogFile string application.log Name of the log file
maxFileSize int 10485760 (10MB) Max size before rotation
maxFiles int 5 Number of rotated files to keep
minLevel string DEBUG Minimum log level to record
jsonFormat bool false Output logs in JSON format

Log Levels

  • DEBUG - Detailed debug information
  • INFO - General information messages
  • NOTICE - Normal but significant events
  • WARNING - Warning messages
  • ERROR - Error conditions
  • CRITICAL - Critical conditions
  • ALERT - Action must be taken immediately
  • EMERGENCY - System is unusable

Testing

Run the test suite:

composer test

Contributing

Contributions are welcome! Please see our Contributing Guide for details.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Security

For security issues, please see our Security Policy.

Author

Md Rasheduzzzaman