The Apache Tomcat Servlet/JSP Container

The Apache Tomcat 5.5 Servlet/JSP Container

Apache Logo

Links

User Guide

Reference

Apache Tomcat Development

The Apache Tomcat 5.5 Servlet/JSP Container

Monitoring and Managing Tomcat

Table of Contents
Introduction

Monitoring is a very important question today. Looking inside the running server, grab some statistic data or reconfigure some aspects are daily administration tasks.

Enabling JMX Local

To enable JMX access to Tomcat that runs on the same machine, add the following parameter to your Tomcat startup script:

ImageImageImage
Image
    set CATALINA_OPTS=-Dcom.sun.management.jmxremote
    
Image
ImageImageImage
Enabling JMX Remote

The Sun website includes the list of options and how to configure JMX Remote on Java 5: http://java.sun.com/j2se/1.5.0/docs/guide/management/agent.html.

For quick installation you find here a short installation guide:

Add the following parameters to your Tomcat startup script:

ImageImageImage
Image
    set CATALINA_OPTS=-Dcom.sun.management.jmxremote \
    -Dcom.sun.management.jmxremote.port=%my.jmx.port% \
    -Dcom.sun.management.jmxremote.ssl=false \
    -Dcom.sun.management.jmxremote.authenticate=false
    
Image
ImageImageImage

  1. When you think authorization is a good, add and change this :
    ImageImageImage
    Image
        -Dcom.sun.management.jmxremote.authenticate=true \
        -Dcom.sun.management.jmxremote.password.file=../conf/jmxremote.password \
        -Dcom.sun.management.jmxremote.access.file=../conf/jmxremote.access \
        
    Image
    ImageImageImage
  2. edit the access allow file $CATALINA_BASE/conf/jmxremote.access :
    ImageImageImage
    Image
    monitorRole readonly
    controlRole readwrite
        
    Image
    ImageImageImage
  3. edit the password file $CATALINA_BASE/conf/jmxremote.password :
    ImageImageImage
    Image
    monitorRole tomcat
    controlRole tomcat
        
    Image
    ImageImageImage
    Tip: Password File must be readonly and not accessible from every other user! Remove all other users under windows to access this file.
Note:The JSR 160 JMX-Adaptor opens a second data protocol port. That is a problem when you have installed a local firewall. However, there is at least one possible workaround: using a custom JMXConnectorServer.

Start a JMX Adaptor with fix data port is supported with Tomcat 5.5.25 src release:

ImageImageImage
Image
<Server ...>
...
<Listener className="org.apache.catalina.mbeans.JMXAdaptorLifecycleListener"
          namingPort="8083" port="8084" host="myhost" />  
...
</Server>
   
Image
ImageImageImage
You can use all JMX system properties (com.sun.management.jmxremote.xxx) to configure the adaptor :-)
At your remote jconsole call the jmx adaptor with following command
jconsole service:jmx:rmi://myhost:8084/jndi/rmi://myhost:8083/server

Activate JMX MX4J Http Adaptor with Java 1.4:

  1. Install the tomcat compat package
  2. Install the mx4j-tools.jar at common/lib. Please, use the same MX4j version as your Tomcat release
  3. Configure a MX4J JMX HTTP Adaptor at your AJP Connector

    ImageImageImage
    Image
          <Connector port="${AJP.PORT}" 
                handler.list="mx" 
                mx.enabled="true" 
                mx.httpHost="${JMX.HOST}"
                mx.httpPort="${JMX.PORT}"
                protocol="AJP/1.3" />
          
    Image
    ImageImageImage

    Tip: With ${AJP.PORT}=0 no ajp connection where started.

    Note: MX4J JSR 160 RMI Adaptor to support JDK 1.4 currently not integrated.

  4. Start your Tomcat and look with a browser at http://${JMX.HOST}:${JMX.PORT}
  5. With the mx connector parameter mx.authMode="basic" mx.authUser="tomcat" mx.authPassword="strange" you can control the access!
  6. A complete list of all Tomcat core MBeans can you find at http://tomcat.apache.org/tomcat-5.5-doc/catalina/funcspecs/mbean-names.html.

Manage Tomcat with JMX remote Ant Tasks

To simplify JMX usage with Apache Ant 1.6.x, a set of tasks is provided that may be used with antlib. The tasks can also be defined explicitly. An Ant project that defines the tasks is provided and can be imported into your project.

antlib support: Copy your catalina-ant.jar from $CATALINA_HOME/server/lib to $ANT_HOME/lib.

The following example shows the JMX Accessor usage:

