elminson/database-query-logger

A powerful PHP package for logging SQL queries from Laravel applications, supporting both Eloquent and Query Builder instances, with flexible output options.

1.1.3 2025-05-17 21:14 UTC

This package is auto-updated.

Last update: 2025-05-18 00:04:50 UTC


README

Latest Version on Packagist Tests Total Downloads

A powerful PHP package for logging SQL queries from Laravel applications, supporting both Eloquent and Query Builder instances, with flexible output options.

Installation

You can install the package via Composer:

composer require elminson/database-query-logger

Features

  • Log SQL queries from Eloquent or Query Builder instances
  • Log SQL queries to a file or the console
  • Log SQL queries with parameter bindings
  • Support for PDO statements
  • Configurable logging options
  • Timestamp-based log entries
  • Automatic directory creation for log files
  • Support for different parameter types (string, integer, boolean, null)

Configuration

Environment Variables

Add these variables to your .env file:

DB_LOGGER_ENABLED=true
DB_LOGGER_CONSOLE_OUTPUT=true
DB_LOGGER_FILE_LOGGING=true
DB_LOGGER_FILE_PATH=storage/logs/queries.log

Manual Configuration

Copy the configuration file to your Laravel project:

cp vendor/elminson/database-query-logger/src/config/database-logger.php config/db-logger.php

Service Provider

Register the service provider in config/app.php:

'providers' => [
    // ...
    App\Providers\DatabaseQueryLoggerServiceProvider::class,
],

Usage

Basic Usage

use Elminson\DbLogger\DatabaseQueryLogger;
use Illuminate\Database\Capsule\Manager as DB;

// Initialize the logger
$logger = new DatabaseQueryLogger([
    'enabled' => true,
    'console_output' => true,
    'file_logging' => true,
    'log_file' => storage_path('logs/queries.log')
]);

// Log a query
$query = DB::table('users')->where('email', 'example@example.com');
$logger->logQuery($query);

PDO Statement Logging

use PDO;
use PDOStatement;

$pdo = new PDO('sqlite::memory:');
$stmt = $pdo->prepare('SELECT * FROM users WHERE email = :email');
$stmt->bindParam(':email', 'example@example.com');

$logger->logQuery($stmt, ['example@example.com']);

Raw Query Logging

$sql = 'SELECT * FROM users WHERE email = ?';
$bindings = ['example@example.com'];
$logger->logQuery($sql, $bindings, $connection);

Configuration Methods

// Enable/disable logging
$logger->enable(true);

// Enable/disable console output
$logger->enableConsoleOutput(true);

// Set log file path
$logger->setLogFile(storage_path('logs/queries.log'));

Testing

Run the tests with:

composer test

Run tests with coverage:

composer test-coverage

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

License

The MIT License (MIT). Please see License File for more information.

Log All Queries in Laravel

To log every SQL query executed by your Laravel application, add the following to your app/Providers/AppServiceProvider.php:

use Illuminate\Support\Facades\DB;
use Elminson\DbLogger\DatabaseQueryLogger;

public function boot()
{
    $logger = new DatabaseQueryLogger(config('db-logger'));

    DB::listen(function ($query) use ($logger) {
        $logger->logQuery(
            $query->sql,
            $query->bindings,
            $query->connection
        );
    });
}

Make sure your config/db-logger.php and .env are set up as described above. This will ensure all queries are logged according to your configuration.