This is an automated email from the ASF dual-hosted git repository.
remm pushed a commit to branch 8.5.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/8.5.x by this push:
new 0dae4663c7 Differentiate trace and debug log levels
0dae4663c7 is described below
commit 0dae4663c71ebadadff59515a52df059502beb62
Author: remm <[email protected]>
AuthorDate: Mon Feb 5 10:49:57 2024 +0100
Differentiate trace and debug log levels
---
.../valves/CrawlerSessionManagerValve.java | 20 ++++++++--------
.../catalina/valves/ExtendedAccessLogValve.java | 8 +++----
.../apache/catalina/valves/PersistentValve.java | 28 +++++++++++-----------
java/org/apache/catalina/valves/RemoteIpValve.java | 8 +++----
.../catalina/valves/StuckThreadDetectionValve.java | 4 ++--
.../catalina/valves/rewrite/RewriteValve.java | 12 +++++-----
webapps/docs/changelog.xml | 4 ++++
7 files changed, 44 insertions(+), 40 deletions(-)
diff --git a/java/org/apache/catalina/valves/CrawlerSessionManagerValve.java
b/java/org/apache/catalina/valves/CrawlerSessionManagerValve.java
index 03a5e6b481..39dfab3138 100644
--- a/java/org/apache/catalina/valves/CrawlerSessionManagerValve.java
+++ b/java/org/apache/catalina/valves/CrawlerSessionManagerValve.java
@@ -180,8 +180,8 @@ public class CrawlerSessionManagerValve extends ValveBase {
String clientIp = request.getRemoteAddr();
String clientIdentifier = getClientIdentifier(request.getHost(),
request.getContext(), clientIp);
- if (log.isDebugEnabled()) {
- log.debug(request.hashCode() + ": ClientIdentifier=" +
clientIdentifier + ", RequestedSessionId=" +
+ if (log.isTraceEnabled()) {
+ log.trace(request.hashCode() + ": ClientIdentifier=" +
clientIdentifier + ", RequestedSessionId=" +
request.getRequestedSessionId());
}
@@ -198,15 +198,15 @@ public class CrawlerSessionManagerValve extends ValveBase
{
// If more than one UA header - assume not a bot
if (uaHeader != null && !uaHeaders.hasMoreElements()) {
- if (log.isDebugEnabled()) {
- log.debug(request.hashCode() + ": UserAgent=" + uaHeader);
+ if (log.isTraceEnabled()) {
+ log.trace(request.hashCode() + ": UserAgent=" + uaHeader);
}
if (uaPattern.matcher(uaHeader).matches()) {
isBot = true;
- if (log.isDebugEnabled()) {
- log.debug(request.hashCode() + ": Bot found.
UserAgent=" + uaHeader);
+ if (log.isTraceEnabled()) {
+ log.trace(request.hashCode() + ": Bot found.
UserAgent=" + uaHeader);
}
}
}
@@ -214,8 +214,8 @@ public class CrawlerSessionManagerValve extends ValveBase {
if (ipPattern != null && ipPattern.matcher(clientIp).matches()) {
isBot = true;
- if (log.isDebugEnabled()) {
- log.debug(request.hashCode() + ": Bot found. IP=" +
clientIp);
+ if (log.isTraceEnabled()) {
+ log.trace(request.hashCode() + ": Bot found. IP=" +
clientIp);
}
}
@@ -224,8 +224,8 @@ public class CrawlerSessionManagerValve extends ValveBase {
sessionId = clientIdSessionId.get(clientIdentifier);
if (sessionId != null) {
request.setRequestedSessionId(sessionId);
- if (log.isDebugEnabled()) {
- log.debug(request.hashCode() + ": SessionID=" +
sessionId);
+ if (log.isTraceEnabled()) {
+ log.trace(request.hashCode() + ": SessionID=" +
sessionId);
}
}
}
diff --git a/java/org/apache/catalina/valves/ExtendedAccessLogValve.java
b/java/org/apache/catalina/valves/ExtendedAccessLogValve.java
index 1da207da4d..4ed97e9fa2 100644
--- a/java/org/apache/catalina/valves/ExtendedAccessLogValve.java
+++ b/java/org/apache/catalina/valves/ExtendedAccessLogValve.java
@@ -509,8 +509,8 @@ public class ExtendedAccessLogValve extends AccessLogValve {
String token = tokenizer.getToken();
while (token != null) {
- if (log.isDebugEnabled()) {
- log.debug("token = " + token);
+ if (log.isTraceEnabled()) {
+ log.trace("token = " + token);
}
AccessLogElement element = getLogElement(token, tokenizer);
if (element == null) {
@@ -526,8 +526,8 @@ public class ExtendedAccessLogValve extends AccessLogValve {
}
token = tokenizer.getToken();
}
- if (log.isDebugEnabled()) {
- log.debug("finished decoding with element size of: " +
list.size());
+ if (log.isTraceEnabled()) {
+ log.trace("finished decoding with element size of: " +
list.size());
}
return list.toArray(new AccessLogElement[0]);
} catch (IOException e) {
diff --git a/java/org/apache/catalina/valves/PersistentValve.java
b/java/org/apache/catalina/valves/PersistentValve.java
index 9bbdf8b083..b6ed022b68 100644
--- a/java/org/apache/catalina/valves/PersistentValve.java
+++ b/java/org/apache/catalina/valves/PersistentValve.java
@@ -117,13 +117,13 @@ public class PersistentValve extends ValveBase {
// request without session
if (isRequestWithoutSession(request.getDecodedRequestURI())) {
- if (containerLog.isDebugEnabled()) {
-
containerLog.debug(sm.getString("persistentValve.requestIgnore",
request.getDecodedRequestURI()));
+ if (containerLog.isTraceEnabled()) {
+
containerLog.trace(sm.getString("persistentValve.requestIgnore",
request.getDecodedRequestURI()));
}
getNext().invoke(request, response);
return;
- } else if (containerLog.isDebugEnabled()) {
- containerLog.debug(sm.getString("persistentValve.requestProcess",
request.getDecodedRequestURI()));
+ } else if (containerLog.isTraceEnabled()) {
+ containerLog.trace(sm.getString("persistentValve.requestProcess",
request.getDecodedRequestURI()));
}
// Select the Context to be used for this Request
@@ -188,8 +188,8 @@ public class PersistentValve extends ValveBase {
}
if (session != null) {
if (!session.isValid() || isSessionStale(session,
System.currentTimeMillis())) {
- if (containerLog.isDebugEnabled()) {
- containerLog.debug("session swapped in is
invalid or expired");
+ if (containerLog.isTraceEnabled()) {
+ containerLog.trace("session swapped in is
invalid or expired");
}
session.expire();
store.remove(sessionId);
@@ -204,8 +204,8 @@ public class PersistentValve extends ValveBase {
}
}
}
- if (containerLog.isDebugEnabled()) {
- containerLog.debug("sessionId: " + sessionId);
+ if (containerLog.isTraceEnabled()) {
+ containerLog.trace("sessionId: " + sessionId);
}
// Ask the next valve to process the request.
@@ -226,8 +226,8 @@ public class PersistentValve extends ValveBase {
newsessionId = hsess.getIdInternal();
}
- if (containerLog.isDebugEnabled()) {
- containerLog.debug("newsessionId: " + newsessionId);
+ if (containerLog.isTraceEnabled()) {
+ containerLog.trace("newsessionId: " + newsessionId);
}
if (newsessionId != null) {
try {
@@ -249,17 +249,17 @@ public class PersistentValve extends ValveBase {
}
if (!stored) {
- if (containerLog.isDebugEnabled()) {
+ if (containerLog.isTraceEnabled()) {
containerLog
- .debug("newsessionId store: " +
store + " session: " + session +
+ .trace("newsessionId store: " +
store + " session: " + session +
" valid: " +
(session == null ? "N/A" :
Boolean.toString(session.isValid())) +
" stale: " +
isSessionStale(session, System.currentTimeMillis()));
}
}
} else {
- if (containerLog.isDebugEnabled()) {
- containerLog.debug("newsessionId Manager: " +
manager);
+ if (containerLog.isTraceEnabled()) {
+ containerLog.trace("newsessionId Manager: " +
manager);
}
}
} finally {
diff --git a/java/org/apache/catalina/valves/RemoteIpValve.java
b/java/org/apache/catalina/valves/RemoteIpValve.java
index add35f3df9..4b3a932354 100644
--- a/java/org/apache/catalina/valves/RemoteIpValve.java
+++ b/java/org/apache/catalina/valves/RemoteIpValve.java
@@ -737,8 +737,8 @@ public class RemoteIpValve extends ValveBase {
request.setAttribute(Globals.REQUEST_FORWARDED_ATTRIBUTE,
Boolean.TRUE);
- if (log.isDebugEnabled()) {
- log.debug("Incoming request " + request.getRequestURI() + "
with originalRemoteAddr [" +
+ if (log.isTraceEnabled()) {
+ log.trace("Incoming request " + request.getRequestURI() + "
with originalRemoteAddr [" +
originalRemoteAddr + "], originalRemoteHost=[" +
originalRemoteHost + "], originalSecure=[" +
originalSecure + "], originalScheme=[" +
originalScheme + "], originalServerName=[" +
originalServerName + "], originalServerPort=[" +
originalServerPort +
@@ -748,8 +748,8 @@ public class RemoteIpValve extends ValveBase {
request.getServerPort() + "]");
}
} else {
- if (log.isDebugEnabled()) {
- log.debug("Skip RemoteIpValve for request " +
request.getRequestURI() + " with originalRemoteAddr '" +
+ if (log.isTraceEnabled()) {
+ log.trace("Skip RemoteIpValve for request " +
request.getRequestURI() + " with originalRemoteAddr '" +
request.getRemoteAddr() + "'");
}
}
diff --git a/java/org/apache/catalina/valves/StuckThreadDetectionValve.java
b/java/org/apache/catalina/valves/StuckThreadDetectionValve.java
index 95033557c0..cb1880e04d 100644
--- a/java/org/apache/catalina/valves/StuckThreadDetectionValve.java
+++ b/java/org/apache/catalina/valves/StuckThreadDetectionValve.java
@@ -128,8 +128,8 @@ public class StuckThreadDetectionValve extends ValveBase {
protected void initInternal() throws LifecycleException {
super.initInternal();
- if (log.isDebugEnabled()) {
- log.debug("Monitoring stuck threads with threshold = " + threshold
+ " sec");
+ if (log.isTraceEnabled()) {
+ log.trace("Monitoring stuck threads with threshold = " + threshold
+ " sec");
}
}
diff --git a/java/org/apache/catalina/valves/rewrite/RewriteValve.java
b/java/org/apache/catalina/valves/rewrite/RewriteValve.java
index bac8623836..32e986514c 100644
--- a/java/org/apache/catalina/valves/rewrite/RewriteValve.java
+++ b/java/org/apache/catalina/valves/rewrite/RewriteValve.java
@@ -237,8 +237,8 @@ public class RewriteValve extends ValveBase {
Object result = parse(line);
if (result instanceof RewriteRule) {
RewriteRule rule = (RewriteRule) result;
- if (containerLog.isDebugEnabled()) {
- containerLog.debug("Add rule with pattern " +
rule.getPatternString()
+ if (containerLog.isTraceEnabled()) {
+ containerLog.trace("Add rule with pattern " +
rule.getPatternString()
+ " and substitution " +
rule.getSubstitutionString());
}
for (int i = (conditions.size() - 1); i > 0; i--) {
@@ -247,9 +247,9 @@ public class RewriteValve extends ValveBase {
}
}
for (RewriteCond condition : conditions) {
- if (containerLog.isDebugEnabled()) {
+ if (containerLog.isTraceEnabled()) {
RewriteCond cond = condition;
- containerLog.debug("Add condition " +
cond.getCondPattern()
+ containerLog.trace("Add condition " +
cond.getCondPattern()
+ " test " + cond.getTestString() + " to
rule with pattern "
+ rule.getPatternString() + " and
substitution "
+ rule.getSubstitutionString() +
(cond.isOrnext() ? " [OR]" : "")
@@ -339,8 +339,8 @@ public class RewriteValve extends ValveBase {
CharSequence test = (rule.isHost()) ? host : urlDecoded;
CharSequence newtest = rule.evaluate(test, resolver);
if (newtest != null && !test.equals(newtest.toString())) {
- if (containerLog.isDebugEnabled()) {
- containerLog.debug("Rewrote " + test + " as " + newtest
+ if (containerLog.isTraceEnabled()) {
+ containerLog.trace("Rewrote " + test + " as " + newtest
+ " with rule pattern " +
rule.getPatternString());
}
if (rule.isHost()) {
diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml
index e4d17b67a6..30b874c8da 100644
--- a/webapps/docs/changelog.xml
+++ b/webapps/docs/changelog.xml
@@ -116,6 +116,10 @@
Add improvements to the CSRF prevention filter including the ability
to skip adding nonces for resource name and subtree URL patterns.
(schultz)
</add>
+ <fix>
+ Review usage of debug logging and downgrade trace or data dumping
+ operations from debug level to trace. (remm)
+ </fix>
</changelog>
</subsection>
<subsection name="Coyote">
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
