Plack::Middleware::TrafficLog - Log headers and body of HTTP traffic
# In app.psgi
use Plack::Builder;
builder {
enable "TrafficLog", with_body => 1;
};
This middleware logs the request and response messages with detailed information about headers and the body.
The example log:
[08/Aug/2012:16:59:47 +0200] [164836368] [127.0.0.1 -> 0:5000] [Request ]
|GET / HTTP/1.1|Connection: TE, close|Host: localhost:5000|TE: deflate,gzi
p;q=0.3|User-Agent: lwp-request/6.03 libwww-perl/6.03||
[08/Aug/2012:16:59:47 +0200] [164836368] [127.0.0.1 <- 0:5000] [Response]
|HTTP/1.0 200 OK|Content-Type: text/plain||Hello World
This module works also with applications that have delayed response. In that case, each chunk is logged separately and shares the same unique ID number and headers.
The body of the request and response is not logged by default. For streaming responses, only the first chunk is logged by default.
-
logger
Sets a callback to print log message to. It prints to
psgi.errorsoutput stream by default.
# traffic.l4p
log4perl.logger.traffic = DEBUG, LogfileTraffic
log4perl.appender.LogfileTraffic = Log::Log4perl::Appender::File
log4perl.appender.LogfileTraffic.filename = traffic.log
log4perl.appender.LogfileTraffic.layout = PatternLayout
log4perl.appender.LogfileTraffic.layout.ConversionPattern = %m{chomp}%n
# app.psgi
use Log::Log4perl qw(:levels get_logger);
Log::Log4perl->init('traffic.l4p');
my $logger = get_logger('traffic');
enable "Plack::Middleware::TrafficLog",
logger => sub { $logger->log($INFO, join '', @_) };
-
with_request
The false value disables logging of the request message.
-
with_response
The false value disables logging of the response message.
-
with_date
The false value disables logging of the current date.
-
with_body
The true value enables logging of the message's body.
-
with_all_chunks
The true value enables logging of every chunk for streaming responses.
-
eol
Sets the line separator for the message's headers and the body. The default value is the pipe character
|. -
body_eol
Sets the line separator for message's body only. The default is the space character
Plack, Plack::Middleware::AccessLog.
This module has an unstable API and it can be changed in the future.
The log file can contain binary data if the PSGI server provides binary files.
If you find the bug or want to implement new features, please report it at http://github.com/dex4er/perl-Plack-Middleware-TrafficLog/issues
The code repository is available at http://github.com/dex4er/perl-Plack-Middleware-TrafficLog
Piotr Roszatycki dexter@cpan.org
Copyright (c) 2012, 2014-2015, 2023 Piotr Roszatycki dexter@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as perl itself.