README.md

Laravel S3-compatible log system.

Laravel LogWeaver

Laravel LogWeaver is a PHP package designed to provide a simple and flexible way to log events in your Laravel application. It offers a fluent interface for creating logs, allowing you to easily specify the log level, resource, content, and storage disk.

Features

• Fluent Interface: Easily create logs with a fluent, chainable interface.
• Multiple Log Levels: Supports different log levels including 'info', 'warning', 'error', and 'critical'.
• Resource Specification: Specify the resource of the log, such as 'system' or 'event'.
• Customizable Storage: Choose your storage disk and directory.
• Parameter Validation: Ensures the validity of log parameters before logging.
• Array and JSON Conversion: Convert your logs to array or JSON format.
• Asynchronous Logging: Log events asynchronously with optional waiting for the log to be written to the disk.

Installation

You can install the package via composer:

composer require halilcosdu/laravel-logweaver

composer require league/flysystem-aws-s3-v3 "^3.0" --with-all-dependencies
composer require league/flysystem-ftp "^3.0"
composer require league/flysystem-sftp-v3 "^3.0"

AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=
AWS_USE_PATH_STYLE_ENDPOINT=false

You can publish the config file with:

php artisan vendor:publish --tag="logweaver-config"

This is the contents of the published config file:

return [
    'sleep' => env('LOG_WEAVER_SLEEP', 0.5),
];

Usage

\HalilCosdu\LogWeaver\Facades\LogWeaver::description(string $description): static
\HalilCosdu\LogWeaver\Facades\LogWeaver::logResource(string $logResource): static
\HalilCosdu\LogWeaver\Facades\LogWeaver::level(string $level): static
\HalilCosdu\LogWeaver\Facades\LogWeaver::content(array $content): static
\HalilCosdu\LogWeaver\Facades\LogWeaver::disk(string $disk): static
\HalilCosdu\LogWeaver\Facades\LogWeaver::directory(string $directory): static
\HalilCosdu\LogWeaver\Facades\LogWeaver::relation(?array $relation): static
\HalilCosdu\LogWeaver\Facades\LogWeaver::log(?string $path = null, bool $wait = false): array
\HalilCosdu\LogWeaver\Facades\LogWeaver::download(string $path, $name = null, array $headers = []): StreamedResponse
\HalilCosdu\LogWeaver\Facades\LogWeaver::delete(string|array $paths): bool
\HalilCosdu\LogWeaver\Facades\LogWeaver::validation(?bool $validation): static
\HalilCosdu\LogWeaver\Facades\LogWeaver::get(string $path): string
\HalilCosdu\LogWeaver\Facades\LogWeaver::toArray(): array
\HalilCosdu\LogWeaver\Facades\LogWeaver::toJson($options = 0): false|string

$log = LogWeaver::description('User logged in')
    ->logResource('event')
    ->content(['email' => '[email protected]'])
    ->level('info')
    ->relation(['user_id' => 1])
    ->toArray();

$log = LogWeaver::description('System error occurred')
    ->logResource('system')
    ->content(['error' => 'Database connection failed'])
    ->level('error')
    ->log($path, $wait);

$log = LogWeaver::description('Payment gateway down')
    ->logResource('event')
    ->content(['gateway' => 'Stripe', 'status' => 'down'])
    ->level('critical')
    ->log();

$log = LogWeaver::description('Disk space running low')
    ->logResource('system')
    ->content(['disk_space' => '10% remaining'])
    ->level('warning')
    ->toJson();

$log = LogWeaver::description('User registered')
    ->logResource('event')
    ->content(['user_id' => 2, 'email' => '[email protected]'])
    ->level('info')
    ->disk('local')
    ->directory('custom_logs')
    ->log();

If you want to disable built-in validation, you can use the following methods:

Built-in validations are:

$rules = [
    'level' => ['required', 'in:info,warning,error,critical'],
    'log_resource' => ['required', 'in:system,event'],
    'description' => ['required', 'string'],
    'directory' => ['string'],
    'disk' => ['string', 'in:s3,local,ftp,sftp,public'],
    'content' => ['required', 'array'],
];

$log = LogWeaver::description('User registered')
    ->validation(false)
    ->logResource('custom_input')
    ->content(['user_id' => 2, 'email' => '[email protected]'])
    ->level('custom_input')
    ->disk('custom_input')
    ->directory('custom_logs')
    ->log();

$response = LogWeaver::download(string $path, $name = null, array $headers = []): StreamedResponse;
$response = LogWeaver::delete(string|array $paths): bool;
$response = LogWeaver::get(string $path): string;

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Halil Cosdu
• All Contributors

License

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