org.glassfish.grizzly.http.server.accesslog.AccessLogProbe Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2014-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.grizzly.http.server.accesslog;
import static java.util.logging.Level.WARNING;
import java.util.Date;
import java.util.logging.Logger;
import org.glassfish.grizzly.Connection;
import org.glassfish.grizzly.Grizzly;
import org.glassfish.grizzly.http.server.HttpServer;
import org.glassfish.grizzly.http.server.HttpServerFilter;
import org.glassfish.grizzly.http.server.HttpServerProbe;
import org.glassfish.grizzly.http.server.Request;
import org.glassfish.grizzly.http.server.Response;
/**
* A {@linkplain HttpServerProbe Grizzly probe} used to provide
* access logs generation.
*
* @author Pier Fumagalli
* @author USRZ.com
*/
public class AccessLogProbe extends HttpServerProbe.Adapter {
/**
* The minimum response status that will trigger an entry
* in an access log configured by this instance (default, log everything).
*/
public static final int DEFAULT_STATUS_THRESHOLD = Integer.MIN_VALUE;
/* Our timestamp request attribute */
private static final String ATTRIBUTE_TIME_STAMP = AccessLogProbe.class.getName() + ".timeStamp";
/* Our logger, for eventualities */
private static final Logger LOGGER = Grizzly.logger(HttpServer.class);
/* The appender to send formatted data to */
private final AccessLogAppender appender;
/* The format to format data to log */
private final AccessLogFormat format;
/* The minimum status threshold */
private final int statusThreshold;
/**
* Create a new {@link AccessLogProbe} formatting data with the specified
* {@linkplain AccessLogFormat format} and appending it to the specified
* {@linkplain AccessLogAppender appender}.
*/
public AccessLogProbe(AccessLogAppender appender, AccessLogFormat format) {
this(appender, format, DEFAULT_STATUS_THRESHOLD);
}
/**
* Create a new {@link AccessLogProbe} formatting data with the specified
* {@linkplain AccessLogFormat format} and appending it to the specified
* {@linkplain AccessLogAppender appender}.
*
* Only responses with status over the specified threshold will
* be logged, for example a threshold of 500 will only
* generate log entries for requests that terminated in error.
*/
public AccessLogProbe(AccessLogAppender appender, AccessLogFormat format, int statusThreshold) {
if (appender == null) throw new NullPointerException("Null access log appender");
if (format == null) throw new NullPointerException("Null format");
this.appender = appender;
this.format = format;
this.statusThreshold = statusThreshold;
}
/**
* Instrument the specified {@link Request} with an attribute marking its
* received time (in {@linkplain System#nanoTime() nanoseconds}).
*/
@Override @SuppressWarnings("rawtypes")
public void onRequestReceiveEvent(HttpServerFilter filter, Connection connection, Request request) {
request.setAttribute(ATTRIBUTE_TIME_STAMP, System.nanoTime());
/*
* It seems that in some edge cases Grizzly is not caching the
* connection addresses in the request / response structure. Internally
* the TCPNIOConnectionClass uses a Holder to store those (which
* provides lazy initialization). We force the holders to get (and
* cache) the values by alling the "get(Local|Peer)Address()" methods.
*/
connection.getLocalAddress();
connection.getPeerAddress();
}
/**
* Receive notification of the completion of a {@link Response} an possibly
* trigger an access log entry generation.
*/
@Override @SuppressWarnings("rawtypes")
public void onRequestCompleteEvent(HttpServerFilter filter, Connection connection, Response response) {
/* Only call the format/appender if we have to */
if (response.getStatus() < statusThreshold) return;
/* Calculate request timing */
final Long requestNanos = (Long) response.getRequest().getAttribute(ATTRIBUTE_TIME_STAMP);
final long timeStamp = System.currentTimeMillis();
final long nanoStamp = System.nanoTime();
final long responseNanos = requestNanos == null ? -1 : nanoStamp - requestNanos;
final Date requestMillis = new Date(timeStamp - (responseNanos / 1000000L));
/* Create a formatted log entry string and append it */
try {
appender.append(format.format(response, requestMillis, responseNanos));
} catch (Throwable throwable) {
LOGGER.log(WARNING, "Exception caught appending to access log", throwable);
}
}
}