Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Jetty 12 - Re-enabled RequestLog tests. #8705

Merged
merged 2 commits into from
Oct 14, 2022
Merged

Jetty 12 - Re-enabled RequestLog tests. #8705

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5576966
Re-enable RequestLog tests.
sbordet Oct 12, 2022
01d0756
Updates after review.
sbordet Oct 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 39 additions & 56 deletions jetty-core/jetty-server/src/main/java/org/eclipse/jetty/server/CustomRequestLog.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
import org.eclipse.jetty.util.annotation.ManagedAttribute;
import org.eclipse.jetty.util.annotation.ManagedObject;
import org.eclipse.jetty.util.component.ContainerLifeCycle;
import org.eclipse.jetty.util.resource.Resource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand Down Expand Up @@ -318,11 +319,13 @@
@ManagedObject("Custom format request log")
public class CustomRequestLog extends ContainerLifeCycle implements RequestLog
{
protected static final Logger LOG = LoggerFactory.getLogger(CustomRequestLog.class);

public static final String DEFAULT_DATE_FORMAT = "dd/MMM/yyyy:HH:mm:ss ZZZ";
public static final String NCSA_FORMAT = "%{client}a - %u %t \"%r\" %s %O";
public static final String EXTENDED_NCSA_FORMAT = NCSA_FORMAT + " \"%{Referer}i\" \"%{User-Agent}i\"";
public static final String HANDLER_NAME = CustomRequestLog.class.getName() + ".handlerName";
public static final String REAL_PATH = CustomRequestLog.class.getName() + ".realPath";
public static final String USER_NAME = CustomRequestLog.class.getName() + ".userPrincipal";
Comment on lines +325 to +327
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make these an enum and then an EnumSet can be used to record which of them are required.

private static final Logger LOG = LoggerFactory.getLogger(CustomRequestLog.class);
private static final ThreadLocal<StringBuilder> _buffers = ThreadLocal.withInitial(() -> new StringBuilder(256));

private final RequestLog.Writer _requestLogWriter;
Expand Down Expand Up @@ -379,11 +382,6 @@ public RequestLog.Writer getWriter()
return _requestLogWriter;
}

/**
* Writes the request and response information to the output stream.
*
* @see org.eclipse.jetty.server.RequestLog#log(Request, Response)
*/
@Override
public void log(Request request, Response response)
{
Expand All @@ -409,27 +407,6 @@ public void log(Request request, Response response)
}
}

/**
* Extract the user authentication
*
* @param request The request to extract from
* @param checkDeferred Whether to check for deferred authentication
* @return The string to log for authenticated user.
*/
protected static String getAuthentication(Request request, boolean checkDeferred)
{
// TODO
// Authentication authentication = request.getAuthentication();
// if (checkDeferred && authentication instanceof Authentication.Deferred)
// authentication = ((Authentication.Deferred)authentication).authenticate(request);

String name = null;
// if (authentication instanceof Authentication.User)
// name = ((Authentication.User)authentication).getUserIdentity().getUserPrincipal().getName();
//
return name;
}

/**
* Set request paths that will not be logged.
*
Expand Down Expand Up @@ -1046,8 +1023,7 @@ private static void logRemotePort(StringBuilder b, Request request, Response res
@SuppressWarnings("unused")
private static void logResponseSize(StringBuilder b, Request request, Response response)
{
long written = Response.getContentBytesWritten(response);
b.append(written);
b.append(Response.getContentBytesWritten(response));
}

@SuppressWarnings("unused")
Expand Down Expand Up @@ -1123,7 +1099,6 @@ private static void logRequestCookie(String arg, StringBuilder b, Request reques
}
}
}

b.append('-');
}

Expand All @@ -1132,7 +1107,9 @@ private static void logRequestCookies(StringBuilder b, Request request, Response
{
List<HttpCookie> cookies = Request.getCookies(request);
if (cookies == null || cookies.size() == 0)
{
b.append('-');
}
else
{
for (int i = 0; i < cookies.size(); i++)
Expand All @@ -1155,17 +1132,25 @@ private static void logEnvironmentVar(String arg, StringBuilder b, Request reque
@SuppressWarnings("unused")
private static void logFilename(StringBuilder b, Request request, Response response)
{
b.append('-');
// TODO UserIdentity.Scope scope = request.getUserIdentityScope();
// if (scope == null || scope.getContextHandler() == null)
// b.append('-');
// else
// {
// ContextHandler context = scope.getContextHandler();
// int lengthToStrip = scope.getContextPath().length() > 1 ? scope.getContextPath().length() : 0;
// String filename = context.getServletContext().getRealPath(request.getPathInfo().substring(lengthToStrip));
// append(b, filename);
// }
String realPath = (String)request.getAttribute(REAL_PATH);
if (realPath == null)
{
Context context = request.getContext();
Resource baseResource = context.getBaseResource();
if (baseResource != null)
{
String fileName = baseResource.resolve(request.getPathInContext()).getName();
append(b, fileName);
}
else
{
b.append("-");
}
}
else
{
b.append(realPath);
}
}

@SuppressWarnings("unused")
Expand Down Expand Up @@ -1221,8 +1206,7 @@ private static void logRequestFirstLine(StringBuilder b, Request request, Respon
@SuppressWarnings("unused")
private static void logRequestHandler(StringBuilder b, Request request, Response response)
{
b.append('-');
// TODO append(b, request.getServletName());
append(b, (String)request.getAttribute(HANDLER_NAME));
}

@SuppressWarnings("unused")
Expand All @@ -1242,39 +1226,38 @@ private static void logRequestTime(DateCache dateCache, StringBuilder b, Request
@SuppressWarnings("unused")
private static void logLatencyMicroseconds(StringBuilder b, Request request, Response response)
{
long currentTime = System.currentTimeMillis();
long requestTime = request.getTimeStamp();

long latencyMs = currentTime - requestTime;
long latencyUs = TimeUnit.MILLISECONDS.toMicros(latencyMs);

b.append(latencyUs);
logLatency(b, request, TimeUnit.MICROSECONDS);
}

@SuppressWarnings("unused")
private static void logLatencyMilliseconds(StringBuilder b, Request request, Response response)
{
long latency = System.currentTimeMillis() - request.getTimeStamp();
b.append(latency);
logLatency(b, request, TimeUnit.MILLISECONDS);
}

@SuppressWarnings("unused")
private static void logLatencySeconds(StringBuilder b, Request request, Response response)
{
logLatency(b, request, TimeUnit.SECONDS);
}

private static void logLatency(StringBuilder b, Request request, TimeUnit unit)
{
long latency = System.currentTimeMillis() - request.getTimeStamp();
b.append(TimeUnit.MILLISECONDS.toSeconds(latency));
b.append(unit.convert(latency, TimeUnit.MILLISECONDS));
}

@SuppressWarnings("unused")
private static void logRequestAuthentication(StringBuilder b, Request request, Response response)
{
append(b, getAuthentication(request, false));
append(b, (String)request.getAttribute(USER_NAME));
}

@SuppressWarnings("unused")
private static void logRequestAuthenticationWithDeferred(StringBuilder b, Request request, Response response)
{
append(b, getAuthentication(request, true));
// TODO: deferred to be implemented.
logRequestAuthentication(b, request, response);
}

@SuppressWarnings("unused")
Expand Down
Loading