iapotheca/log-processor

Log Processor for Courier Network

0.0.8 2022-09-12 17:57 UTC

Requires

• monolog/monolog: ^2.7
• php-amqplib/php-amqplib: ^3.1

Requires (Dev)

• mockery/mockery: ^1.5
• phpunit/phpunit: ^9.5

proprietary

• Savio Resende

README

This is a monolog log processor that prepares data intended to go to RabbitMQ to be observed by Logstash ingestion to persist metadata existent in the log message.

This package parses data from the log message into RabbitMQ plain fields. E.g: the following message will be converted to the data structure after:

Message: [KEY value] My message here

Data: {key: "value", message: "[KEY value] My message here"}

Installation

Step 1

Install dependencies and this package:

composer require php-amqplib/php-amqplib iapotheca/log-processor

Step 2

Install a RabbitMQ driver into your laravel instance by adding this to your config/logging:

// ...
use App\Logging\RabbitmqLogger;
//...
    'rabbitmq' => [
        'driver' => 'custom',
        'via' => RabbitmqLogger::class, // <-- this is your custom logger
        'exchange-name' => env('LOG_RABBITMQ_EXCHANGE_NAME', 'logs'),
        'host' => env('LOG_RABBITMQ_HOST', 'localhost'),
        'port' => env('LOG_RABBITMQ_PORT', 5672),
        'user' => env('LOG_RABBITMQ_USER', 'guest'),
        'password' => env('LOG_RABBITMQ_PASSWORD', 'password'),
        'log-name' => env('LOG_RABBITMQ_LOG_NAME', 'logstash'),
    ],
//...

Step 3

Implement your Custom Logger where you use this Processor:

File: app/Logging/RabbitmqLogger.php

<?php

namespace App\Logging;

use Iapotheca\LogProcessor\Processor;
use Monolog\Logger;
use PhpAmqpLib\Connection\AMQPSocketConnection;
use PhpAmqpLib\Channel\AMQPChannel;
use Monolog\Handler\AmqpHandler;

class RabbitmqLogger
{
    public function __invoke(array $config)
    {
        $connection = new AMQPSocketConnection(
            $config['host'],
            $config['port'],
            $config['user'],
            $config['password']
        );
        $channel = new AMQPChannel($connection);
        $logger = new Logger($config['log-name']);
        $handler = new AmqpHandler($channel, $config['exchange-name']);
        $handler->pushProcessor(new Processor(config('app.name'), [
            // these are the observed keys within the log message
            'KEY_ONE', 'KEY_TWO'
        ]));
        $logger->pushHandler($handler);
        return $logger;
    }
}

Extras

Special Characters in the fields

The Processor class accepts 4 parameters: $appName, $keys, $preProcessingCallback and $extraSpecialCharacters. The 4th parameter is for any special character that your value might need to accept.

The following example will accept @ characters:

new Processor(
    appName: 'my-app',
    keys: ['SOME_FIELD'],
    preProcessingCallback: null,
    extraSpecialCharacters: ['@']
)