org.jooby

Class RequestLogger

java.lang.Object

org.jooby.RequestLogger

All Implemented Interfaces:

Route.Filter, Route.Handler

public class RequestLogger
extends Object
implements Route.Handler

request logger

Log all the matched incoming requested using the NCSA format (a.k.a common log format).

usage

 {
   use("*", new RequestLogger());

   ...
 }
 

Output looks like:

 127.0.0.1 - - [04/Oct/2016:17:51:42 +0000] "GET / HTTP/1.1" 200 2
 

You probably want to configure the RequestLogger logger to save output into a new file:

 <appender name="ACCESS" class="ch.qos.logback.core.rolling.RollingFileAppender">
   <file>access.log</file>
   <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
     <fileNamePattern>access.%d{yyyy-MM-dd}.log</fileNamePattern>
   </rollingPolicy>

   <encoder>
     <pattern>%msg%n</pattern>
   </encoder>
 </appender>

 <logger name="org.jooby.RequestLogger" additivity="false">
   <appender-ref ref="ACCESS" />
 </logger>
 

Due that authentication is provided via module or custom filter, there is no concept of logged/authenticated user. Still you can log the current user by setting an user id provider at construction time:

 {

   use("*", (req, rsp) -> {
     // authenticate user and set local attribute
     String userId = ...;
     req.set("userId", userId);
   });

   use("*", new RequestLogger(req -> {
     return req.get("userId");
   }));
 }
 

Here an application filter set an userId request attribute and then we provide that userId to RequestLogger.

custom log function

By default it uses the underlying logging system: logback. That's why we previously show how to configure the org.jooby.RequestLogger in logback.xml.

If you want to log somewhere else and/or use a different technology then:

 {
   use("*", new ResponseLogger()
     .log(line -> {
       System.out.println(line);
     }));
 }
 

This is just an example but of course you can log the NCSA line to database, jms queue, etc...

latency

 {
   use("*", new RequestLogger()
       .latency());
 }
 

It add a new entry at the last of the NCSA output that represents the number of ms it took to process the incoming release.

extended

Extend the NCSA by adding the Referer and User-Agent headers to the output.

dateFormatter

 {
   use("*", new RequestLogger()
       .dateFormatter(ts -> ...));

   // OR
   use("*", new RequestLogger()
       .dateFormatter(DateTimeFormatter...));
 }
 

Override, the default formatter for the request arrival time defined by: Request.timestamp(). You can provide a function or an instance of DateTimeFormatter.

The default formatter use the default server time zone, provided by ZoneId.systemDefault(). It's possible to just override the time zone (not the entirely formatter) too:

 {
   use("*", new RequestLogger()
      .dateFormatter(ZoneId.of("UTC"));
 }
 

Since:

1.0.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
RequestLogger() Creates a new RequestLogger without user identifier.
RequestLogger(Function<Request,String> userId) Creates a new RequestLogger and use the given function and userId provider.

Method Summary

Modifier and Type	Method and Description
RequestLogger	dateFormatter(DateTimeFormatter formatter) Override the default date formatter.
RequestLogger	dateFormatter(Function<Long,String> formatter) Override the default date formatter.
RequestLogger	dateFormatter(ZoneId zoneId) Keep the default formatter but use the provided timezone.
RequestLogger	extended() Append Referer and User-Agent entries to the NCSA line.
void	handle(Request req, Response rsp) Callback method for a HTTP request.
RequestLogger	latency() Log latency (how long does it takes to process an incoming request) at the end of the NCSA line.
RequestLogger	log(Consumer<String> log) Log an NCSA line to somewhere.
RequestLogger	queryString() Log full path of the request including query string.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jooby.Route.Handler

handle

Constructor Detail

RequestLogger

public RequestLogger(Function<Request,String> userId)

Creates a new RequestLogger and use the given function and userId provider. Please note, if the user isn't present this function is allowed to returns - (dash character).

Parameters:

userId - User ID provider.

RequestLogger

public RequestLogger()

Creates a new RequestLogger without user identifier.

Method Detail

handle

public void handle(Request req,
                   Response rsp)
            throws Throwable

Description copied from interface: Route.Handler

Callback method for a HTTP request.

Specified by:

handle in interface Route.Handler

Parameters:

req - A HTTP request.

rsp - A HTTP response.

Throws:

Throwable - If something goes wrong. The exception will processed by Jooby.

log

public RequestLogger log(Consumer<String> log)

Log an NCSA line to somewhere.

  {
    use("*", new RequestLogger()
        .log(System.out::println)
    );
  }
 

Parameters:

log - Log callback.

Returns:

This instance.

dateFormatter

public RequestLogger dateFormatter(DateTimeFormatter formatter)

Override the default date formatter.

Parameters:

formatter - New formatter to use.

Returns:

This instance.

dateFormatter

public RequestLogger dateFormatter(Function<Long,String> formatter)

Override the default date formatter.

Parameters:

formatter - New formatter to use.

Returns:

This instance.

dateFormatter

public RequestLogger dateFormatter(ZoneId zoneId)

Keep the default formatter but use the provided timezone.

Parameters:

zoneId - Zone id.

Returns:

This instance.

latency

public RequestLogger latency()

Log latency (how long does it takes to process an incoming request) at the end of the NCSA line.

Returns:

This instance.

queryString

public RequestLogger queryString()

Log full path of the request including query string.

Returns:

This instance.

extended

public RequestLogger extended()

Append Referer and User-Agent entries to the NCSA line.

Returns:

This instance.