<project name="Catalina Ant JMX" 
        xmlns:jmx="antlib:org.apache.catalina.ant.jmx" 
        default="state"
        basedir=".">
    <property name="jmx.server.name" value="localhost" />
    <property name="jmx.server.port" value="9012" />
    <property name="cluster.server.address" value="192.168.1.75" />
    <property name="cluster.server.port" value="9025" />
 
    <target name="state" description="Show JMX Cluster state">
        <jmx:open
            host="${jmx.server.name}"
            port="${jmx.server.port}"
            username="controlRole"
            password="tomcat"/>
        <jmx:get
            name="Catalina:type=IDataSender,host=localhost,senderAddress=${cluster.server.address},senderPort=${cluster.server.port}" 
            attribute="connected"
            resultproperty="IDataSender.backup.connected"
            echo="false"
        />
       <jmx:get
            name="Catalina:type=ClusterSender,host=localhost" 
            attribute="senderObjectNames"
            resultproperty="senderObjectNames"
            echo="false"
        />
        <!-- get current maxActiveSession from ClusterTest application
             echo it to ant output and store at 
             property <em>clustertest.maxActiveSessions.orginal</em>
        -->
       <jmx:get
            name="Catalina:type=Manager,path=/ClusterTest,host=localhost" 
            attribute="maxActiveSessions"
            resultproperty="clustertest.maxActiveSessions.orginal"
            echo="true"
        />
        <!-- set maxActiveSession to 100
        -->
        <jmx:set
            name="Catalina:type=Manager,path=/ClusterTest,host=localhost" 
            attribute="maxActiveSessions"
            value="100"
            type="int"
        />
        <!-- get all sessions and split result as delimiter <em>SPACE</em> for easy
             access all session ids directly with ant property sessions.[0..n].
        -->
        <jmx:invoke
            name="Catalina:type=Manager,path=/ClusterTest,host=localhost" 
            operation="listSessionIds"
            resultproperty="sessions"
            echo="false"
            delimiter=" "
        />
        <!-- Access session attribute <em>Hello</em> from first session.
        -->
        <jmx:invoke
            name="Catalina:type=Manager,path=/ClusterTest,host=localhost" 
            operation="getSessionAttribute"
            resultproperty="Hello"
            echo="false"
        >
          <arg value="${sessions.0}"/>
          <arg value="Hello"/>
        </jmx:invoke> 
        <!-- Query for all application manager.of the server from all hosts
             and bind all attributes from all found manager mbeans.
        -->
        <jmx:query
            name="Catalina:type=Manager,*" 
            resultproperty="manager"
            echo="true"
            attributebinding="true"
        />
        <!-- echo the create properties -->
        <echo>
           senderObjectNames: ${senderObjectNames.0}
           IDataSender.backup.connected: ${IDataSender.backup.connected}
           session: ${sessions.0}
           manager.length: ${manager.length}
           manager.0.name: ${manager.0.name}
           manager.1.name: ${manager.1.name}
           hello: ${Hello}
           manager.ClusterTest.0.name: ${manager.ClusterTest.0.name}
           manager.ClusterTest.0.activeSessions: ${manager.ClusterTest.0.activeSessions}
           manager.ClusterTest.0.counterSend_EVT_SESSION_EXPIRED: ${manager.ClusterTest.0.counterSend_EVT_SESSION_EXPIRED}
           manager.ClusterTest.0.counterSend_EVT_GET_ALL_SESSIONS: ${manager.ClusterTest.0.counterSend_EVT_GET_ALL_SESSIONS}
        </echo>   

    </target>
 
</project>
   

import: Import the JMX Accessor Project with <import file="${CATALINA.HOME}/bin/jmxaccessor-tasks.xml" /> and reference the tasks with jmxOpen, jmxSet, jmxGet, jmxQuery, jmxInvoke,jmxEquals and jmxCondition.

JMXAccessorOpenTask - jmx open connection task

List of Attributes

Attribute Description Default value
url Set jmx connection url - service:jmx:rmi:///jndi/rmi://localhost:8050/jmxrmi
host Set the host, shortcut the very long url syntax. localhost
port Set the remote connection port 8050
username remote jmx connection user name.
password remote jmx connection password.
ref Name of the internal connection referenz. With this attribute you can configure more the one connection inside the same ant projekt. jmx.server
echo Echo the command usage (for analyse access or debugging) false
if Only execute if a property of the given name exists in the current project.
unless Only execute if a property of the given name not exists in the current project.

Example to open a new jmx connection

