Download the PHP package kariricode/logging without Composer

KaririCode Framework: Logging Component

A robust, flexible, and PSR-3 compliant logging component for the KaririCode Framework, providing comprehensive logging capabilities for PHP applications.

Features

• PSR-3 compliant
• Supports multiple log channels (file, Slack, Papertrail, Elasticsearch)
• Log encryption
• Asynchronous logging support
• Query and performance logging
• Flexible logging formatters
• Supports log rotation and cleanup
• Circuit breaker and retry logic for logging
• Detailed context and structured logging

Installation

To install the KaririCode Logging component, run the following command:

Basic Usage

Step 1: Environment Configuration

The KaririCode Logging Component relies on several environment variables to configure logging channels, log levels, external services, and other parameters. These variables are defined in a .env file, and the project comes with a default .env.example that should be copied to .env for initial setup.

To copy and create your .env file, run the following command:

This command will create a .env file if it doesn't already exist. Afterward, you can modify the values according to your requirements. Below are some key variables and their descriptions:

Each of these variables can be adjusted according to your specific needs:

• Log Channels: You can choose between different logging channels such as file, slack, or stderr. For example, LOG_CHANNEL=slack will send critical logs to a Slack channel.
• Log Levels: This defines the minimum severity level for logs to be recorded (e.g., debug, info, warning, error, critical).
• External Services: If you want to send logs to external services like Slack or Papertrail, ensure you correctly set SLACK_BOT_TOKEN, PAPERTRAIL_URL, and PAPERTRAIL_PORT.

Step 2: Loading Environment Variables and Configurations

After configuring your .env file, you need to load the environment variables in your application and specify the path to the logging configuration file. This is done in the initialization of the application.

Here’s how to set it up in your application.php file:

Step 3: Logging Example

Once the environment variables and the configuration are loaded, you can start using the loggers. Here's an example of logging messages at different levels:

Step 4: Using Specialized Loggers

The KaririCode Logging Component also supports specialized loggers, such as for asynchronous logging, query logging, and performance logging. Here’s how you can use these loggers:

Step 5: Sending Critical Logs to Slack

If you've configured Slack as a logging channel in the .env file, you can send critical logs directly to a specified Slack channel:

Make sure you’ve set your SLACK_BOT_TOKEN and SLACK_CHANNEL in the .env file for this to work properly.

Testing

To run tests for the KaririCode Logging Component, you can use PHPUnit. Run the following command inside your Docker container:

For test coverage:

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support and Community

• Documentation: https://kariricode.org
• Issue Tracker: GitHub Issues
• Community: KaririCode Club Community
• Professional Support: For enterprise-level support, contact us at [email protected]

Acknowledgments

• The KaririCode Framework team and contributors.
• The PHP community for their continuous support and inspiration.

Built with ❤️ by the KaririCode team. Empowering developers to build more robust and flexible PHP applications.

Maintained by Walmir Silva - [email protected]