middlewares/access-log

Middleware to generate access logs

middlewares/access-log

![Software License][ico-license] ![Total Downloads][ico-downloads], _(*1)

Middleware to generate access logs for each request using the Apache's access log format. This middleware requires a Psr log implementation, for example monolog., _(*2)

Requirements

• PHP >= 7.2
• A PSR-7 http library
• A PSR-15 middleware dispatcher
• A PSR-3 logger

Installation

This package is installable and autoloadable via Composer as middlewares/access-log., _(*3)

composer require middlewares/access-log

Example

use Monolog\Logger;
use Monolog\Handler\StreamHandler;

//Create the logger
$logger = new Logger('access');
$logger->pushHandler(new StreamHandler(fopen('/access-log.txt', 'r+')));

$dispatcher = new Dispatcher([
    new Middlewares\AccessLog($logger)
]);

$response = $dispatcher->dispatch(new ServerRequest());

Usage

This middleware uses PSR-3 logger standard to store the logs, so you need to pass a Psr\Log\LoggerInterface instance to the constructor., _(*4)

format

This option allows to define the format used to save the log messages. You can create your own format (More info about the available options) ou use one of the following constants provided with predefined formats:, _(*5)

• AccessLog::FORMAT_COMMON (Used by default)
• AccessLog::FORMAT_COMMON_VHOST
• AccessLog::FORMAT_COMBINED
• AccessLog::FORMAT_REFERER
• AccessLog::FORMAT_AGENT
• AccessLog::FORMAT_VHOST
• AccessLog::FORMAT_COMMON_DEBIAN
• AccessLog::FORMAT_COMBINED_DEBIAN
• AccessLog::FORMAT_VHOST_COMBINED_DEBIAN

use Middlewares\AccessLog;

$format = AccessLog::FORMAT_COMMON_VHOST;

$accessLog = (new AccessLog($logger))->format($format);

ipAttribute

By default uses the REMOTE_ADDR server parameter to get the client ip. This option allows to use a request attribute. Useful to combine with any ip detection middleware, for example client-ip:, _(*6)

Dispatcher::run([
    //detect the client ip and save it in "ip" attribute
    (new Middlewares\ClientIP())->attribute('ip'),

    //use that attribute
    (new Middlewares\AccessLog($logger))->ipAttribute('ip')
]);

hostnameLookups

Enable the hostnameLookups flag used to get the remote hostname (%h). By default is false., _(*7)

context

By default there is no context passed into the logger. When setting this context callable it will be called each time an request is logged with both the request and response. Letting you set context to the log entry:, _(*8)

$dispatcher = new Dispatcher([
    //detect the client ip and save it in ip attribute
    (new Middlewares\ClientIP())->attribute('ip'),

    // Add UUID for the request so we can trace logs later in case somethings goes wrong
    new Middlewares\Uuid(),

    // Use the data from the other two middleware and use it as context for logging
    (new Middlewares\AccessLog($logger))
        ->context(function (ServerRequestInterface $request, ResponseInterface $response) {
            return [
                'request-id' => $request->getHeaderLine('X-Uuid'),
                'client-ip' => $request->getAttribute('ip'),
            ];
        })
]);

Custom format string

The format string tries to mimic the directives described in Apache Httpd server documentation., _(*9)

A custom format can be defined by placing "%" directives in the format string, which are replaced in the log file by the values as follows:, _(*10)

The following Apache Httpd server directives are not implemented in this middleware:, _(*11)

Please see CHANGELOG for more information about recent changes and CONTRIBUTING for contributing details., _(*12)

The MIT License (MIT). Please see LICENSE for more information., _(*13)