Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ytake/laravel-fluentlogger
fluent logger for laravel (with Monolog handler for Fluentd)
https://github.com/ytake/laravel-fluentlogger
fluentd laravel logger lumen
Last synced: 22 days ago
JSON representation
fluent logger for laravel (with Monolog handler for Fluentd)
- Host: GitHub
- URL: https://github.com/ytake/laravel-fluentlogger
- Owner: ytake
- License: mit
- Created: 2015-11-05T16:45:14.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2024-05-08T14:23:34.000Z (7 months ago)
- Last Synced: 2024-10-04T11:56:41.163Z (about 2 months ago)
- Topics: fluentd, laravel, logger, lumen
- Language: PHP
- Homepage:
- Size: 85 KB
- Stars: 63
- Watchers: 6
- Forks: 23
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# laravel-fluent-logger
fluent logger for laravel
(with Monolog handler for Fluentd )
[fluentd](http://www.fluentd.org/)
[](https://github.com/ytake/Laravel-FluentLogger/actions/workflows/php.yml)
[](https://coveralls.io/r/ytake/Laravel-FluentLogger?branch=master)
[](https://scrutinizer-ci.com/g/ytake/Laravel-FluentLogger/?branch=master)
[](https://packagist.org/packages/ytake/laravel-fluent-logger)
[](https://packagist.org/packages/ytake/laravel-fluent-logger)
[](https://packagist.org/packages/ytake/laravel-fluent-logger)
## Versions
| Framework | Library |
|------------------------|---------------------------------|
| Laravel / Lumen < v10 | ytake/laravel-fluent-logger: ^5 |
| Laravel / Lumen >= v10 | ytake/laravel-fluent-logger: ^6 |
## usage
### Installation For Laravel
Require this package with Composer
```bash
$ composer require ytake/laravel-fluent-logger
```
or composer.json
```json
"require": {
"ytake/laravel-fluent-logger": "^6.0"
},
```
**Supported Auto-Discovery(^Laravel5.5)**
## for laravel
your config/app.php
```php
'providers' => [
\Ytake\LaravelFluent\LogServiceProvider::class,
]
```
### publish configure
* basic
```bash
$ php artisan vendor:publish
```
* use tag option
```bash
$ php artisan vendor:publish --tag=log
```
* use provider
```bash
$ php artisan vendor:publish --provider="Ytake\LaravelFluent\LogServiceProvider"
```
## for Lumen
use `Ytake\LaravelFluent\LumenLogServiceProvider`
bootstrap/app.php
```php
$app->register(\Ytake\LaravelFluent\LumenLogServiceProvider::class);
```
Lumen will use your copy of the configuration file if you copy and paste one of the files into a config directory within your project root.
```bash
cp vendor/ytake/laravel-fluent-logger/src/config/fluent.php config/
```
### Config
edit config/fluent.php
```php
return [
'host' => env('FLUENTD_HOST', '127.0.0.1'),
'port' => env('FLUENTD_PORT', 24224),
/** @see https://github.com/fluent/fluent-logger-php/blob/master/src/FluentLogger.php */
'options' => [],
/** @see https://github.com/fluent/fluent-logger-php/blob/master/src/PackerInterface.php */
// specified class name
'packer' => null,
// optionally override Ytake\LaravelFluent\FluentHandler class to customize behaviour
'handler' => null,
'processors' => [],
'tagFormat' => '{{channel}}.{{level_name}}',
];
```
added config/logging.php
```php
return [
'channels' => [
'stack' => [
'driver' => 'stack',
// always added fluentd log handler
// 'channels' => ['single', 'fluent'],
// fluentd only
'channels' => ['fluent'],
],
'fluent' => [
'driver' => 'fluent',
'level' => 'debug',
],
'single' => [
'driver' => 'single',
'path' => storage_path('logs/laravel.log'),
'level' => 'debug',
],
'daily' => [
'driver' => 'daily',
'path' => storage_path('logs/laravel.log'),
'level' => 'debug',
'days' => 7,
],
'slack' => [
'driver' => 'slack',
'url' => env('LOG_SLACK_WEBHOOK_URL'),
'username' => 'Laravel Log',
'emoji' => ':boom:',
'level' => 'critical',
],
'syslog' => [
'driver' => 'syslog',
'level' => 'debug',
],
'errorlog' => [
'driver' => 'errorlog',
'level' => 'debug',
],
],
];
```
or custom / use `via`
```php
return [
'channels' => [
'custom' => [
'driver' => 'custom',
'via' => \Ytake\LaravelFluent\FluentLogManager::class,
],
]
];
```
## fluentd config sample
```
## match tag=local.** (for laravel log develop)
type stdout
```
example (production)
```
type stdout
```
and more
## for lumen
## fluentd config sample(lumen)
```
type stdout
```
## Tag format
The tag format can be configured to take variables from the [LogEntry](https://github.com/Seldaek/monolog/blob/main/src/Monolog/LogRecord.php)
object. This will then be used to match tags in fluent.
`{{channel}}` will be [Laravel's current environment](https://laravel.com/docs/10.x/logging#configuring-the-channel-name) as configured in
`APP_ENV`, NOT the logging channel from `config/logging.php`
`{{level_name}}` will be the [uppercase string version of the log level](https://github.com/Seldaek/monolog/blob/main/src/Monolog/Level.php#L136).
`{{level}}` is the [numeric value](https://github.com/Seldaek/monolog/blob/main/src/Monolog/Level.php) of the log level. Debug == 100, etc
You can also use variables that exist in `LogEntry::$extra`. Given a message like
```php
$l = new \Monolog\LogRecord(extra: ['foo' => 'bar']);
```
You could use a tag format of `myapp.{{foo}}` to produce a tag of `myapp.bar`.
## Monolog processors
You can add [processors](https://seldaek.github.io/monolog/doc/01-usage.html#using-processors) to the Monolog handlers by adding them to
the `processors` array within the `fluent.php` config.
config/fluent.php:
```php
'processors' => [function (\Monolog\LogRecord $record) {
$record->extra['cloudwatch_log_group'] = 'test_group';
return $record;
}],
```
Alternatively, you can pass the class name of the processor. This helps keep your config compatible with `config:cache`
config/fluent.php:
```php
'processors' => [CustomProcessor::class],
```
CustomProcessor.php:
```php
class CustomProcessor
{
public function __invoke(\Monolog\LogRecord $record)
{
$record->extra['cloudwatch_log_group'] = 'test_group';
return $record;
}
}
```
## Author ##
- [Yuuki Takezawa](mailto:[email protected]) ([twitter](http://twitter.com/ex_takezawa))
## License ##
The code for laravel-fluent-logger is distributed under the terms of the MIT license.