Skip to content

Latest commit

 

History

History
218 lines (112 loc) · 5.28 KB

CHANGELOG.md

File metadata and controls

218 lines (112 loc) · 5.28 KB
Raw

Changelog

All notable changes to laravel-logweaver will be documented in this file.

v1.0.6 - 2024-05-06

Full Changelog: https://github.com/halilcosdu/laravel-logweaver/compare/v1.0.5...v1.0.6

v1.0.5 - 2024-04-30

Full Changelog: https://github.com/halilcosdu/laravel-logweaver/compare/v1.0.4...v1.0.5

v1.0.4 - 2024-04-30

What's Changed

  • Bump dependabot/fetch-metadata from 2.0.0 to 2.1.0 by @dependabot in #9

Full Changelog: https://github.com/halilcosdu/laravel-logweaver/compare/v1.0.3...v1.0.4

v1.0.3 - 2024-04-22

Release Notes for v1.0.3:

In this release, a new function download has been added to the LogWeaver class. This function allows you to download a log file from the storage disk.

Here's a brief overview of the new function:

  • download(string $path, $name = null, array $headers = []): StreamedResponse: This function takes in three parameters: $path, $name, and $headers. The $path parameter is the path of the file in the storage disk. The $name parameter is an optional parameter that specifies the name of the downloaded file. The $headers parameter is an optional array of headers to be included in the response. The function returns a StreamedResponse, which represents the response of the file download.

This new function enhances the functionality of the LogWeaver class by providing an easy way to download log files.

v1.0.2 - 2024-04-16

Release Notes:

  • Updated the test case 'should throw exception if parameters are invalid' in tests/LogWeaverTest.php.
  • The test now checks if an exception is thrown when invalid parameters are passed to the LogWeaver class.
  • This ensures the robustness of the LogWeaver class by validating its error handling capabilities.

v1.0.1 - 2024-04-16

This release includes updates to the test suite of the LogWeaver class in the Laravel LogWeaver project. The tests have been rewritten using the Pest PHP testing framework, which provides a more expressive and streamlined syntax compared to traditional PHPUnit tests.

The changes include tests for the following functionalities of the LogWeaver class:

  • Instantiation of the LogWeaver class
  • Setting the description
  • Setting the log resource
  • Setting the content
  • Setting the level
  • Setting the disk
  • Setting the directory

Each of these functionalities is tested in isolation to ensure that they work as expected. The tests are designed to be run using the vendor/bin/pest command in the terminal.

This release is a part of ongoing efforts to improve the quality and reliability of the Laravel LogWeaver project by ensuring that all major functionalities are covered by automated tests.

v1.0.0 - 2024-04-16

Release v1.0.0

This is the first major release of the Laravel LogWeaver package. This package provides a simple and flexible way to log events in your Laravel application, with support for multiple storage disks.

Features

  • Fluent interface for creating logs.
  • Support for different log levels: info, warning, error, and critical.
  • Ability to specify the resource of the log: system or event.
  • Customizable storage disk and directory.
  • Validation of log parameters.
  • Conversion of log to array or JSON.
  • Asynchronous logging with optional waiting for the log to be written to the disk.

Usage Examples

Logging a user login event:

$log = LogWeaver::description('User logged in')
    ->logResource('event')
    ->content(['user_id' => 1, 'email' => 'test@example.com'])
    ->level('info')
    ->toArray();

Logging a system error:

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

Logging a critical event:

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

Logging a warning:

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

Logging an event with custom disk and directory:

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

Installation

You can install the package via composer:

composer require halilcosdu/laravel-logweaver

You can publish the config file with:

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

Testing

You can run the tests with:

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

License

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