foxen/laravel-validation-error-logger

Laravel Validation Error Logger

This package provides a simple trait to log validation errors in your Laravel application.

Installation

Install the package via composer:

composer require foxen/laravel-validation-error-logger

Configuration

Publish the configuration file:

php artisan vendor:publish --provider="Foxen\LaravelValidationErrorLogger\ServiceProvider"

This will create a config/validation-error-logger.php file in your application. Here you can configure the default logging channel and global fields to be excluded from logging.

<?php

return [
    /*
    |--------------------------------------------------------------------------
    | Log Channel
    |--------------------------------------------------------------------------
    |
    | This option defines the default log channel that will be used to log
    | validation errors. You can use any of the channels defined in your
    | `config/logging.php` file. The default is 'stack'.
    |
    */
    "log_channel" => env(
        "LOG_VALIDATION_ERRORS_CHANNEL",
        env("LOG_CHANNEL", "stack")
    ),

    /*
    |--------------------------------------------------------------------------
    | Exclude Fields From Logging
    |--------------------------------------------------------------------------
    |
    | This option allows you to specify a list of fields that should be
    | excluded from the logged data. This is useful for preventing sensitive
    | information from being written to your logs. By default, standard password
    | fields are already included.
    */
    'exclude_from_logging' => [
        'password',
        'password_confirmation',
    ],
];

Usage

To use the trait, simply import and use it in your FormRequest class:

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;
use Foxen\LaravelValidationErrorLogger\LogsValidationErrors;

class MyRequest extends FormRequest
{
    use LogsValidationErrors;

    public function rules()
    {
        return [
            'name' => 'required',
        ];
    }

    public function authorize()
    {
        return true;
    }
}

Customizing the Log Channel

You can override the default log channel by setting the $logChannel property in your request class:

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;
use Foxen\LaravelValidationErrorLogger\LogsValidationErrors;

class MyRequest extends FormRequest
{
    use LogsValidationErrors;

    protected $logChannel = 'custom_channel';

    public function rules()
    {
        return [
            'name' => 'required',
        ];
    }

    public function authorize()
    {
        return true;
    }
}

Excluding Fields from Logging

You can exclude fields from being logged by setting the $excludeFromLogging property in your request class:

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;
use Foxen\LaravelValidationErrorLogger\LogsValidationErrors;

class MyRequest extends FormRequest
{
    use LogsValidationErrors;

    protected $excludeFromLogging = ['password', 'password_confirmation'];

    public function rules()
    {
        return [
            'name' => 'required',
            'password' => 'required|confirmed',
        ];
    }

    public function authorize()
    {
        return true;
    }
}