|
|
Tomcat example source code file (logging.xml)
This example Tomcat source code file (logging.xml) is included in the DevDaily.com
"Java Source Code
Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.
The Tomcat logging.xml source code
<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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.
-->
<!DOCTYPE document [
<!ENTITY project SYSTEM "project.xml">
]>
<document url="logging.html">
&project;
<properties>
<title>Logging in Tomcat
<author>Allistair Crossley
<author email="yoavs@apache.org">Yoav Shapira
</properties>
<body>
<section name="Important note">
<p>
By default, only java.util.logging is available for the core Tomcat, as Tomcat uses
a package renamed logging implementation which is hardcoded for that logger. Usage of
alternate loggers is available after building the extra components (see
the <a href="extras.html">extras components documentation), which includes
a full commons-logging implementation.
</p>
</section>
<section name="Introduction">
<p>
Tomcat 6.0 uses
<a href="http://commons.apache.org/logging">Commons Logging
throughout its internal code allowing the
developer to choose a logging configuration that suits their needs, e.g
java.util.logging or
<a href="http://logging.apache.org/log4j">Log4J.
Commons Logging provides Tomcat the ability to log
hierarchially across various log levels without needing to rely on a particular
logging implementation.
</p>
<p>
An important consequence for Tomcat 6.0 is that the <Logger> element found in
previous versions to create a <code>localhost_log is no longer a valid nested element
of <Context>. Instead, the default Tomcat configuration will use java.util.logging.
If the developer wishes to collect detailed internal Tomcat logging (i.e what is happening
within the Tomcat engine), then they should configure a logging system such as java.util.logging
or log4j as detailed next.
</p>
</section>
<section name="log4j">
<p>
Tomcat 6.0 has done away with <code>localhost_log which you may be familiar with
as the runtime exception/stack trace log. These types of error are usually thrown
by uncaught exceptions, but are still valuable to the developer. They can now be
found in the <code>stdout log.
</p>
<p>
If you need to setup cross-context detailed logging from within Tomcat's code,
then you can use a simple log4j configuration. Note that this logging van be very
verbose depending on the log level you chose to use. Note also that a log4j logging
configuration is not going to produce stack trace type logging: those stack traces
are output to <code>stdout as discussed above.
</p>
<p>
Follow the following steps to setup a file named tomcat.log that has internal
Tomcat logging output to it:
</p>
<p>
<ol>
<li>Create a file called log4j.properties with the following content
and save it into $CATALINA_HOME/lib.
<source>
log4j.rootLogger=debug, R <br />
log4j.appender.R=org.apache.log4j.RollingFileAppender <br />
log4j.appender.R.File=${catalina.home}/logs/tomcat.log <br />
log4j.appender.R.MaxFileSize=10MB <br />
log4j.appender.R.MaxBackupIndex=10 <br />
log4j.appender.R.layout=org.apache.log4j.PatternLayout <br />
log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n <br />
log4j.logger.org.apache.catalina=DEBUG, R
</source>
</li>
<li>Download Log4J
(v1.2 or later) and place the log4j jar in $CATALINA_HOME/lib.</li>
<li>Build the commons-logging additional component using the extras.xml
Ant build script which is part of teh Tomcat source bundle.</li>
<li>Replace $CATALINA_HOME/bin/tomcat-juli.jar with
<code>output/extras/tomcat-juli.jar.
<li>Place output/extras/tomcat-juli-adapters.jar in
$CATALINA_HOME/lib.</li>
<li>Start Tomcat
</ol>
</p>
<p>
This log4j configuration sets up a file called tomcat.log in your
Tomcat logs folder with a maximum file size of 10MB and
up to 10 backups. DEBUG level is specified which will result in the
most verbose output from Tomcat.
</p>
<p>
You can (and should) be more picky about which packages to include
in the logging. Tomcat 6 uses defines loggers by Engine and Host names.
For example, for a default Catalina localhost log, add this to the
end of the log4j.properties above. Note that there are known issues with
using this naming convention (with square brackets) in log4j XML based
configuration files, so we recommend you use a properties file as described
until a future version of log4j allows this convention.
<ul>
<li>log4j.logger.org.apache.catalina.core.ContainerBase.[Catalina].[localhost]=DEBUG, R
<li>log4j.logger.org.apache.catalina.core=DEBUG, R
<li>log4j.logger.org.apache.catalina.session=DEBUG, R
</ul>
Be warned a level of DEBUG will produce megabytes of logging and slow startup
of Tomcat. This level should be used sparingly when debugging of internal Tomcat
operations is required.
</p>
<p>
Your web applications should certainly use their own log4j configuration.
This is valid <i>with the above configuration. You would place a similar log4j.properties
file in your web application's WEB-INF/classes folder, and log4j1.2.8.jar into
WEB-INF/lib. Then specify your package level logging. This is a basic setup of log4j
which does *not* require Commons-Logging,
and you should consult the
<a href="http://logging.apache.org/log4j/docs/documentation.html">log4j documentation
for more options. This page is intended only as a bootstrapping guide.
</p>
</section>
<section name="java.util.logging">
<p>
The default implemenatation of java.util.logging provided in the JDK is too limited to be
useful. A limitation of JDK Logging appears to be the inability to have per-web application logging,
as the configuration is per-VM. As a result, Tomcat will, in the default configuration,
replace the default LogManager implementation with a container friendly implementation
called JULI, which addresses these shortcomings. It supports the same configuration mechanisms
as the standard JDK java.util.logging, using either a programmatic approach, or properties
files. The main difference is that per-classloader properties files can be set (which enables easy
redeployment friendly webapp configuration), and the properties files support slightly extended
constructs which allows more freedom for defining handlers and assigning them to loggers.
</p>
<p>
JULI is enabled by default in Tomcat 6.0, and supports per classloader configuration, in addition to
the regular global java.util.logging configuration. This means that logging can be configured at
the following layers:
<ul>
<li>In the JDK's logging.properties file. Check
your JAVA_HOME environment setting to see which JDK Tomcat is using. The file will be in
<code>$JAVA_HOME/jre/lib.
Alternately, it can also use a global configuration file located elsewhere by using the
system property <code>java.util.logging.config.file, or programmatic configuration using
<code>java.util.logging.config.class.
<li>In each classloader using a logging.properties file. This means that it is possible to have a
configuration for the Tomcat core, as well as separate configurations for each webapps which will
have the same lifecycle as the webapps.</li>
</ul>
</p>
<p>
The default logging.properties specifies a ConsoleHandler for routing logging to stdout and
also a FileHandler. A handler's log level threshold can be set using SEVERE, WARNING, INFO,
CONFIG, FINE, FINER, FINEST or ALL. The logging.properties shipped with JDK is set to INFO. You
can also target specific packages to collect logging from and specify a level. Here is how
you would set debugging from Tomcat. You would need to ensure the ConsoleHandler's level is also
set to collect this threshold, so FINEST or ALL should be set. Please refer to Sun's java.util.logging
documentation for the complete details.
</p>
<p>
<source>org.apache.catalina.level=FINEST
</p>
<p>
The configuration used by JULI is extremely similar, but uses a few extensions to allow better
flexibility in assigning loggers. The main differences are:
<ul>
<li>A prefix may be added to handler names, so that multiple handlers of a single class may be
instantiated. A prefix is a String which starts with a digit, and ends with '.'. For example,
<code>22foobar. is a valid prefix.
<li>As in Java 5.0, loggers can define a list of handlers using the loggerName.handlers
property.</li>
<li>By default, loggers will not delegate to their parent if they have associated handlers. This
may be changed per logger using the <code>loggerName.useParentHandlers property, which accepts
a boolean value.</li>
<li>The root logger can define its set of handlers using a .handlers property.
<li>System property replacement for property values which start with ${sytstemPropertyName}.
</ul>
</p>
<p>
Example logging.properties file to be placed in $CATALINA_HOME/conf:
<source>
handlers = 1catalina.org.apache.juli.FileHandler, 2localhost.org.apache.juli.FileHandler, \
3manager.org.apache.juli.FileHandler, 4admin.org.apache.juli.FileHandler, \
java.util.logging.ConsoleHandler
.handlers = 1catalina.org.apache.juli.FileHandler, java.util.logging.ConsoleHandler
############################################################
# Handler specific properties.
# Describes specific configuration info for Handlers.
############################################################
1catalina.org.apache.juli.FileHandler.level = FINE
1catalina.org.apache.juli.FileHandler.directory = ${catalina.base}/logs
1catalina.org.apache.juli.FileHandler.prefix = catalina.
2localhost.org.apache.juli.FileHandler.level = FINE
2localhost.org.apache.juli.FileHandler.directory = ${catalina.base}/logs
2localhost.org.apache.juli.FileHandler.prefix = localhost.
3manager.org.apache.juli.FileHandler.level = FINE
3manager.org.apache.juli.FileHandler.directory = ${catalina.base}/logs
3manager.org.apache.juli.FileHandler.prefix = manager.
4admin.org.apache.juli.FileHandler.level = FINE
4admin.org.apache.juli.FileHandler.directory = ${catalina.base}/logs
4admin.org.apache.juli.FileHandler.prefix = admin.
java.util.logging.ConsoleHandler.level = FINE
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
############################################################
# Facility specific properties.
# Provides extra control for each logger.
############################################################
org.apache.catalina.core.ContainerBase.[Catalina].[localhost].level = INFO
org.apache.catalina.core.ContainerBase.[Catalina].[localhost].handlers = \
2localhost.org.apache.juli.FileHandler
org.apache.catalina.core.ContainerBase.[Catalina].[localhost].[/manager].level = INFO
org.apache.catalina.core.ContainerBase.[Catalina].[localhost].[/manager].handlers = \
3manager.org.apache.juli.FileHandler
org.apache.catalina.core.ContainerBase.[Catalina].[localhost].[/admin].level = INFO
org.apache.catalina.core.ContainerBase.[Catalina].[localhost].[/admin].handlers = \
4admin.org.apache.juli.FileHandler
# For example, set the com.xyz.foo logger to only log SEVERE
# messages:
#org.apache.catalina.startup.ContextConfig.level = FINE
#org.apache.catalina.startup.HostConfig.level = FINE
#org.apache.catalina.session.ManagerBase.level = FINE
</source>
</p>
<p>
Example logging.properties for the servlet-examples web application to be placed
in WEB-INF/classes inside the web application:
<source>
handlers = org.apache.juli.FileHandler, java.util.logging.ConsoleHandler
############################################################
# Handler specific properties.
# Describes specific configuration info for Handlers.
############################################################
org.apache.juli.FileHandler.level = FINE
org.apache.juli.FileHandler.directory = ${catalina.base}/logs
org.apache.juli.FileHandler.prefix = servlet-examples.
java.util.logging.ConsoleHandler.level = FINE
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
</source>
</p>
</section>
</body>
</document>
Other Tomcat examples (source code examples)
Here is a short list of links related to this Tomcat logging.xml source code file:
|
The search page
Other Tomcat source code examples at this package level
Click here to learn more about this project
