README

Installation

App

php artisan vendor:publish --tag=slogger-laravel

ENV

# slogger
SLOGGER_ENABLED=false

SLOGGER_TOKEN=

## slogger.dispatcher
# one of: queue,transporter,file
SLOGGER_DISPATCHER=queue

## slogger.dispatcher.queue
SLOGGER_DISPATCHER_QUEUE_CONNECTION=${QUEUE_CONNECTION}
SLOGGER_DISPATCHER_QUEUE_NAME=slogger
SLOGGER_DISPATCHER_QUEUE_WORKERS_COUNT=3
# http, grpc (required slogger/grpc)
SLOGGER_DISPATCHER_QUEUE_API_CLIENT=http
SLOGGER_DISPATCHER_QUEUE_HTTP_CLIENT_URL=http://0.0.0.0:0001
SLOGGER_DISPATCHER_QUEUE_GRPC_CLIENT_URL=0.0.0.0:0002

## slogger.dispatcher.transporter
SLOGGER_DISPATCHER_TRANSPORTER_QUEUE_CONNECTION=${QUEUE_CONNECTION}
SLOGGER_DISPATCHER_TRANSPORTER_QUEUE_NAME=slogger-transporter
## slogger.dispatcher.transporter.bim
SLOGGER_DISPATCHER_TRANSPORTER_GRPC_PORT=
SLOGGER_DISPATCHER_TRANSPORTER_LOG_DIR=storage/logs/slogger/transporter
SLOGGER_DISPATCHER_TRANSPORTER_LOG_LEVELS=any
SLOGGER_DISPATCHER_TRANSPORTER_LOG_KEEP_DAYS=3
SLOGGER_DISPATCHER_TRANSPORTER_SLOGGER_SERVER_GRPC_URL=0.0.0.0:0002
SLOGGER_DISPATCHER_TRANSPORTER_RABBITMQ_USER=root
SLOGGER_DISPATCHER_TRANSPORTER_RABBITMQ_PASSWORD=
SLOGGER_DISPATCHER_TRANSPORTER_RABBITMQ_HOST=
SLOGGER_DISPATCHER_TRANSPORTER_RABBITMQ_PORT=
SLOGGER_DISPATCHER_TRANSPORTER_TRACE_TRANSPORTER_QUEUE_NAME=slogger-transporter
SLOGGER_DISPATCHER_TRANSPORTER_TRACE_TRANSPORTER_QUEUE_WORKERS_NUM=10

## slogger.logging
SLOGGER_LOG_CHANNEL=daily

## slogger.profiling
SLOGGER_PROFILING_ENABLED=true

SLOGGER_REQUESTS_HEADER_PARENT_TRACE_ID_KEY=x-parent-trace-id

## slogger.watchers
SLOGGER_LOG_REQUESTS_ENABLED=true
SLOGGER_LOG_COMMANDS_ENABLED=true
SLOGGER_LOG_DATABASE_ENABLED=true
SLOGGER_LOG_LOG_ENABLED=true
SLOGGER_LOG_SCHEDULE_ENABLED=true
SLOGGER_LOG_JOBS_ENABLED=true
SLOGGER_LOG_MODEL_ENABLED=true
SLOGGER_LOG_GATE_ENABLED=true
SLOGGER_LOG_EVENT_ENABLED=true
SLOGGER_LOG_MAIL_ENABLED=true
SLOGGER_LOG_NOTIFICATION_ENABLED=true
SLOGGER_LOG_CACHE_ENABLED=true
SLOGGER_LOG_DUMP_ENABLED=true
SLOGGER_LOG_HTTP_ENABLED=true

Requests (env.SLOGGER_LOG_REQUESTS_ENABLED)

For requests watcher you can use the middleware

\SLoggerLaravel\Middleware\HttpMiddleware::class

Guzzle (env.SLOGGER_LOG_HTTP_ENABLED)

For guzzle requests you can use the factory

new \GuzzleHttp\Client([
    'base_uri' => 'https://url.com',
    'handler'  => app(\SLoggerLaravel\Guzzle\GuzzleHandlerFactory::class)->prepareHandler(
        (new \SLoggerLaravel\RequestPreparer\RequestDataFormatters())
            ->add(
                new \SLoggerLaravel\RequestPreparer\RequestDataFormatter(
                    urlPatterns: ['*'],
                    requestHeaders: [
                        'authorization',
                    ]
                )
            )
            ->add(
                new \SLoggerLaravel\RequestPreparer\RequestDataFormatter(
                    urlPatterns: [
                        '/api/auth/*',
                        '*sensitive/some/*',
                    ],
                    hideAllResponseData: true
                )
            )
    ),
])

Dispatcher of traces

For the dispatcher usage you have to set env.SLOGGER_DISPATCHER_* according to the selected dispatcher (env.SLOGGER_DISPATCHER)

php artisan slogger:dispatcher:start

queue

The queue dispatcher works like the Horizon (master and children processes of queue:work command).

transporter

The binary is downloaded from the repository and launched (only for RabbitMQ). Push jobs to the queue and the transporter will process them.

Repository: https://github.com/sprust/slogger-transporter

Commands

load bin file

php artisan slogger:transporter:load

start transporter (for example, for supervisor)

php artisan slogger:transporter:start

stop transporter

php artisan slogger:transporter:stop

.gitignore

strans*
.env.strans.*
storage/slogger-dispatcher-state*

Profiling

bash

pecl install xhprof

php.ini

[xhprof]
extension=xhprof.so

Set env.SLOGGER_PROFILING_ENABLED -> true