Repository files navigation

Middleware to generate access logs for each request using theApache's access log format. This middleware requires aPsr log implementation, for examplemonolog.

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

This package is installable and autoloadable via Composer asmiddlewares/access-log.

composer require middlewares/access-log

useMonolog\Logger;useMonolog\Handler\StreamHandler;//Create the logger$logger =newLogger('access');$logger->pushHandler(newStreamHandler(fopen('/access-log.txt','r+')));$dispatcher =newDispatcher([newMiddlewares\AccessLog($logger)]);$response =$dispatcher->dispatch(newServerRequest());

This middleware usesPSR-3 logger standard to store the logs, so you need to pass aPsr\Log\LoggerInterface instance to the constructor.

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:

• 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

useMiddlewares\AccessLog;$format = AccessLog::FORMAT_COMMON_VHOST;$accessLog = (newAccessLog($logger))->format($format);

By default uses theREMOTE_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 exampleclient-ip:

Dispatcher::run([//detect the client ip and save it in "ip" attribute    (newMiddlewares\ClientIP())->attribute('ip'),//use that attribute    (newMiddlewares\AccessLog($logger))->ipAttribute('ip')]);

Enable thehostnameLookups flag used to get the remote hostname (%h). By default isfalse.

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:

$dispatcher =newDispatcher([//detect the client ip and save it in ip attribute    (newMiddlewares\ClientIP())->attribute('ip'),// Add UUID for the request so we can trace logs later in case somethings goes wrongnewMiddlewares\Uuid(),// Use the data from the other two middleware and use it as context for logging    (newMiddlewares\AccessLog($logger))        ->context(function (ServerRequestInterface$request,ResponseInterface$response) {return ['request-id' =>$request->getHeaderLine('X-Uuid'),'client-ip' =>$request->getAttribute('ip'),            ];        })]);

The format string tries to mimic the directives described in Apache Httpd serverdocumentation.

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:

The following Apache Httpd server directives are not implemented in this middleware:

Please seeCHANGELOG for more information about recent changes andCONTRIBUTING for contributing details.

The MIT License (MIT). Please seeLICENSE for more information.