Как сделать динамическое логирование в Laravel?

Question

[Svjatoslav Torn]

Добрый день, есть необходимость сделать динамическое логирование в хобби проекте.
Представим ситуацию, у нас множество пользователей и мы хотим логировать действия каждого из них в отдельных журналах. Я конечно нашел выход из ситуации, но вот думаю может можно как то и по другому сделать.
Как я реализовал это:
Объявил кастомный канал
config/logging.php

'custom' => [
      'driver' => 'custom',
      'via' => App\Logging\CreateCustomLogger::class,
],

2. Создал обработчик как в документации
app/logging/CreateCustomLogging.php

public function __invoke(array $config)
{
    return new Logger('name');
}

3. Добавил метод в интерфейс и сделал его реализацию
app/repositories/OfficeLogger.php

use Monolog\Handler\StreamHandler;
use Monolog\Logger;
public function log(string $path, string $message, array $context)
{
     \Log::channel('custom')->pushHandler(new StreamHandler(storage_path($path), Logger::DEBUG))->info($message, $context);
}

А потом вызываю там где мне необходимо, вот так:

app('App\Repositories\Interfaces\OfficeLoggerInterface')->log('app/office-logger/1/47/.'.date('Y').'/'.date('d-m-Y').'.log', 'Hello world message', $context);

Наверное можно как то лучше сделать?
Нормально ли постоянно использовать app('interface')?

Answer 1

[FanatPHP]

Что либо писать руками - это спагетти.
Суть ларавеля в том, что все делается автоматом

В данном случае делается middleware,

<?php

namespace App\Http\Middleware;

use Closure;
use \Illuminate\Http\Request;

class UserActivityLoggerMiddleware
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle(Request $request, Closure $next)
    {
        // тут пишешь свое логирование
       $user_id = $request->user()->id;
       $action = $request->route()->getName();
        // обяязательная строчка
        return $next($request);
    }
}

регистрируешь в Kernel.php

'logger' => \App\Http\Middleware\UserActivityLoggerMiddleware::class,

и рауты пользователей заключаешь в вызов этой мидлвари

