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.
Difference between revisions of "Jetty/Howto/Configure Request Logs"
(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...) |
(Fixing package of NCSARequestLog) |
||
| (18 intermediate revisions by 4 users not shown) | |||
| 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, | + | | introduction = |
| + | Request logs are a record of the requests that the server has processed. There is one entry per request received, in the standard [http://www.w3.org/Daemon/User/Config/Logging.html#common-logfile-format NCSA format], so you can conveniently analyze these logs using a tool such as [http://www.mrunix.net/webalizer/ Webalizer]. | ||
| − | A standard request log entry includes the client IP address, date, method, URL, result, size, referrer and user agent | + | A standard request log entry includes the client IP address, date, method, URL, result, size, referrer and user agent. For example: |
| − | + | ||
| − | + | ||
| + | <source lang = "text"> | ||
123.4.5.6 - - [27/Aug/2004:10:16:17 +0000] | 123.4.5.6 - - [27/Aug/2004:10:16:17 +0000] | ||
"GET /jetty/tut/XmlConfiguration.html HTTP/1.1" | "GET /jetty/tut/XmlConfiguration.html HTTP/1.1" | ||
200 76793 "http://localhost:8080/jetty/tut/logging.html" | 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" | "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.6) Gecko/20040614 Firefox/0.8" | ||
| + | </source> | ||
| − | + | * Jetty provides a request log implementation called NCSARequestLog which supports the NCSA format in files that can be rolled over on a daily basis. | |
| − | + | * The [http://logback.qos.ch Logback project] offers [http://logback.qos.ch/access.html another implementation] of the RequestLog interface, providing very rich and powerful HTTP-access log functionality. | |
| − | + | * If neither of these options suits you, you can create a custom request logger by implementing Jetty's [http://download.eclipse.org/jetty/stable-7/apidocs/org/eclipse/jetty/server/NCSARequestLog.html RequestLog.java] interface and plugging it in similar to the NCSARequestLog, as shown below. | |
| − | + | ||
| − | If neither of these options suits you, you can | + | |
==Configuring a Request Log for a Jetty Server== | ==Configuring a Request Log for a Jetty Server== | ||
| − | + | The following example configures a single request log for the entire Jetty Server instance: | |
| − | < | + | <source lang = "xml"> |
| − | + | <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.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> | |
| − | + | </source> | |
| − | + | ||
The equivalent code is: | The equivalent code is: | ||
| − | < | + | <source lang = "java"> |
| + | 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); | |
| − | + | </source> | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | 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. New entries append to existing log files, and the extended NCSA format is used in the GMT timezone. | |
| − | + | Many more configuration options are available–see [http://download.eclipse.org/jetty/stable-7/apidocs/org/eclipse/jetty/server/NCSARequestLog.html RequestLog.java]. | |
| − | + | ==Configuring a Request Log per Webapp== | |
| − | + | The next example configures a request log on a per webapp basis: | |
| − | < | + | <source lang = "xml"> |
| − | + | <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> | |
| − | + | </source> | |
| − | </ | + | |
| − | + | ||
}} | }} | ||
Latest revision as of 14:44, 20 March 2013
Introduction
Request logs are a record of the requests that the server has processed. There is one entry per request received, in the standard NCSA format, so you can conveniently analyze these logs using a tool 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 a request log 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 the RequestLog interface, providing very rich and powerful HTTP-access log functionality.
- If neither of these options suits you, you can create a custom request logger by implementing Jetty's RequestLog.java interface and plugging it in similar to the NCSARequestLog, as shown below.
Configuring a Request Log for a Jetty Server
The following example configures 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.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. New entries append to existing log files, and the extended NCSA format is used in the GMT timezone.
Many more configuration options are available–see RequestLog.java.
Configuring a Request Log per Webapp
The next example configures a request log on a per webapp basis:
<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>