...
As you read these questions, please keep in mind that Tomcat's internal logging is separate from your own webapp's logging. You would typically be concerned only with your own webapp's logging. You would modify Tomcat's internal logging settings if you are debugging a possible issue or running into other problems. It is anticipated that Tomcat's out-of-the-box logging configuration will be fine for the vast majority of users and environments.
Questions
\[#Q1 Does Tomcat have built-in logging capabilities, and if so how do I use them?\]unmigrated-wiki-markupWiki Markup - \[#Q2 What role does commons-logging play in logging?\]
\[#Q3 What role does JULI and log4j play in logging?\]unmigrated-wiki-markupWiki Markup - \[#Q4 How do I configure commons-logging for use with Tomcat?\]unmigrated-wiki-markup
- \[#Q5 How should I log in my own webapps?\]unmigrated-wiki-markup
- \[#Q6 Where does System.out go? How do I rotate catalina.out?\]
\[#Q7 Where are the logs when running Tomcat as a Windows service?\]unmigrated-wiki-markupWiki Markup - \[#Q8 How do I customize the location of the tomcat logging.properties file?\]unmigrated-wiki-markup
- \[#Q9 Since java.logging is the default commons-logging implementation in Tomcat, why is it not working in my Linux distribution?\]
\\
Answers
Anchor | ||||
---|---|---|---|---|
|
The Servlet Specification requires Servlet Containers like Tomcat to provide at least a rudimentary implementation of the ServletContext#log
method. Tomcat provides a much richer implementation than required by the Spec, as follows:
Prior to Tomcat 5.5, Tomcat provided a Logger element that you could configure and extend according to your needs. If you are using a Tomcat version previous to Tomcat 5.5, make sure to read the \[http://tomcat.apache.org/tomcat-4.1-doc/config/logger.html Logger configuration reference\].unmigrated-wiki-markupWiki Markup - Starting with Tomcat 5.5, Logger was removed and \[http://jakarta.apache.org/commons/logging Jakarta Commons-Logging\] {{
Log
}} is used everywhere in Tomcat. Read the Commons-Logging documentation if you'd like to know how to better use and configure Tomcat's internal logging. See also \[http://tomcat.apache.org/tomcat-5.5-doc/logging.html\] Wiki Markup To enable request logging similar to the Apache HTTP server, you may include the following line in the server.xml file, in the <Engine> tag: <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs" prefix="localhost_access_log." suffix=".log" pattern="common" resolveHosts="false"/> This will produce a log file for each day, such as logs/localhost_access_log.2008-03-10.log, containing the files requested, IP address of the requester, and similar information. 128.34.123.121 - - \[10/Mar/2008:15:55:57 -0500\] "GET /upload/ClickPoints.jsp HTTP/1.1" 200 2725 \\ \\
...
In addition, Tomcat does not swallow the System.out and System.err JVM output streams. You may use these streams for elementary logging if you wish, but a more robust approach such as commons-logging or \[http://logging.apache.org/log4j Log4J\] is recommended for production applications.
Anchor | ||||
---|---|---|---|---|
|
...
Related FAQ:
What role does JULI and log4j play in logging?
Anchor | ||||
---|---|---|---|---|
|
...
Note in addition that in your own applications you could log directly with JULI or log4j. But once you choose one, you can't easily switch to the other later. If you use commons-logging you can.
Anchor | ||||
---|---|---|---|---|
|
You need to specify a commons-logging configuration file and, if you wish, a logging implementation that supports commons-logging. JDK 1.4 (and later) java.util.Logging and Log4j are the two most commonly used logging toolkits for Tomcat. Tomcat 5.5 and Tomcat 6.0 use java.logging as default implementation for commons-logging. So this _should_ work by default, but sometimes it doesn't (see \[#Q9\ Need for it to be in bootstrap classpath?]). If you supply an external logging toolkit such as Log4J, it needs to be located in the $CATALINA_HOME/common/lib directory (for Tomcat 5.0 and earlier). Tomcat 5.5 and later uses commons-logging while bootstrapping so some people suggest adding Log4j to the bootstrap classpath by using the scripts in $CATALINA_HOME/bin (see \ [http://markmail.org/message/3sgxfol3njcfutsm Need for it to be in bootstrap classpath?\]). A better approch apparently working is: Wiki Markup
- Put jog4j.jar in the $CATALINA_HOME/common/lib directory 2. Put the full commons-logging.jar in the $CATALINA_HOME/common/lib directory, even if you see the reduced API version there, named commons-logging-api.jar
Through some classloading voodoo during bootstrapping, if you have the full commons-logging.jar file in your common/lib directory, it replaces the classes from the commons-logging-api.jar file and will reinitialize the logging system and attempt to locate log4j or whatever other logging system you may be using. (see \[http://markmail.org/message/3sgxfol3njcfutsm#query:+page:1+mid:7oce37bngiq2otlu+state:results this thread\]). Wiki Markup
For more detailed instructions, see these mailing list discussions:
...
- \[http://marc.theaimsgroup.com/?l=tomcat-user&m=106623436423859&w=2 A log4j example\]unmigrated-wiki-markup\[http://marc.theaimsgroup.com/?l=tomcat-user&m=108330970225012&w=2
- Logging Configuration\]
\[http://marc.theaimsgroup.com/?l=tomcat-user&m=108578233003073&w=2 Example with JSVC and running on port 80.\]unmigrated-wiki-markupWiki Markup - \[http://minaret.biz/tips/tomcatLogging.html Tomcat and Log4j Configuration (and Velocity), addressing and solving the bootstrap commons-logging.jar problem\]
\\problem
Anchor | ||||
---|---|---|---|---|
|
...
We also recommend that you separate your logging from Tomcat's internal logging. That means you should bundle your logging toolkit with your webapp. If you're using Log4J, for example, place the Log4J jar in the WEB-INF/lib directory of your webapp and the Log4J configuration file in the WEB-INF/classes directory of your webapp. This way different web applications can have different logging configurations and you don't need to worry about them interfering with each other.
Anchor | ||||
---|---|---|---|---|
|
System.out and System.err both print to catalina.out. But you can suppress this via the swallowOutput property and sent to different log files. catalina.out does not rotate. But it should not be an issue because nothing should be printing to standard output since you are using a logging package, right? \[http://marc.theaimsgroup.com/? t=105544472600001&r=1&w=2a thread about rotation of catalina.out\] Wiki Markup
Anchor | ||||
---|---|---|---|---|
|
See these mailing list archive threads:
...
- \[http://markmail.org/message/3fjakrf77dqmy5nz Where are the Tomcat logs when running as a Windows service?\]
\\
Anchor | ||||
---|---|---|---|---|
|
...
On Fedora the startup script in typically located in /etc/rc.d/init.d/ and on Gentoo linux it is located in /etc/init.d/. On RedHat the startup script for Tomcat 5.5 is /etc/init.d/tomcat5 but eventually the real startup script is /usr/bin/dtomcat5.
Anchor | ||||
---|---|---|---|---|
|
...
- tomcat-juli.jar should be in your $CATALINA_HOME/bin directory
- tomcat startup script should run java with -Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager
- tomcat startup script should run java with -Djava.util.logging.config.file=<some_path>/logging.properties
- obviously, the logging.properties file must exist in the directory specified in the tomcat script at point #3
...
If you don't know where to look for your Tomcat startup script, see the previous \[#Q8 How do I customize the location of the tomcat logging.properties file?\]
In RHEL5 (RedHat Enterprise Server 5) the Tomcat 5.5 rpm installation does not include the tomcat-juli.jar file. This is what I made:
...