ImageImageImage
Image
    <jmx:open
            host="${jmx.server.name}"
            port="${jmx.server.port}"
    />
Image
ImageImageImage

Example to open a jmx connection from url, with authorisation and store at other reference

ImageImageImage
Image
    <jmx:open
            url="service:jmx:rmi:///jndi/rmi://localhost:9024/jmxrmi"
            ref="jmx.server.9024"
            username="controlRole"
            password="tomcat"    
    />
Image
ImageImageImage

Example to open a jmx connection from url, with authorisation and store at other reference, but only when property jmx.if exists and jmx.unless not exists

ImageImageImage
Image
    <jmx:open
            url="service:jmx:rmi:///jndi/rmi://localhost:9024/jmxrmi"
            ref="jmx.server.9024"
            username="controlRole"
            password="tomcat"    
            if="jmx.if"    
            unless="jmx.unless"    
    />
Image
ImageImageImage

Note: All properties from jmxOpen task also exists at all other tasks and conditions.

JMXAccessorGetTask: get attribute value ant task

List of Attributes

Attribute Description Default value
name Full qualified JMX ObjectName -- Catalina:type=Server
attribute Existing Mbean attribute (see Tomcat mbean description above)
ref JMX Connection reference jmx.server
echo Echo command usage (access and result) false
resultproperty Save result at this project property
delimiter Split result with delimiter (java.util.StringTokenizier) and use resultproperty as prefix to store tokens.
separatearrayresults When return value is an array, save result as property list ($resultproperty.[0..N] and $resultproperty.lenght) true

Example to get remote mbean attribute from default jmx connection

ImageImageImage
Image
    <jmx:get
        name="Catalina:type=Manager,path=/servlets-examples,host=localhost" 
        attribute="maxActiveSessions"
        resultproperty="servlets-examples.maxActiveSessions"
    />
Image
ImageImageImage

Example to get and result array and split it at separate properties

ImageImageImage
Image
    <jmx:get
        name="Catalina:type=ClusterSender,host=localhost" 
        attribute="senderObjectNames"
        resultproperty="senderObjectNames"
    />
Image
ImageImageImage
Access the senderObjectNames properties with:
ImageImageImage
Image
    ${senderObjectNames.lenght} give the number of returned sender list.
    ${senderObjectNames.[0..N]} found all sender object names
Image
ImageImageImage

Example to get IDataSender attribute connected only when cluster is configured.

ImageImageImage
Image
<jmx:query
    failonerror="false"
    name="Catalina:type=Cluster,host=${tomcat.application.host}"
    resultproperty="cluster"
/>
<jmx:get
    name="Catalina:type=IDataSender,host=${tomcat.application.host},senderAddress=${cluster.backup.address},senderPort=${cluster.backup.port}" 
    attribute="connected"
    resultproperty="datasender.connected"
    if="cluster.0.name" />
Image
ImageImageImage

JMXAccessorSetTask: set attribute value ant task

List of Attributes

Attribute Description Default value
name Full qualified JMX ObjectName -- Catalina:type=Server
attribute Existing Mbean attribute (see Tomcat mbean description above)
value value that set to attribute
type type of the attribute. java.lang.String
ref JMX Connection reference jmx.server
echo Echo command usage (access and result) false

Example to set remote mbean attribute value

ImageImageImage
Image
    <jmx:set
        name="Catalina:type=Manager,path=/servlets-examples,host=localhost" 
        attribute="maxActiveSessions"
        value="500"
        type="int"
    />
Image
ImageImageImage

Examples to set multiple remote mbean attributes

ImageImageImage
Image
    <jmx:set
        name="java.lang:type=Threading"> 
			 <arg name="ThreadContentionMonitoringEnabled" value="true" type="boolean"/>
			 <arg name="ThreadCpuTimeEnabled" value="false" type="boolean"/>
    </jmx:set>
Image
ImageImageImage

JMXAccessorInvokeTask: invoke Mbean operation ant task

List of Attributes