Route::group(['middleware' => ['logger']], function()
{
}

Comments

[Svjatoslav Torn]

Ммм, наверное все таки мидлвэйр не подойдет. Я буду логировать такие События как удаление, создание, изменение чего либо, указывая кто, когда и что удалил. Как я все это передам в мидлвару.
Это должно быть типа вот так:

public function delete(int $id){
    if(Model::destroy($id)){
         Только тут мы логируем использую текущего юзера, ид записи и тд
    }
}

[FanatPHP]

о господи.
что ты передавать собрался? там уже всё есть

$request->user()->id;
$request->route()->getName();

[Svjatoslav Torn]

FanatPHP, route()->getName() врядли корректно работает с laravel/livewire. Все приложенте на livewire компонентах. Подумаю как это можно будет использовать, возможно прокатит.
Я в мидлваре могу юзать интерфейс?

[FanatPHP]

вместо имени раута можно использовать сам запрос, $action = Route::currentRouteAction();

[Svjatoslav Torn]

FanatPHP, Пробую сделать через middleware,
Получилось построить путь к журналу, получаю пользователя, и даже могу получить ИМЯ компонента в котором совершается действие. Но какое действие совершается неизвестно.

class UserActivityLoggerMiddleware
{
    public function handle(Request $request, Closure $next)
    {
        dd($request->route());
//        dd(Route::currentRouteAction());
//        dd($request->user('staffCompany')->offices()->get());

        $offices = $request->user('staffCompany')->offices()->get()->toArray();
        $path = 'app/office-logger/'. $offices[0]['company_id'] .'/'. $offices[0]['id'] .'/'.date('Y').'/'.date('d-m-Y').'.log';
        $message = 'Рудди';
        $context = ['user' => 'lalala'];
//        dd($path);

        Log::channel('custom')->pushHandler(new StreamHandler(storage_path($path), Logger::DEBUG))->info($message, $context);
        return $next($request);
    }
}

Ведь на основании того что произошло мне нужно человекопонятное сообщение, для отображение в логгере.
dd($request->route());

Illuminate\Routing\Route {#218 ▼
  +uri: "livewire/message/{name}"
  +methods: array:1 [▼
    0 => "POST"
  ]
  +action: array:3 [▼
    "uses" => "Livewire\Controllers\HttpConnectionHandler@__invoke"
    "controller" => "Livewire\Controllers\HttpConnectionHandler"
    "middleware" => array:2 [▼
      0 => "web"
      1 => "logger"
    ]
  ]
  +isFallback: false
  +controller: Livewire\Controllers\HttpConnectionHandler {#456}
  +defaults: []
  +wheres: []
  +parameters: array:1 [▼
    "name" => "console.manage.data.city"
  ]
  +parameterNames: array:1 [▼
    0 => "name"
  ]
  #originalParameters: array:1 [▼
    "name" => "console.manage.data.city"
  ]

[Svjatoslav Torn]

FanatPHP, Я нашел где есть инфа о вызываемом методе, подскажи как я могу обратиться к "content"
dd($request->route()); внутри - это

Illuminate\Routing\Route {#218 ▼
  +uri: "livewire/message/{name}"
  +methods: array:1 [▶]
  +action: array:3 [▶]
  +isFallback: false
  +controller: Livewire\Controllers\HttpConnectionHandler {#456}
  +defaults: []
  +wheres: []
  +parameters: array:1 [▶]
  +parameterNames: array:1 [▶]
  #originalParameters: array:1 [▶]
  #lockSeconds: null
  #waitSeconds: null
  +computedMiddleware: array:2 [▶]
  +compiled: Symfony\Component\Routing\CompiledRoute {#464 ▶}
  #router: Illuminate\Routing\Router {#27 ▼
    #events: Illuminate\Events\Dispatcher {#28 ▶}
    #container: Illuminate\Foundation\Application {#4 ▶}
    #routes: Illuminate\Routing\RouteCollection {#30 ▶}
    #current: Illuminate\Routing\Route {#218}
    #currentRequest: Illuminate\Http\Request {#44 ▼
      #json: Symfony\Component\HttpFoundation\ParameterBag {#36 ▶}
      #convertedFiles: null
      #userResolver: Closure($guard = null) {#447 ▶}
      #routeResolver: Closure() {#455 ▶}
      +attributes: Symfony\Component\HttpFoundation\ParameterBag {#46 ▶}
      +request: Symfony\Component\HttpFoundation\ParameterBag {#36 ▶}
      +query: Symfony\Component\HttpFoundation\InputBag {#52 ▶}
      +server: Symfony\Component\HttpFoundation\ServerBag {#48 ▶}
      +files: Symfony\Component\HttpFoundation\FileBag {#49 ▶}
      +cookies: Symfony\Component\HttpFoundation\InputBag {#47 ▶}
      +headers: Symfony\Component\HttpFoundation\HeaderBag {#50 ▶}
      #content: "{"id":"vrlfAgOTCa6Xaw7bQt9C","data":{"cityList":{"class":"App\\Model\\Data\\City","id":[4,2,10,9,1,6,7,12,8,3],"relations":[],"connection":"mysql"},"update":null,"name":null},"name":"console.manage.data.city","checksum":"56f199465405d25c003aca701ec3242ae7f49aa1c3b167f40367ed96d2e5fde7","locale":"ru","children":[],"actionQueue":[{"type":"callMethod","payload":{<b>"method":"delete","params":[12</b><i></i>]}}]} ◀"

[FanatPHP]

вот ещё одна причина по которой тебе нужна БД и интерфейс
"человекопонятное сообщение" пишется при отображении, а не при записи

Answer 2

[Alex Wells]

Это реальная задача? И.е. нужно выводить эти действия куда-то, или это для дебага? Потому что если второе, то забудь о логировании через код. Есть логи nginx'а.

Comments

[Svjatoslav Torn]

Это первый вариант! Ведение журналов действий сотрудников конкретного отдела, конкретной компании по дням, журналы хранятся все отдельно. Ведется трекер событий, где можно посмотреть какой сотрудник где находился, какие действия совершал - это крайне важно.

[FanatPHP]

Svjatoslav Torn, я кстати да, вчера хотел написать, что логирование в файлы - это путь в никуда
надо сразу в БД конечно писать

[Svjatoslav Torn]

FanatPHP, а БД не загнется? представим 1000 офисов совершают по 2000 событий в день, имхо 2 млн в сутки, а держать логи надо хотя бы 3 месяца (90 млн записей - норм ваще нет) (потом архивировать и в холодное хранилище). А с файлами, достаешь столько файлов за сколько дней нужны данные, раз в месяц архивируешь то что было 4 месяца назад. Ну хз) Интересно мнение почему это дорога в некуда

[FanatPHP]

Ой не смеши пожалуйста
БД не загнется от нагрузки в 100 раз большей
Дорога в никуда потому что всю эту информацию надо показывать кому-то
или ты думаешь что тот, кому нужны эти логи, будет по твоим файлам лазить, серьёзно?

[Svjatoslav Torn]

FanatPHP, Мб БД и сделаю :) Ну на самом деле не надо лазить по файлам. Для пользователя ничего не меняется, удобный интерфейс, поиск. Все делает код, берет нужные файлы, открывает, преобразует, выводит на экран.

[10id00]

Svjatoslav Torn, файлик на 2млн строчек, это круто.