Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onramplab/laravel-log-enhancement
An enhanced logging package for Laravel
https://github.com/onramplab/laravel-log-enhancement
laravel-log loggly loggly-client
Last synced: 6 days ago
JSON representation
An enhanced logging package for Laravel
- Host: GitHub
- URL: https://github.com/onramplab/laravel-log-enhancement
- Owner: OnrampLab
- License: mit
- Created: 2020-12-30T09:41:36.000Z (almost 4 years ago)
- Default Branch: 10.x
- Last Pushed: 2024-07-22T02:32:38.000Z (4 months ago)
- Last Synced: 2024-11-07T17:58:19.823Z (11 days ago)
- Topics: laravel-log, loggly, loggly-client
- Language: PHP
- Homepage:
- Size: 33.2 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# laravel-log-enhancement
[](LICENSE.md)
[](https://circleci.com/gh/OnrampLab/laravel-log-enhancement)
[](https://packagist.org/packages/onramplab/laravel-log-enhancement)
A library with logging enhancement. Including:
- Overriding `Log` facade
- It extends default Laravel `Log` facade with logging adding class path and tracking id into context.
- `LogglyHandler` class
- It extends monolog's LogglyHandler with tags support
- `DatadogHandler` class
- It supports Datadog Logs
## Install
```bash
composer require onramplab/laravel-log-enhancement
```
- use Datadog APM to connect php logs and traces
```bash
curl -LO https://github.com/DataDog/dd-trace-php/releases/latest/download/datadog-setup.php
sudo php datadog-setup.php --php-bin=all
```
## Usage
### LoggerFacade
The log json will look like this:
```json
{
"message": "Test",
"context": {
"class_path": "App\\Fake",
"tracking_id": "652c3456-1a17-42b8-9fa7-9bee65e655eb"
},
"level": 200,
"level_name": "INFO",
"channel": "local",
"extra": {},
"timestamp": "2021-01-04T22:47:56.598608-0800"
}
```
### LogglyHandler
You can adding following block into `config/logging.php`.
```php
use Monolog\Formatter\LogglyFormatter;
use Onramplab\LaravelLogEnhancement\Handlers\LogglyHandler;
return [
//...
'channels' => [
//...
'loggly' => [
'driver' => 'monolog',
'level' => 'info',
'handler' => LogglyHandler::class,
'handler_with' => [
'token' => env('LOGGLY_TOKEN'),
'tags' => env('LOGGLY_TAGS'),
],
'formatter' => LogglyFormatter::class,
],
]
];
```
### DatadogHandler
You can adding following block into `config/logging.php`.
```php
use Monolog\Formatter\JsonFormatter;
use Onramplab\LaravelLogEnhancement\Handlers\DatadogHandler;
return [
//...
'channels' => [
//...
'datadog' => [
'driver' => 'monolog',
'level' => 'info',
'handler' => DatadogHandler::class,
'handler_with' => [
'key' => env('DD_LOG_API_KEY'),
'region' => env('DD_LOG_REGION', 'us5'),
'attributes' => [
'hostname' => gethostname(),
'source' => env('DD_LOG_SOURCE', 'laravel'),
'service' => env('DD_LOG_SERVICE'),
'tags' => env('DD_LOG_TAG'),
],
],
'formatter' => JsonFormatter::class,
],
]
];
```
## Testing
Run the tests with:
```bash
vendor/bin/phpunit
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security
If you discover any security-related issues, please email [email protected] instead of using the issue tracker.
## License
The MIT License (MIT). Please see [License File](/LICENSE.md) for more information.# laravel-log-enhancement