Difference between revisions of "Jetty/Tutorial/RequestLog"

From Eclipsepedia

Jump to: navigation, search
Line 27: Line 27:
 
<source lang="xml">
 
<source lang="xml">
 
<Set name="handler">
 
<Set name="handler">
   <New id="Handlers" class="org.mortbay.jetty.handler.HandlerCollection">
+
   <New id="Handlers" class="org.eclipse.jetty.server.handler.HandlerCollection">
 
     <Set name="handlers">
 
     <Set name="handlers">
       <Array type="org.mortbay.jetty.Handler">
+
       <Array type="org.eclipse.jetty.server.Handler">
 
         <Item>
 
         <Item>
           <New id="Contexts" class="org.mortbay.jetty.handler.ContextHandlerCollection"/>
+
           <New id="Contexts" class="org.eclipse.jetty.server.handler.ContextHandlerCollection"/>
 
         </Item>
 
         </Item>
 
         <Item>
 
         <Item>
           <New id="DefaultHandler" class="org.mortbay.jetty.handler.DefaultHandler"/>
+
           <New id="DefaultHandler" class="org.eclipse.jetty.server.handler.DefaultHandler"/>
 
         </Item>
 
         </Item>
 
         <Item>
 
         <Item>
           <New id="RequestLog" class="org.mortbay.jetty.handler.RequestLogHandler"/>
+
           <New id="RequestLog" class="org.eclipse.jetty.server.handler.RequestLogHandler"/>
 
         </Item>
 
         </Item>
 
       </Array>
 
       </Array>
Line 45: Line 45:
 
<Ref id="RequestLog">
 
<Ref id="RequestLog">
 
   <Set name="requestLog">
 
   <Set name="requestLog">
     <New id="RequestLogImpl" class="org.mortbay.jetty.NCSARequestLog">
+
     <New id="RequestLogImpl" class="org.eclipse.jetty.server.NCSARequestLog">
 
       <Arg><SystemProperty name="jetty.logs" default="./logs"/>/yyyy_mm_dd.request.log</Arg>
 
       <Arg><SystemProperty name="jetty.logs" default="./logs"/>/yyyy_mm_dd.request.log</Arg>
 
       <Set name="retainDays">90</Set>
 
       <Set name="retainDays">90</Set>

Revision as of 10:51, 4 June 2010



Contents

Introduction

Request logs are a record of the requests that the server has processed. There is one entry per request received, and commonly in the standard NCSA format so they can be conveniently analysed by tools like webalizer.

Details

Request Log Entry

A standard request log entry includes the client IP, date, method, URL, result, size, referrer and user agent. eg:

 123.4.5.6 - - [27/Aug/2004:10:16:17 +0000]
  "GET /jetty/tut/XmlConfiguration.html HTTP/1.1"
  200 76793 "http://localhost:8080/jetty/tut/logging.html"
  "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.6) Gecko/20040614 Firefox/0.8"

Implementations

Jetty provides an implementation called NCSARequestLog which supports the NCSA format in files that can be rolled over on a daily basis.

The logback project offers another implementation of RequestLog interface providing very rich and powerful HTTP-access log functionality,

Alternatively, if neither of these options suits you, you can implement a custom request logger by implementing Jetty's RequestLog.java interface and plugging it in in similar fashion to the NCSARequestLog, as shown below.

Configuring Request Log

To configure a single request log for the entire Jetty Server instance:

<Set name="handler">
  <New id="Handlers" class="org.eclipse.jetty.server.handler.HandlerCollection">
    <Set name="handlers">
      <Array type="org.eclipse.jetty.server.Handler">
        <Item>
          <New id="Contexts" class="org.eclipse.jetty.server.handler.ContextHandlerCollection"/>
        </Item>
        <Item>
          <New id="DefaultHandler" class="org.eclipse.jetty.server.handler.DefaultHandler"/>
        </Item>
        <Item>
          <New id="RequestLog" class="org.eclipse.jetty.server.handler.RequestLogHandler"/>
        </Item>
      </Array>
    </Set>
  </New>
</Set>
<Ref id="RequestLog">
  <Set name="requestLog">
    <New id="RequestLogImpl" class="org.eclipse.jetty.server.NCSARequestLog">
      <Arg><SystemProperty name="jetty.logs" default="./logs"/>/yyyy_mm_dd.request.log</Arg>
      <Set name="retainDays">90</Set>
      <Set name="append">true</Set>
      <Set name="extended">false</Set>
      <Set name="LogTimeZone">GMT</Set>
    </New>
  </Set>
</Ref>

The equivalent code is:

HandlerCollection handlers = new HandlerCollection();
ContextHandlerCollection contexts = new ContextHandlerCollection();
RequestLogHandler requestLogHandler = new RequestLogHandler();
handlers.setHandlers(new Handler[]{contexts,new DefaultHandler(),requestLogHandler});
server.setHandler(handlers);
 
NCSARequestLog requestLog = new NCSARequestLog("./logs/jetty-yyyy_mm_dd.request.log");
requestLog.setRetainDays(90);
requestLog.setAppend(true);
requestLog.setExtended(false);
requestLog.setLogTimeZone("GMT");
requestLogHandler.setRequestLog(requestLog);

This configures a request log in $JETTY_HOME/logs with filenames including the date. Old log files are kept for 90 days before being deleted. Existing log files are appended to and the extended NCSA format is used in the GMT timezone.

There are many more configuration options available - see NCSARequestLog.java

Additional Resources

Configuring An Individual Log Per Webapp

<Configure class="org.eclipse.jetty.webapp.WebAppContext">
  ...
  <Call name="addHandler">
    <Arg>
      <New class="org.eclipse.jetty.server.handler.RequestLogHandler">
        <Set name="requestLog">
          <New id="RequestLogImpl" class="org.eclipse.jetty.server.NCSARequestLog">
            <Arg><SystemProperty name="jetty.logs" default="./logs"/>/yyyy_mm_dd.test.request.log</Arg>
            <Set name="retainDays">90</Set>
            <Set name="append">true</Set>
            <Set name="extended">false</Set>
            <Set name="LogTimeZone">GMT</Set>
          </New>
        </Set>
      </New>
    </Arg>
  </Call>
  ...
</Configure>