wucdbm/mongodb-http-logger

A collection of Doctrine ODM Documents and a base Logger class implementation to log your HTTP Request/Response pairs & associated errors in a more convenient way

v0.3.1 2024-01-11 11:48 UTC

Requires

• php: >=8.1
• ext-mongodb: *
• doctrine/mongodb-odm-bundle: ^4.1
• guzzlehttp/guzzle: >=7.0
• psr/http-message: ^1.0.1
• symfony/error-handler: ~4.4|~5.0
• symfony/http-foundation: ~4.4|~5.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.8
• wucdbm/php-cs-fixers: ~0.2

MIT

• Martin Kirilov

• wucdbm
• http logger
• http request response log
• http log bundle
• symfony http log

README

• composer require doctrine/mongodb-odm-bundle

doctrine_mongodb:
    connections:
        default:
            server: "mongodb://localhost:27017"
            options: {}
    default_database: someDB
    document_managers:
        default:
            auto_mapping: true
            mappings:
                # ...
                wucdbm_http_logger:
                    type: annotation
                    dir: "%kernel.project_dir%/vendor/wucdbm/http-logger/src/Document"
                    prefix: Wucdbm\Component\MongoDBHttpLogger\Document\

Create a Document

<?php

namespace App\Document;

use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
use Wucdbm\Component\MongoDBHttpLogger\Document\Log;

/**
 * @ODM\Document(collection="some_collection")
 */
class SomeLog extends Log {

    // Feel free to add any custom fields

}

Create a logger

<?php

namespace App\Logger;

use App\Document\SomeLog;
use Doctrine\Bundle\MongoDBBundle\ManagerRegistry;
use Wucdbm\Component\MongoDBHttpLogger\Logger\Logger;

class SomeLogger extends Logger {

    public function __construct(ManagerRegistry $registry) {
        parent::__construct($registry, SomeLog::class);
    }

}

Example

<?php

/** @var \Wucdbm\Component\MongoDBHttpLogger\Logger\Logger $logger */
$logger = $this->container->get(SomeLogger::class);
$log = new \Wucdbm\Component\MongoDBHttpLogger\Document\Log();
$log->setExtraData('whatever');

try {
    $client = new \GuzzleHttp\Client();
    $request = new \GuzzleHttp\Psr7\Request('GET', 'http://some-website.com/');

    $logger->logRequest($log, $request, \Wucdbm\Component\MongoDBHttpLogger\Document\HttpMessage::ID_TEXT_PLAIN);
    // Logs are not saved automatically. You can override logRequest, response and Exception methods and implement it yourself.
    $logger->save($log);

    $response = $client->send($request);

    $logger->logResponse($log, $response, \Wucdbm\Component\MongoDBHttpLogger\Document\HttpMessage::ID_HTML);
    $logger->save($log);

    $ex = new \Exception('First Exception');

    throw new \Exception('Second Exception', 0, $ex);
} catch (\Throwable $e) {
    $logger->logException($log, $e);
    $logger->save($log);
}

Guzzle Middleware

class MiddlewareFactory {
    /** @var \ArrayIterator|\Wucdbm\Component\MongoDBHttpLogger\Document\Log[] */
    private $logCollection;

    /** @var \Wucdbm\Component\MongoDBHttpLogger\Logger\Logger */
    private $logger;

    public function createSearchLogger() {
        return function (callable $handler) {
            return function (
                \Psr\Http\Message\RequestInterface $request,
                array $options
            ) use ($handler) {
                $log = new \Wucdbm\Component\MongoDBHttpLogger\Document\Log();
                // Those may be your extra fields
    //                $log->setMethod($options['method']);
    //                $log->setSomeFieldId($this->someUnrelatedEntity->getId());
                $this->logCollection->append($log);
    
                $this->logger->logRequest(
                    $log, $request,
                    $options['requestMessageType'] ?? \Wucdbm\Component\MongoDBHttpLogger\Document\HttpMessage::ID_TEXT_PLAIN
                );
    
                /** @var \GuzzleHttp\Promise\PromiseInterface $promise */
                $promise = $handler($request, $options);
    
                return $promise->then(
                    function (\Psr\Http\Message\ResponseInterface $response) use ($log, $options) {
                        $this->logger->logResponse(
                            $log, $response,
                            $options['responseMessageType'] ?? \Wucdbm\Component\MongoDBHttpLogger\Document\HttpMessage::ID_TEXT_PLAIN
                        );
    
                        return $response;
                    }
                )->otherwise(function ($e) use ($log, $options) {
                    if ($e instanceof \GuzzleHttp\Exception\RequestException) {
                        $response = $e->getResponse();
    
                        if ($response) {
                            $this->logger->logResponse(
                                $log, $response,
                                $options['responseMessageType'] ?? \Wucdbm\Component\MongoDBHttpLogger\Document\HttpMessage::ID_TEXT_PLAIN
                            );
                        }
                    }
    
                    $this->logger->logException($log, $e);
    
                    throw $e;
                });
            };
        };
    }
}