org.jooby.RequestLogger Maven / Gradle / Ivy
/**
* Apache License
* Version 2.0, January 2004
* http://www.apache.org/licenses/
*
* TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
*
* 1. Definitions.
*
* "License" shall mean the terms and conditions for use, reproduction,
* and distribution as defined by Sections 1 through 9 of this document.
*
* "Licensor" shall mean the copyright owner or entity authorized by
* the copyright owner that is granting the License.
*
* "Legal Entity" shall mean the union of the acting entity and all
* other entities that control, are controlled by, or are under common
* control with that entity. For the purposes of this definition,
* "control" means (i) the power, direct or indirect, to cause the
* direction or management of such entity, whether by contract or
* otherwise, or (ii) ownership of fifty percent (50%) or more of the
* outstanding shares, or (iii) beneficial ownership of such entity.
*
* "You" (or "Your") shall mean an individual or Legal Entity
* exercising permissions granted by this License.
*
* "Source" form shall mean the preferred form for making modifications,
* including but not limited to software source code, documentation
* source, and configuration files.
*
* "Object" form shall mean any form resulting from mechanical
* transformation or translation of a Source form, including but
* not limited to compiled object code, generated documentation,
* and conversions to other media types.
*
* "Work" shall mean the work of authorship, whether in Source or
* Object form, made available under the License, as indicated by a
* copyright notice that is included in or attached to the work
* (an example is provided in the Appendix below).
*
* "Derivative Works" shall mean any work, whether in Source or Object
* form, that is based on (or derived from) the Work and for which the
* editorial revisions, annotations, elaborations, or other modifications
* represent, as a whole, an original work of authorship. For the purposes
* of this License, Derivative Works shall not include works that remain
* separable from, or merely link (or bind by name) to the interfaces of,
* the Work and Derivative Works thereof.
*
* "Contribution" shall mean any work of authorship, including
* the original version of the Work and any modifications or additions
* to that Work or Derivative Works thereof, that is intentionally
* submitted to Licensor for inclusion in the Work by the copyright owner
* or by an individual or Legal Entity authorized to submit on behalf of
* the copyright owner. For the purposes of this definition, "submitted"
* means any form of electronic, verbal, or written communication sent
* to the Licensor or its representatives, including but not limited to
* communication on electronic mailing lists, source code control systems,
* and issue tracking systems that are managed by, or on behalf of, the
* Licensor for the purpose of discussing and improving the Work, but
* excluding communication that is conspicuously marked or otherwise
* designated in writing by the copyright owner as "Not a Contribution."
*
* "Contributor" shall mean Licensor and any individual or Legal Entity
* on behalf of whom a Contribution has been received by Licensor and
* subsequently incorporated within the Work.
*
* 2. Grant of Copyright License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* copyright license to reproduce, prepare Derivative Works of,
* publicly display, publicly perform, sublicense, and distribute the
* Work and such Derivative Works in Source or Object form.
*
* 3. Grant of Patent License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* (except as stated in this section) patent license to make, have made,
* use, offer to sell, sell, import, and otherwise transfer the Work,
* where such license applies only to those patent claims licensable
* by such Contributor that are necessarily infringed by their
* Contribution(s) alone or by combination of their Contribution(s)
* with the Work to which such Contribution(s) was submitted. If You
* institute patent litigation against any entity (including a
* cross-claim or counterclaim in a lawsuit) alleging that the Work
* or a Contribution incorporated within the Work constitutes direct
* or contributory patent infringement, then any patent licenses
* granted to You under this License for that Work shall terminate
* as of the date such litigation is filed.
*
* 4. Redistribution. You may reproduce and distribute copies of the
* Work or Derivative Works thereof in any medium, with or without
* modifications, and in Source or Object form, provided that You
* meet the following conditions:
*
* (a) You must give any other recipients of the Work or
* Derivative Works a copy of this License; and
*
* (b) You must cause any modified files to carry prominent notices
* stating that You changed the files; and
*
* (c) You must retain, in the Source form of any Derivative Works
* that You distribute, all copyright, patent, trademark, and
* attribution notices from the Source form of the Work,
* excluding those notices that do not pertain to any part of
* the Derivative Works; and
*
* (d) If the Work includes a "NOTICE" text file as part of its
* distribution, then any Derivative Works that You distribute must
* include a readable copy of the attribution notices contained
* within such NOTICE file, excluding those notices that do not
* pertain to any part of the Derivative Works, in at least one
* of the following places: within a NOTICE text file distributed
* as part of the Derivative Works; within the Source form or
* documentation, if provided along with the Derivative Works; or,
* within a display generated by the Derivative Works, if and
* wherever such third-party notices normally appear. The contents
* of the NOTICE file are for informational purposes only and
* do not modify the License. You may add Your own attribution
* notices within Derivative Works that You distribute, alongside
* or as an addendum to the NOTICE text from the Work, provided
* that such additional attribution notices cannot be construed
* as modifying the License.
*
* You may add Your own copyright statement to Your modifications and
* may provide additional or different license terms and conditions
* for use, reproduction, or distribution of Your modifications, or
* for any such Derivative Works as a whole, provided Your use,
* reproduction, and distribution of the Work otherwise complies with
* the conditions stated in this License.
*
* 5. Submission of Contributions. Unless You explicitly state otherwise,
* any Contribution intentionally submitted for inclusion in the Work
* by You to the Licensor shall be under the terms and conditions of
* this License, without any additional terms or conditions.
* Notwithstanding the above, nothing herein shall supersede or modify
* the terms of any separate license agreement you may have executed
* with Licensor regarding such Contributions.
*
* 6. Trademarks. This License does not grant permission to use the trade
* names, trademarks, service marks, or product names of the Licensor,
* except as required for reasonable and customary use in describing the
* origin of the Work and reproducing the content of the NOTICE file.
*
* 7. Disclaimer of Warranty. Unless required by applicable law or
* agreed to in writing, Licensor provides the Work (and each
* Contributor provides its Contributions) on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied, including, without limitation, any warranties or conditions
* of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
* PARTICULAR PURPOSE. You are solely responsible for determining the
* appropriateness of using or redistributing the Work and assume any
* risks associated with Your exercise of permissions under this License.
*
* 8. Limitation of Liability. In no event and under no legal theory,
* whether in tort (including negligence), contract, or otherwise,
* unless required by applicable law (such as deliberate and grossly
* negligent acts) or agreed to in writing, shall any Contributor be
* liable to You for damages, including any direct, indirect, special,
* incidental, or consequential damages of any character arising as a
* result of this License or out of the use or inability to use the
* Work (including but not limited to damages for loss of goodwill,
* work stoppage, computer failure or malfunction, or any and all
* other commercial damages or losses), even if such Contributor
* has been advised of the possibility of such damages.
*
* 9. Accepting Warranty or Additional Liability. While redistributing
* the Work or Derivative Works thereof, You may choose to offer,
* and charge a fee for, acceptance of support, warranty, indemnity,
* or other liability obligations and/or rights consistent with this
* License. However, in accepting such obligations, You may act only
* on Your own behalf and on Your sole responsibility, not on behalf
* of any other Contributor, and only if You agree to indemnify,
* defend, and hold each Contributor harmless for any liability
* incurred by, or claims asserted against, such Contributor by reason
* of your accepting any such warranty or additional liability.
*
* END OF TERMS AND CONDITIONS
*
* APPENDIX: How to apply the Apache License to your work.
*
* To apply the Apache License to your work, attach the following
* boilerplate notice, with the fields enclosed by brackets "{}"
* replaced with your own identifying information. (Don't include
* the brackets!) The text should be enclosed in the appropriate
* comment syntax for the file format. We also recommend that a
* file or class name and description of purpose be included on the
* same "printed page" as the copyright notice for easier
* identification within third-party archives.
*
* Copyright 2014 Edgar Espina
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jooby;
import static java.util.Objects.requireNonNull;
import java.time.Instant;
import java.time.ZoneId;
import java.time.format.DateTimeFormatter;
import java.util.function.Consumer;
import java.util.function.Function;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* request logger
*
* Log all the matched incoming requested using the
* NCSA format (a.k.a common log
* format).
*
* usage
*
* {@code
* {
* use("*", new RequestLog());
*
* ...
* }
* }
*
*
* Output looks like:
*
*
*
* 127.0.0.1 - - [04/Oct/2016:17:51:42 +0000] "GET / HTTP/1.1" 200 2
*
*
*
* You probably want to configure the RequestLog logger to save output into a new file:
*
*
*
* <appender name="ACCESS" class="ch.qos.logback.core.rolling.RollingFileAppender">
* <file>access.log</file>
* <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
* <fileNamePattern>access.%d{yyyy-MM-dd}.log</fileNamePattern>
* </rollingPolicy>
*
* <encoder>
* <pattern>%msg%n</pattern>
* </encoder>
* </appender>
*
* <logger name="org.jooby.RequestLogger" additivity="false">
* <appender-ref ref="ACCESS" />
* </logger>
*
*
*
* Due that authentication is provided via module or custom filter, there is no concept of
* logged/authenticated user. Still you can log the current user by setting an user id provider at
* construction time:
*
*
* {@code
* {
*
* use("*", (req, rsp) -> {
* // authenticate user and set local attribute
* String userId = ...;
* req.set("userId", userId);
* });
*
* use("*", new RequestLogger(req -> {
* return req.get("userId");
* }));
* }
* }
*
*
* Here an application filter set an userId request attribute and then we provide that
* userId to {@link RequestLogger}.
*
*
* custom log function
*
* By default it uses the underlying logging system: logback.
* That's why we previously show how to configure the org.jooby.RequestLogger in
* logback.xml.
*
*
*
* If you want to log somewhere else and/or use a different technology then:
*
*
* {@code
* {
* use("*", new ResponseLogger()
* .log(line -> {
* System.out.println(line);
* }));
* }
* }
*
*
* This is just an example but of course you can log the NCSA line to database, jms
* queue, etc...
*
*
* latency
*
* {@code
* {
* use("*", new RequestLogger()
* .latency());
* }
* }
*
*
* It add a new entry at the last of the NCSA output that represents the number of
* ms it took to process the incoming release.
*
*
extended
*
* Extend the NCSA by adding the Referer and User-Agent
* headers to the output.
*
*
* dateFormatter
*
* {@code
* {
* use("*", new RequestLogger()
* .dateFormatter(ts -> ...));
*
* // OR
* use("*", new RequestLogger()
* .dateFormatter(DateTimeFormatter...));
* }
* }
*
*
* Override, the default formatter for the request arrival time defined by:
* {@link Request#timestamp()}. You can provide a function or an instance of
* {@link DateTimeFormatter}.
*
*
*
* The default formatter use the default server time zone, provided by
* {@link ZoneId#systemDefault()}. It's possible to just override the time zone (not the entirely
* formatter) too:
*
*
* {@code
* {
* use("*", new RequestLogger()
* .dateFormatter(ZoneId.of("UTC"));
* }
* }
*
* @author edgar
* @since 1.0.0
*/
public class RequestLogger implements Route.Handler {
private static final String USER_AGENT = "User-Agent";
private static final String REFERER = "Referer";
private static final String CONTENT_LENGTH = "Content-Length";
private static final DateTimeFormatter FORMATTER = DateTimeFormatter
.ofPattern("dd/MMM/yyyy:HH:mm:ss Z")
.withZone(ZoneId.systemDefault());
private static final String DASH = "-";
private static final char SP = ' ';
private static final char BL = '[';
private static final char BR = ']';
private static final char Q = '\"';
private static final char QUERY = '?';
private static Function ANNON = req -> DASH;
/** The logging system. */
private final Logger log = LoggerFactory.getLogger(getClass());
private final Function userId;
private Consumer logRecord = log::info;
private Function df;
private boolean latency;
private boolean queryString;
private boolean extended;
/**
* Creates a new {@link RequestLogger} and use the given function and userId provider. Please
* note, if the user isn't present this function is allowed to returns - (dash
* character).
*
* @param userId User ID provider.
*/
public RequestLogger(final Function userId) {
this.userId = requireNonNull(userId, "User ID provider required.");
dateFormatter(FORMATTER);
}
/**
* Creates a new {@link RequestLogger} without user identifier.
*/
public RequestLogger() {
this(ANNON);
}
@Override
public void handle(final Request req, final Response rsp) throws Throwable {
/** Push complete callback . */
rsp.complete((ereq, ersp, x) -> {
StringBuilder sb = new StringBuilder(256);
long timestamp = req.timestamp();
sb.append(req.ip());
sb.append(SP).append(DASH).append(SP);
sb.append(userId.apply(req));
sb.append(SP);
sb.append(BL).append(df.apply(timestamp)).append(BR);
sb.append(SP);
sb.append(Q).append(req.method());
sb.append(SP);
sb.append(req.path());
if (queryString) {
req.queryString().ifPresent(s -> sb.append(QUERY).append(s));
}
sb.append(SP);
sb.append(req.protocol());
sb.append(Q).append(SP);
int status = ersp.status().orElse(Status.OK).value();
sb.append(status);
sb.append(SP);
sb.append(ersp.header(CONTENT_LENGTH).value(DASH));
if (extended) {
sb.append(SP);
sb.append(Q).append(req.header(REFERER).value(DASH)).append(Q).append(SP);
sb.append(Q).append(req.header(USER_AGENT).value(DASH)).append(Q);
}
if (latency) {
long now = System.currentTimeMillis();
sb.append(SP);
sb.append(now - timestamp);
}
logRecord.accept(sb.toString());
});
}
/**
* Log an NCSA line to somewhere.
*
* {@code
* {
* use("*", new RequestLogger()
* .log(System.out::println)
* );
* }
* }
*
* @param log Log callback.
* @return This instance.
*/
public RequestLogger log(final Consumer log) {
this.logRecord = requireNonNull(log, "Logger required.");
return this;
}
/**
* Override the default date formatter.
*
* @param formatter New formatter to use.
* @return This instance.
*/
public RequestLogger dateFormatter(final DateTimeFormatter formatter) {
requireNonNull(formatter, "Formatter required.");
return dateFormatter(ts -> formatter.format(Instant.ofEpochMilli(ts)));
}
/**
* Override the default date formatter.
*
* @param formatter New formatter to use.
* @return This instance.
*/
public RequestLogger dateFormatter(final Function formatter) {
requireNonNull(formatter, "Formatter required.");
this.df = formatter;
return this;
}
/**
* Keep the default formatter but use the provided timezone.
*
* @param zoneId Zone id.
* @return This instance.
*/
public RequestLogger dateFormatter(final ZoneId zoneId) {
return dateFormatter(FORMATTER.withZone(zoneId));
}
/**
* Log latency (how long does it takes to process an incoming request) at the end of the NCSA
* line.
*
* @return This instance.
*/
public RequestLogger latency() {
this.latency = true;
return this;
}
/**
* Log full path of the request including query string.
*
* @return This instance.
*/
public RequestLogger queryString() {
this.queryString = true;
return this;
}
/**
* Append Referer and User-Agent entries to the NCSA line.
*
* @return This instance.
*/
public RequestLogger extended() {
this.extended = true;
return this;
}
}