README

Telemetry Logger is an extensible PHP package that allows logging to multiple destinations (drivers) and formats. It follows the PSR-3 logging standard and is designed to be flexible and easily extensible with custom drivers and formatters.

Features

• Supports multiple drivers: CLI and file.
• Extensible for adding custom drivers and formatters.
• Easy to use with a configurable LoggerBuilder.
• Supports log transactions.
• PSR-3 compliant.

Requirements

• PHP 8.2 or higher.
• Composer for dependency management.
• PHPUnit for running tests.

Installation

You can install the package via Composer:

composer require ju4n/telemetry-logger

Documentation

• Usage
• Extending Drivers and Formatters
• Included Drivers and Formatters
• UML Diagram

Running Tests

This project includes a set of unit tests that you can run using PHPUnit.

First, ensure that you have installed the development dependencies:

composer install --dev

Then, you can run the tests with the following command:

vendor/bin/phpunit

You can also generate a code coverage report:

vendor/bin/phpunit --coverage-html coverage/

If you don't have PHP installed on your local machine, you can run the tests using docker-compose by executing:

docker-compose run composer install && docker-compose run phpunit

Diagram

License

This project is licensed under the MIT License.