public class RequestLogImpl extends ContextBase implements org.eclipse.jetty.server.RequestLog, AppenderAttachable<IAccessEvent>, FilterAttachable<IAccessEvent>
It can be seen as logback classic's LoggerContext. Appenders can be attached directly to RequestLogImpl and RequestLogImpl uses the same StatusManager as LoggerContext does. It also provides containers for properties.
To configure jetty in order to use RequestLogImpl, the following lines must be added to the jetty configuration file, namely etc/jetty.xml:
<Ref id="requestLog"> <Set name="requestLog"> <New id="requestLogImpl" class="ch.qos.logback.access.jetty.RequestLogImpl"></New> </Set> </Ref>By default, RequestLogImpl looks for a logback configuration file called logback-access.xml, in the same folder where jetty.xml is located, that is etc/logback-access.xml. The logback-access.xml file is slightly different than the usual logback classic configuration file. Most of it is the same: Appenders and Layouts are declared the exact same way. However, loggers elements are not allowed.
It is possible to put the logback configuration file anywhere, as long as it's path is specified. Here is another example, with a path to the logback-access.xml file.
<Ref id="requestLog"> <Set name="requestLog"> <New id="requestLogImpl" class="ch.qos.logback.access.jetty.RequestLogImpl"></New> <Set name="fileName">path/to/logback.xml</Set> </Set> </Ref>
Here is a sample logback-access.xml file that can be used right away:
<configuration> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <layout class="ch.qos.logback.access.PatternLayout"> <param name="Pattern" value="%date %server %remoteIP %clientHost %user %requestURL" /> </layout> </appender> <appender-ref ref="STDOUT" /> </configuration>
Another configuration file, using SMTPAppender, could be:
<configuration> <appender name="SMTP" class="ch.qos.logback.access.net.SMTPAppender"> <layout class="ch.qos.logback.access.PatternLayout"> <param name="pattern" value="%remoteIP [%date] %requestURL %statusCode %bytesSent" /> </layout> <param name="From" value="sender@domaine.org" /> <param name="SMTPHost" value="mail.domain.org" /> <param name="Subject" value="Last Event: %statusCode %requestURL" /> <param name="To" value="server_admin@domain.org" /> </appender> <appender-ref ref="SMTP" /> </configuration>
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_CONFIG_FILE |
scheduledFutures
Constructor and Description |
---|
RequestLogImpl() |
Modifier and Type | Method and Description |
---|---|
void |
addAppender(Appender<IAccessEvent> newAppender)
Add an appender.
|
void |
addFilter(Filter<IAccessEvent> newFilter)
Add a filter.
|
void |
clearAllFilters() |
protected void |
configure() |
void |
detachAndStopAllAppenders()
Detach and processPriorToRemoval all previously added appenders.
|
boolean |
detachAppender(Appender<IAccessEvent> appender)
Detach the appender passed as parameter from the list of appenders.
|
boolean |
detachAppender(String name)
Detach the appender with the name passed as parameter from the list of
appenders.
|
Appender<IAccessEvent> |
getAppender(String name)
Get an appender by name.
|
protected URL |
getConfigurationFileURL() |
List<Filter<IAccessEvent>> |
getCopyOfAttachedFiltersList()
Get a copy of all the filters contained within this FilterAttachable
object.
|
FilterReply |
getFilterChainDecision(IAccessEvent event)
Loop through the filters in the chain.
|
boolean |
isAttached(Appender<IAccessEvent> appender)
Returns
true if the specified appender is in list of
attached attached, false otherwise. |
boolean |
isQuiet() |
boolean |
isStarted() |
Iterator<Appender<IAccessEvent>> |
iteratorForAppenders()
Get an iterator for appenders contained in the parent object.
|
void |
log(org.eclipse.jetty.server.Request request,
int status,
long written) |
void |
log(org.eclipse.jetty.server.Request jettyRequest,
org.eclipse.jetty.server.Response jettyResponse) |
void |
setFileName(String fileName) |
void |
setQuiet(boolean quiet) |
void |
setResource(String resource) |
void |
start() |
void |
stop() |
addScheduledFuture, getBirthTime, getConfigurationLock, getCopyOfPropertyMap, getExecutorService, getName, getObject, getProperty, getScheduledExecutorService, getScheduledFutures, getStatusManager, initCollisionMaps, putObject, putProperty, register, removeObject, reset, setName, setStatusManager, toString
public static final String DEFAULT_CONFIG_FILE
public void log(org.eclipse.jetty.server.Request jettyRequest, org.eclipse.jetty.server.Response jettyResponse)
log
in interface org.eclipse.jetty.server.RequestLog
public void start()
start
in interface LifeCycle
start
in class ContextBase
protected void configure()
protected URL getConfigurationFileURL()
public void stop()
stop
in interface LifeCycle
stop
in class ContextBase
public void setFileName(String fileName)
public void setResource(String resource)
public boolean isStarted()
isStarted
in interface LifeCycle
isStarted
in class ContextBase
public boolean isQuiet()
public void setQuiet(boolean quiet)
public void addAppender(Appender<IAccessEvent> newAppender)
AppenderAttachable
addAppender
in interface AppenderAttachable<IAccessEvent>
public Iterator<Appender<IAccessEvent>> iteratorForAppenders()
AppenderAttachable
iteratorForAppenders
in interface AppenderAttachable<IAccessEvent>
public Appender<IAccessEvent> getAppender(String name)
AppenderAttachable
getAppender
in interface AppenderAttachable<IAccessEvent>
public boolean isAttached(Appender<IAccessEvent> appender)
AppenderAttachable
true
if the specified appender is in list of
attached attached, false
otherwise.isAttached
in interface AppenderAttachable<IAccessEvent>
public void detachAndStopAllAppenders()
AppenderAttachable
detachAndStopAllAppenders
in interface AppenderAttachable<IAccessEvent>
public boolean detachAppender(Appender<IAccessEvent> appender)
AppenderAttachable
detachAppender
in interface AppenderAttachable<IAccessEvent>
public boolean detachAppender(String name)
AppenderAttachable
detachAppender
in interface AppenderAttachable<IAccessEvent>
public void addFilter(Filter<IAccessEvent> newFilter)
FilterAttachable
addFilter
in interface FilterAttachable<IAccessEvent>
public void clearAllFilters()
clearAllFilters
in interface FilterAttachable<IAccessEvent>
public List<Filter<IAccessEvent>> getCopyOfAttachedFiltersList()
FilterAttachable
getCopyOfAttachedFiltersList
in interface FilterAttachable<IAccessEvent>
public FilterReply getFilterChainDecision(IAccessEvent event)
FilterAttachable
getFilterChainDecision
in interface FilterAttachable<IAccessEvent>
public void log(org.eclipse.jetty.server.Request request, int status, long written)
Copyright © 2005–2016 QOS.ch. All rights reserved.