1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
|
/**
* Logback: the reliable, generic, fast and flexible logging framework.
* Copyright (C) 1999-2015, QOS.ch. All rights reserved.
*
* This program and the accompanying materials are dual-licensed under
* either the terms of the Eclipse Public License v1.0 as published by
* the Eclipse Foundation
*
* or (per the licensee's choosing)
*
* under the terms of the GNU Lesser General Public License version 2.1
* as published by the Free Software Foundation.
*/
package ch.qos.logback.access.jetty;
import java.io.File;
import java.net.URL;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import ch.qos.logback.core.status.InfoStatus;
import ch.qos.logback.core.util.FileUtil;
import ch.qos.logback.core.util.StatusPrinter;
import org.eclipse.jetty.server.Request;
import org.eclipse.jetty.server.RequestLog;
import org.eclipse.jetty.server.Response;
import ch.qos.logback.access.joran.JoranConfigurator;
import ch.qos.logback.access.spi.AccessEvent;
import ch.qos.logback.access.spi.IAccessEvent;
import ch.qos.logback.core.Appender;
import ch.qos.logback.core.ContextBase;
import ch.qos.logback.core.CoreConstants;
import ch.qos.logback.core.boolex.EventEvaluator;
import ch.qos.logback.core.filter.Filter;
import ch.qos.logback.core.joran.spi.JoranException;
import ch.qos.logback.core.spi.AppenderAttachable;
import ch.qos.logback.core.spi.AppenderAttachableImpl;
import ch.qos.logback.core.spi.FilterAttachable;
import ch.qos.logback.core.spi.FilterAttachableImpl;
import ch.qos.logback.core.spi.FilterReply;
import ch.qos.logback.core.status.ErrorStatus;
import ch.qos.logback.core.util.OptionHelper;
/**
* This class is logback's implementation of jetty's RequestLog interface. <p>
* 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. <p> To
* configure jetty in order to use RequestLogImpl, the following lines must be
* added to the jetty configuration file, namely <em>etc/jetty.xml</em>:
* <p/>
* <pre>
* <Ref id="requestLog">
* <Set name="requestLog">
* <New id="requestLogImpl" class="ch.qos.logback.access.jetty.RequestLogImpl"></New>
* </Set>
* </Ref>
* </pre>
* <p/>
* By default, RequestLogImpl looks for a logback configuration file called
* logback-access.xml, in the same folder where jetty.xml is located, that is
* <em>etc/logback-access.xml</em>. 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. <p> 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.
* <p/>
* <pre>
* <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>
* </pre>
* <p/>
* <p> Here is a sample logback-access.xml file that can be used right away:
* <p/>
* <pre>
* <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>
* </pre>
* <p/>
* <p> Another configuration file, using SMTPAppender, could be:
* <p/>
* <pre>
* <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>
* </pre>
*
* @author Ceki Gülcü
* @author Sébastien Pennec
*/
public class RequestLogImpl extends ContextBase implements RequestLog, AppenderAttachable<IAccessEvent>, FilterAttachable<IAccessEvent> {
public final static String DEFAULT_CONFIG_FILE = "etc" + File.separatorChar + "logback-access.xml";
AppenderAttachableImpl<IAccessEvent> aai = new AppenderAttachableImpl<IAccessEvent>();
FilterAttachableImpl<IAccessEvent> fai = new FilterAttachableImpl<IAccessEvent>();
String fileName;
String resource;
boolean started = false;
boolean quiet = false;
public RequestLogImpl() {
putObject(CoreConstants.EVALUATOR_MAP, new HashMap<String, EventEvaluator<?>>());
}
@Override
public void log(Request jettyRequest, Response jettyResponse) {
JettyServerAdapter adapter = new JettyServerAdapter(jettyRequest, jettyResponse);
IAccessEvent accessEvent = new AccessEvent(jettyRequest, jettyResponse, adapter);
if (getFilterChainDecision(accessEvent) == FilterReply.DENY) {
return;
}
aai.appendLoopOnAppenders(accessEvent);
}
private void addInfo(String msg) {
getStatusManager().add(new InfoStatus(msg, this));
}
private void addError(String msg) {
getStatusManager().add(new ErrorStatus(msg, this));
}
@Override
public void start() {
configure();
if (!isQuiet()) {
StatusPrinter.print(getStatusManager());
}
started = true;
}
protected void configure() {
URL configURL = getConfigurationFileURL();
if (configURL != null) {
runJoranOnFile(configURL);
} else {
addError("Could not find configuration file for logback-access");
}
}
protected URL getConfigurationFileURL() {
if (fileName != null) {
addInfo("Will use configuration file [" + fileName + "]");
File file = new File(fileName);
if (!file.exists())
return null;
return FileUtil.fileToURL(file);
}
if (resource != null) {
addInfo("Will use configuration resource [" + resource + "]");
return this.getClass().getResource(resource);
}
String jettyHomeProperty = OptionHelper.getSystemProperty("jetty.home");
String defaultConfigFile = DEFAULT_CONFIG_FILE;
if (!OptionHelper.isEmpty(jettyHomeProperty)) {
defaultConfigFile = jettyHomeProperty + File.separatorChar + DEFAULT_CONFIG_FILE;
} else {
addInfo("[jetty.home] system property not set.");
}
File file = new File(defaultConfigFile);
addInfo("Assuming default configuration file [" + defaultConfigFile + "]");
if (!file.exists())
return null;
return FileUtil.fileToURL(file);
}
private void runJoranOnFile(URL configURL) {
try {
JoranConfigurator jc = new JoranConfigurator();
jc.setContext(this);
jc.doConfigure(configURL);
if (getName() == null) {
setName("LogbackRequestLog");
}
} catch (JoranException e) {
// errors have been registered as status messages
}
}
@Override
public void stop() {
aai.detachAndStopAllAppenders();
started = false;
}
public void setFileName(String fileName) {
this.fileName = fileName;
}
public void setResource(String resource) {
this.resource = resource;
}
@Override
public boolean isStarted() {
return started;
}
public boolean isQuiet() {
return quiet;
}
public void setQuiet(boolean quiet) {
this.quiet = quiet;
}
@Override
public void addAppender(Appender<IAccessEvent> newAppender) {
aai.addAppender(newAppender);
}
@Override
public Iterator<Appender<IAccessEvent>> iteratorForAppenders() {
return aai.iteratorForAppenders();
}
@Override
public Appender<IAccessEvent> getAppender(String name) {
return aai.getAppender(name);
}
@Override
public boolean isAttached(Appender<IAccessEvent> appender) {
return aai.isAttached(appender);
}
@Override
public void detachAndStopAllAppenders() {
aai.detachAndStopAllAppenders();
}
@Override
public boolean detachAppender(Appender<IAccessEvent> appender) {
return aai.detachAppender(appender);
}
@Override
public boolean detachAppender(String name) {
return aai.detachAppender(name);
}
@Override
public void addFilter(Filter<IAccessEvent> newFilter) {
fai.addFilter(newFilter);
}
@Override
public void clearAllFilters() {
fai.clearAllFilters();
}
@Override
public List<Filter<IAccessEvent>> getCopyOfAttachedFiltersList() {
return fai.getCopyOfAttachedFiltersList();
}
@Override
public FilterReply getFilterChainDecision(IAccessEvent event) {
return fai.getFilterChainDecision(event);
}
}
|