Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Jetty/Howto/Configure Request Logs"

< Jetty‎ | Howto
(New page: {{Jetty Howto | 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 [http://hoohoo...)
 
m
Line 1: Line 1:
−
{{Jetty Howto
+
{Jetty Howto
 
| 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 [http://hoohoo.ncsa.uiuc.edu/docs/setup/httpd/LogOptions.html NCSA format], so you can  conveniently analyze these logs using tools such as [http://www.mrunix.net/webalizer/ webalizer].
 
| 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 [http://hoohoo.ncsa.uiuc.edu/docs/setup/httpd/LogOptions.html NCSA format], so you can  conveniently analyze these logs using tools such as [http://www.mrunix.net/webalizer/ webalizer].
  
Line 25: Line 25:
 
<div class="code panel" style="border-width: 1px"><div class="codeContent panelContent">
 
<div class="code panel" style="border-width: 1px"><div class="codeContent panelContent">
  
−
  <span class="code-tag"><Set name=<span class="code-quote">"handler"</span>></span>
+
  <Set name="handler">
−
       <span class="code-tag"><New id=<span class="code-quote">"Handlers"</span> class=<span class="code-quote">"org.mortbay.jetty.handler.HandlerCollection"</span>></span>
+
       <New id="Handlers" class="org.mortbay.jetty.handler.HandlerCollection">
−
         <span class="code-tag"><Set name=<span class="code-quote">"handlers"</span>></span>
+
         <Set name="handlers">
−
           <span class="code-tag"><Array type=<span class="code-quote">"org.mortbay.jetty.Handler"</span>></span>
+
           <Array type="org.mortbay.jetty.Handler">
−
             <span class="code-tag"><Item></span>
+
             <Item>
−
               <span class="code-tag"><New id=<span class="code-quote">"Contexts"</span> class=<span class="code-quote">"org.mortbay.jetty.handler.ContextHandlerCollection"</span>/></span>
+
               <New id="Contexts" class="org.mortbay.jetty.handler.ContextHandlerCollection"/>
−
             <span class="code-tag"></Item></span>
+
             </Item>
−
             <span class="code-tag"><Item></span>
+
             <Item>
−
               <span class="code-tag"><New id=<span class="code-quote">"DefaultHandler"</span> class=<span class="code-quote">"org.mortbay.jetty.handler.DefaultHandler"</span>/></span>
+
               <New id="DefaultHandler" class="org.mortbay.jetty.handler.DefaultHandler"/>
−
             <span class="code-tag"></Item></span>
+
             </Item>
−
             <span class="code-tag"><Item></span>
+
             <Item>
−
               <span class="code-tag"><New id=<span class="code-quote">"RequestLog"</span> class=<span class="code-quote">"org.mortbay.jetty.handler.RequestLogHandler"</span>/></span>
+
               <New id="RequestLog" class="org.mortbay.jetty.handler.RequestLogHandler"/>
−
             <span class="code-tag"></Item></span>
+
             </Item>
−
           <span class="code-tag"></Array></span>
+
           </Array>
−
         <span class="code-tag"></Set></span>
+
         </Set>
−
       <span class="code-tag"></New></span>
+
       </New>
−
     <span class="code-tag"></Set></span>
+
     </Set>
 
   
 
   
 
   
 
   
−
     <span class="code-tag"><Ref id=<span class="code-quote">"RequestLog"</span>></span>
+
     <Ref id="RequestLog">
−
       <span class="code-tag"><Set name=<span class="code-quote">"requestLog"</span>></span>
+
       <Set name="requestLog">
−
         <span class="code-tag"><New id=<span class="code-quote">"RequestLogImpl"</span> class=<span class="code-quote">"org.mortbay.jetty.NCSARequestLog"</span>></span>
+
         <New id="RequestLogImpl" class="org.mortbay.jetty.NCSARequestLog">
−
           <span class="code-tag"><Arg></span><span class="code-tag"><SystemProperty name=<span class="code-quote">"jetty.logs"</span> default=<span class="code-quote">"./logs"</span>/></span>/yyyy_mm_dd.request.log<span class="code-tag"></Arg></span>
+
           <Arg><SystemProperty name="jetty.logs" default="./logs"/>/yyyy_mm_dd.request.log</Arg>
−
           <span class="code-tag"><Set name=<span class="code-quote">"retainDays"</span>></span>90<span class="code-tag"></Set></span>
+
           <Set name="retainDays">90</Set>
−
           <span class="code-tag"><Set name=<span class="code-quote">"append"</span>></span>true<span class="code-tag"></Set></span>
+
           <Set name="append">true</Set>
−
           <span class="code-tag"><Set name=<span class="code-quote">"extended"</span>></span>false<span class="code-tag"></Set></span>
+
           <Set name="extended">false</Set>
−
           <span class="code-tag"><Set name=<span class="code-quote">"LogTimeZone"</span>></span>GMT<span class="code-tag"></Set></span>
+
           <Set name="LogTimeZone">GMT</Set>
−
         <span class="code-tag"></New></span>
+
         </New>
−
       <span class="code-tag"></Set></span>
+
       </Set>
−
     <span class="code-tag"></Ref></span>
+
     </Ref>
  
 
</div></div>
 
</div></div>
Line 62: Line 62:
 
<div class="code panel" style="border-width: 1px"><div class="codeContent panelContent">
 
<div class="code panel" style="border-width: 1px"><div class="codeContent panelContent">
  
−
  HandlerCollection handlers = <span class="code-keyword">new</span> HandlerCollection();
+
  HandlerCollection handlers = new HandlerCollection();
−
         ContextHandlerCollection contexts = <span class="code-keyword">new</span> ContextHandlerCollection();
+
         ContextHandlerCollection contexts = new ContextHandlerCollection();
−
         RequestLogHandler requestLogHandler = <span class="code-keyword">new</span> RequestLogHandler();
+
         RequestLogHandler requestLogHandler = new RequestLogHandler();
−
         handlers.setHandlers(<span class="code-keyword">new</span> Handler[]{contexts,<span class="code-keyword">new</span> DefaultHandler(),requestLogHandler});
+
         handlers.setHandlers(new Handler[]{contexts,new DefaultHandler(),requestLogHandler});
 
         server.setHandler(handlers);
 
         server.setHandler(handlers);
 
   
 
   
−
         NCSARequestLog requestLog = <span class="code-keyword">new</span> NCSARequestLog(<span class="code-quote">"./logs/jetty-yyyy_mm_dd.request.log"</span>);
+
         NCSARequestLog requestLog = new NCSARequestLog("./logs/jetty-yyyy_mm_dd.request.log");
 
         requestLog.setRetainDays(90);
 
         requestLog.setRetainDays(90);
−
         requestLog.setAppend(<span class="code-keyword">true</span>);
+
         requestLog.setAppend(true);
−
         requestLog.setExtended(<span class="code-keyword">false</span>);
+
         requestLog.setExtended(false);
−
         requestLog.setLogTimeZone(<span class="code-quote">"GMT"</span>);
+
         requestLog.setLogTimeZone("GMT");
 
         requestLogHandler.setRequestLog(requestLog);
 
         requestLogHandler.setRequestLog(requestLog);
  
Line 85: Line 85:
 
<div class="code panel" style="border-width: 1px"><div class="codeContent panelContent">
 
<div class="code panel" style="border-width: 1px"><div class="codeContent panelContent">
  
−
  <span class="code-tag"><Configure class=<span class="code-quote">"org.mortbay.jetty.webapp.WebAppContext"</span>></span>
+
  <Configure class="org.mortbay.jetty.webapp.WebAppContext">
 
   
 
   
 
   ...
 
   ...
 
   
 
   
−
   <span class="code-tag"><Call name=<span class="code-quote">"addHandler"</span>></span>
+
   <Call name="addHandler">
−
     <span class="code-tag"><Arg></span>
+
     <Arg>
−
     <span class="code-tag"><New class=<span class="code-quote">"org.mortbay.jetty.handler.RequestLogHandler"</span>></span>
+
     <New class="org.mortbay.jetty.handler.RequestLogHandler">
−
       <span class="code-tag"><Set name=<span class="code-quote">"requestLog"</span>></span>
+
       <Set name="requestLog">
−
         <span class="code-tag"><New id=<span class="code-quote">"RequestLogImpl"</span> class=<span class="code-quote">"org.mortbay.jetty.NCSARequestLog"</span>></span>
+
         <New id="RequestLogImpl" class="org.mortbay.jetty.NCSARequestLog">
−
           <span class="code-tag"><Arg></span><span class="code-tag"><SystemProperty name=<span class="code-quote">"jetty.logs"</span> default=<span class="code-quote">"./logs"</span>/></span>/yyyy_mm_dd.test.request.log<span class="code-tag"></Arg></span>
+
           <Arg><SystemProperty name="jetty.logs" default="./logs"/>/yyyy_mm_dd.test.request.log</Arg>
−
           <span class="code-tag"><Set name=<span class="code-quote">"retainDays"</span>></span>90<span class="code-tag"></Set></span>
+
           <Set name="retainDays">90</Set>
−
           <span class="code-tag"><Set name=<span class="code-quote">"append"</span>></span>true<span class="code-tag"></Set></span>
+
           <Set name="append">true</Set>
−
           <span class="code-tag"><Set name=<span class="code-quote">"extended"</span>></span>false<span class="code-tag"></Set></span>
+
           <Set name="extended">false</Set>
−
           <span class="code-tag"><Set name=<span class="code-quote">"LogTimeZone"</span>></span>GMT<span class="code-tag"></Set></span>
+
           <Set name="LogTimeZone">GMT</Set>
−
         <span class="code-tag"></New></span>
+
         </New>
−
       <span class="code-tag"></Set></span>
+
       </Set>
−
     <span class="code-tag"></New></span>
+
     </New>
−
     <span class="code-tag"></Arg></span>
+
     </Arg>
−
   <span class="code-tag"></Call></span>
+
   </Call>
 
   
 
   
 
   ...
 
   ...
 
   
 
   
−
  <span class="code-tag"></Configure></span>
+
  </Configure>
  
 
</div>
 
</div>

Revision as of 14:37, 26 August 2010

{Jetty Howto | 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 you can conveniently analyze these logs using tools such as webalizer.

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

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"

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,

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 a Request Log for a Jetty Server

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

<Set name="handler">
      <New id="Handlers" class="org.mortbay.jetty.handler.HandlerCollection">
        <Set name="handlers">
         <Array type="org.mortbay.jetty.Handler">
           <Item>
             <New id="Contexts" class="org.mortbay.jetty.handler.ContextHandlerCollection"/>
           </Item>
           <Item>
             <New id="DefaultHandler" class="org.mortbay.jetty.handler.DefaultHandler"/>
           </Item>
           <Item>
             <New id="RequestLog" class="org.mortbay.jetty.handler.RequestLogHandler"/>
           </Item>
         </Array>
        </Set>
      </New>
    </Set>


    Cite error: Invalid <ref> tag;

invalid names, e.g. too many

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 http://jetty.mortbay.org/apidocs/org/mortbay/jetty/NCSARequestLog.html

Configuring a Request Log per webapp

<Configure class="org.mortbay.jetty.webapp.WebAppContext">

  ...

  <Call name="addHandler">
    <Arg>
    <New class="org.mortbay.jetty.handler.RequestLogHandler">
      <Set name="requestLog">
        <New id="RequestLogImpl" class="org.mortbay.jetty.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>

| more = (optional) - links, additional references

}}
Retrieved from "https://wiki.eclipse.org/index.php?title=Jetty/Howto/Configure_Request_Logs&oldid=217244"

Back to the top