Attribute Description Default value
name Full qualified JMX ObjectName -- Catalina:type=Server
operation Existing Mbean operation (see Tomcat http://tomcat.apache.org/tomcat-5.5-doc/catalina/funcspecs/fs-admin-opers.html.
ref JMX Connection reference jmx.server
echo Echo command usage (access and result) false
resultproperty Save result at this project property
delimiter Split result with delimiter (java.util.StringTokenizier) and use resultproperty as prefix to store tokens.
separatearrayresults When return value is an array, save result as property list ($resultproperty.[0..N] and $resultproperty.lenght) true

stop an application

ImageImageImage
Image
    <jmx:invoke
        name="Catalina:type=Manager,path=/servlets-examples,host=localhost" 
        operation="stop"/>
Image
ImageImageImage
Now you can find the sessionid at ${sessions.[0..N} properties and access the count with ${sessions.lenght} property.

Example to get all sessionids

ImageImageImage
Image
    <jmx:invoke
        name="Catalina:type=Manager,path=/servlets-examples,host=localhost" 
        operation="listSessionIds"
        resultproperty="sessions"
        delimiter=" "        
    />
Image
ImageImageImage
Now you can find the sessionid at ${sessions.[0..N} properties and access the count with ${sessions.lenght} property.

Example to get remote mbean session attribute from session ${sessionid.0}

ImageImageImage
Image
    <jmx:invoke
        name="Catalina:type=Manager,path=/ClusterTest,host=localhost" 
        operation="getSessionAttribute"
        resultproperty="hello">
         <arg value="${sessionid.0}"/>
         <arg value="Hello" />
 </jmx:invoke>
Image
ImageImageImage

Example to create a new access logger valve at vhost localhost

ImageImageImage
Image
 <jmx:invoke
         name="Catalina:type=MBeanFactory" 
         operation="createAcccesLoggerValve"
         resultproperty="acccesLoggerObjectName"
 >
     <arg value="Catalina:type=Host,host=localhost"/>
 </jmx:invoke>
Image
ImageImageImage
Now you can find new Mbean with name stored at ${acccesLoggerObjectName} proeprty.

JMXAccessorQueryTask: query Mbean ant task

List of Attributes

Attribute Description Default value
name JMX ObjectName query string -- Catalina:type=Manager,*
ref JMX Connection reference jmx.server
echo Echo command usage (access and result) false
resultproperty Prefix project property name to all founded Mbeans (mbeans.[0..N].objectname)
attributebinduing bind ALL MBean attributes in addition to name false
delimiter Split result with delimiter (java.util.StringTokenizier) and use resultproperty as prefix to store tokens.
separatearrayresults When return value is an array, save result as property list ($resultproperty.[0..N] and $resultproperty.lenght) true

Get all Manager ObjectNames from all services and Hosts

ImageImageImage
Image
  <jmx:query
           name="Catalina:type=Manager,* 
           resultproperty="manager" />
Image
ImageImageImage
Now you can find the Session Manager at ${manager.[0..N].name} properties and access the result object counter with ${manager.length} property.

Example to get the Manager from servlet-examples application an bind all mbean properties

ImageImageImage
Image
  <jmx:query
           name="Catalina:type=Manager,path=/servlet-examples,host=localhost*" 
           attributebinding="true"
           resultproperty="manager.servletExamples" />
Image
ImageImageImage
Now you can find the manager at ${manager.servletExamples.0.name} property and can access all properties from this manager with ${manager.servletExamples.0.[manager attribute names]}. The result object counter from MBeans is stored ad ${manager.length} property.

Example to get all MBeans from a server and store inside an external xml property file

ImageImageImage
Image
<project name="jmx.query"         
            xmlns:jmx="antlib:org.apache.catalina.ant.jmx"
            default="query-all" basedir=".">
<property name="jmx.host" value="localhost"/>
<property name="jmx.port" value="8050"/>
<property name="jmx.username" value="controlRole"/>
<property name="jmx.password" value="tomcat"/>

<target name="query-all" description="Query all MBeans of a server">
<!-- Configure connection -->
<jmx:open 
    host="${jmx.host}"
    port="${jmx.port}"
    ref="jmx.server"
    username="${jmx.username}"
    password="${jmx.password}"/>
<!-- Query MBean list -->
<jmx:query 
    name="*:*"
    resultproperty="mbeans"
    attributebinding="false"/>
    
<echoproperties
    destfile="mbeans.properties"
    prefix="mbeans."
    format="xml"/>
    
<!-- Print results -->
<echo
    message="Number of MBeans in server ${jmx.host}:${jmx.port} is ${mbeans.length}"/>
</target>
</project>
Image
ImageImageImage
Now you can find all MBeans inside the file mbeans.properties.

JMXAccessorCreateTask: remote create mbean ant task

List of Attributes

Attribute Description Default value
name Full qualified JMX ObjectName -- Catalina:type=MBeanFactory
className Existing MBean full qualified classname (see Tomcat mbean description above)
classLoader ObjectName of server or web application classloader
( Catalina:type=ServerClassLoader,name=[server,common,shared] or
Catalina:type=WebappClassLoader,path=/myapps,host=localhost)
ref JMX Connection reference jmx.server
echo Echo command usage (access and result) false

Example to create remote mbean

ImageImageImage
Image
    <jmx:create
             ref="${jmx.reference}"
             name="Catalina:type=MBeanFactory"
             className="org.apache.commons.modeler.BaseModelMBean"
             classLoader="Catalina:type=ServerClassLoader,name=server">             
             <Arg value="org.apache.catalina.mbeans.MBeanFactory" />
    </jmx:create> 
Image
ImageImageImage

Warning: A lot of Tomcat mbeans can't be really create and connect with
the parent. The valve, cluster or realm Mbeans are not autconnect with there parent.
Use MBeanFacrory create operation instead.

JMXAccessorUnregisterTask: remote unregister mbean ant task

List of Attributes

Attribute Description Default value
name Full qualified JMX ObjectName -- Catalina:type=MBeanFactory
ref JMX Connection reference jmx.server
echo Echo command usage (access and result) false

Example to unregister remote mbean

ImageImageImage
Image
    <jmx:unregister
        name="Catalina:type=MBeanFactory" 
    />
Image
ImageImageImage

Warning: A lot of Tomcat mbeans can't be really unregister.
The Mbeans are not deregister from parent. Use MBeanFacrory
remove operation instead.

JMXAccessorCondition: express condition

List of Attributes

Attribute Description Default value
url Set jmx connection url - service:jmx:rmi:///jndi/rmi://localhost:8050/jmxrmi
host Set the host, shortcut the very long url syntax. localhost
port Set the remote connection port 8050
username remote jmx connection user name.
password remote jmx connection password.
ref Name of the internal connection reference. With this attribute you can configure more the one connection inside the same ant projekt. jmx.server
name Full qualified JMX ObjectName -- Catalina:type=Server
echo Echo condition usage (access and result) false
if Only execute if a property of the given name exists in the current project.
unless Only execute if a property of the given name not exists in the current project.
value (requiered) Second arg for operation
type Value type to express operation (support long and double) long
operation express one
  • == equals
  • != not equals
  • > greater than (&gt;)
  • >= greater than or equals (&gt;=)
  • < lesser than (&lt;)
  • <= lesser than or equals (&lt;=)
==

Wait for server connection and that cluster backup node is accessable

ImageImageImage
Image
      <target name="wait">
         <waitfor maxwait="${maxwait}" maxwaitunit="second" timeoutproperty="server.timeout" >
            <and>
                <socket server="${server.name}" port="${server.port}"/>
                <http url="${url}"/>
                <jmx:condition
                    operation="==" 
                    host="localhost" 
                    port="9014"
                    username="controlRole"
                    password="tomcat"
                    name="Catalina:type=IDataSender,host=localhost,senderAddress=192.168.111.1,senderPort=9025"
                    attribute="connected"
                    value="true"
                />
            </and>
        </waitfor>
        <fail if="server.timeout" message="Server ${url} don't answer inside ${maxwait} sec" />
        <echo message="Server ${url} alive" />
    </target>
Image
ImageImageImage

JMXAccessorEqualsCondition: equals Mbean ant condition

List of Attributes

Attribute Description Default value
url Set jmx connection url - service:jmx:rmi:///jndi/rmi://localhost:8050/jmxrmi
host Set the host, shortcut the very long url syntax. localhost
port Set the remote connection port 8050
username remote jmx connection user name.
password remote jmx connection password.
ref Name of the internal connection referenz. With this attribute you can configure more the one connection inside the same ant projekt. jmx.server
name Full qualified JMX ObjectName -- Catalina:type=Server
echo Echo condition usage (access and result) false

Wait for server connection and that cluster backup node is accessable

ImageImageImage
Image
      <target name="wait">
         <waitfor maxwait="${maxwait}" maxwaitunit="second" timeoutproperty="server.timeout" >
            <and>
                <socket server="${server.name}" port="${server.port}"/>
                <http url="${url}"/>
                <jmx:equals 
                    host="localhost" 
                    port="9014"
                    username="controlRole"
                    password="tomcat"
                    name="Catalina:type=IDataSender,host=localhost,senderAddress=192.168.111.1,senderPort=9025"
                    attribute="connected"
                    value="true"
                />
            </and>
        </waitfor>
        <fail if="server.timeout" message="Server ${url} don't answer inside ${maxwait} sec" />
        <echo message="Server ${url} alive" />
    </target>
Image
ImageImageImage


Copyright © 1999-2012, Apache Software Foundation