Windows NT DGPENSV2LPKMN 10.0 build 14393 (Windows Server 2016) AMD64
Apache/2.4.46 (Win64) OpenSSL/1.1.1h PHP/7.3.25
: 172.16.0.66 | : 172.16.0.254
Cant Read [ /etc/named.conf ]
7.3.25
SYSTEM
www.github.com/MadExploits
Terminal
AUTO ROOT
Adminer
Backdoor Destroyer
Linux Exploit
Lock Shell
Lock File
Create User
CREATE RDP
PHP Mailer
BACKCONNECT
UNLOCK SHELL
HASH IDENTIFIER
CPANEL RESET
CREATE WP USER
BLACK DEFEND!
README
+ Create Folder
+ Create File
[ A ]
[ C ]
[ D ]
C: /
xampp7 /
tomcat /
webapps /
docs /
[ HOME SHELL ]
Name
Size
Permission
Action
WEB-INF
[ DIR ]
drwxrwxrwx
annotationapi
[ DIR ]
drwxrwxrwx
api
[ DIR ]
drwxrwxrwx
appdev
[ DIR ]
drwxrwxrwx
architecture
[ DIR ]
drwxrwxrwx
config
[ DIR ]
drwxrwxrwx
elapi
[ DIR ]
drwxrwxrwx
images
[ DIR ]
drwxrwxrwx
jspapi
[ DIR ]
drwxrwxrwx
servletapi
[ DIR ]
drwxrwxrwx
tribes
[ DIR ]
drwxrwxrwx
websocketapi
[ DIR ]
drwxrwxrwx
BUILDING.txt
17.97
KB
-rw-rw-rw-
RELEASE-NOTES.txt
9.37
KB
-rw-rw-rw-
RUNNING.txt
17.33
KB
-rw-rw-rw-
aio.html
22.25
KB
-rw-rw-rw-
apr.html
15.53
KB
-rw-rw-rw-
balancer-howto.html
8.06
KB
-rw-rw-rw-
building.html
19.12
KB
-rw-rw-rw-
cgi-howto.html
14.12
KB
-rw-rw-rw-
changelog.html
1.17
MB
-rw-rw-rw-
class-loader-howto.html
20.53
KB
-rw-rw-rw-
cluster-howto.html
46.48
KB
-rw-rw-rw-
comments.html
11.11
KB
-rw-rw-rw-
connectors.html
9.2
KB
-rw-rw-rw-
default-servlet.html
18.66
KB
-rw-rw-rw-
deployer-howto.html
24.29
KB
-rw-rw-rw-
developers.html
8.8
KB
-rw-rw-rw-
extras.html
11.79
KB
-rw-rw-rw-
host-manager-howto.html
16.8
KB
-rw-rw-rw-
html-host-manager-howto.html
15.19
KB
-rw-rw-rw-
html-manager-howto.html
33.65
KB
-rw-rw-rw-
index.html
16.88
KB
-rw-rw-rw-
introduction.html
19.73
KB
-rw-rw-rw-
jasper-howto.html
24.59
KB
-rw-rw-rw-
jdbc-pool.html
73.16
KB
-rw-rw-rw-
jndi-datasource-examples-howto...
38.54
KB
-rw-rw-rw-
jndi-resources-howto.html
55.82
KB
-rw-rw-rw-
logging.html
36.06
KB
-rw-rw-rw-
manager-howto.html
78.01
KB
-rw-rw-rw-
maven-jars.html
8.67
KB
-rw-rw-rw-
mbeans-descriptors-howto.html
8.79
KB
-rw-rw-rw-
mbeans-descriptors.dtd
11.04
KB
-rw-rw-rw-
monitoring.html
44.15
KB
-rw-rw-rw-
proxy-howto.html
13.69
KB
-rw-rw-rw-
realm-howto.html
64.14
KB
-rw-rw-rw-
security-howto.html
41.64
KB
-rw-rw-rw-
security-manager-howto.html
32.25
KB
-rw-rw-rw-
setup.html
15.17
KB
-rw-rw-rw-
ssi-howto.html
21.3
KB
-rw-rw-rw-
ssl-howto.html
43.15
KB
-rw-rw-rw-
virtual-hosting-howto.html
13.93
KB
-rw-rw-rw-
web-socket-howto.html
18.17
KB
-rw-rw-rw-
windows-auth-howto.html
25.28
KB
-rw-rw-rw-
windows-service-howto.html
25.36
KB
-rw-rw-rw-
Delete
Unzip
Zip
${this.title}
Close
Code Editor : monitoring.html
<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 7 (7.0.107) - Monitoring and Managing Tomcat</title><style type="text/css" media="print"> .noPrint {display: none;} td#mainBody {width: 100%;} </style><style type="text/css"> code {background-color:rgb(224,255,255);padding:0 0.1em;} code.attributeName, code.propertyName {background-color:transparent;} table { border-collapse: collapse; text-align: left; } table *:not(table) { /* Prevent border-collapsing for table child elements like <div> */ border-collapse: separate; } th { text-align: left; } div.codeBox pre code, code.attributeName, code.propertyName, code.noHighlight, .noHighlight code { background-color: transparent; } div.codeBox { overflow: auto; margin: 1em 0; } div.codeBox pre { margin: 0; padding: 4px; border: 1px solid #999; border-radius: 5px; background-color: #eff8ff; display: table; /* To prevent <pre>s from taking the complete available width. */ /* When it is officially supported, use the following CSS instead of display: table to prevent big <pre>s from exceeding the browser window: max-width: available; width: min-content; */ } div.codeBox pre.wrap { white-space: pre-wrap; } table.defaultTable tr, table.detail-table tr { border: 1px solid #CCC; } table.defaultTable tr:nth-child(even), table.detail-table tr:nth-child(even) { background-color: #FAFBFF; } table.defaultTable tr:nth-child(odd), table.detail-table tr:nth-child(odd) { background-color: #EEEFFF; } table.defaultTable th, table.detail-table th { background-color: #88b; color: #fff; } table.defaultTable th, table.defaultTable td, table.detail-table th, table.detail-table td { padding: 5px 8px; } p.notice { border: 1px solid rgb(255, 0, 0); background-color: rgb(238, 238, 238); color: rgb(0, 51, 102); padding: 0.5em; margin: 1em 2em 1em 1em; } </style></head><body bgcolor="#ffffff" text="#000000" link="#525D76" alink="#525D76" vlink="#525D76"><table border="0" width="100%" cellspacing="0"><!--PAGE HEADER--><tr><td><!--PROJECT LOGO--><a href="https://tomcat.apache.org/"><img src="./images/tomcat.gif" align="right" alt=" The Apache Tomcat Servlet/JSP Container " border="0"></a></td><td><h1><font face="arial,helvetica,sanserif">Apache Tomcat 7</font></h1><font face="arial,helvetica,sanserif">Version 7.0.107, Nov 18 2020</font></td><td><!--APACHE LOGO--><a href="http://www.apache.org/"><img src="./images/asf-logo.svg" align="right" alt="Apache Logo" border="0" style="width: 266px;height: 83px;"></a></td></tr></table><table border="0" width="100%" cellspacing="4"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><tr><!--LEFT SIDE NAVIGATION--><td width="20%" valign="top" nowrap class="noPrint"><p><strong>Links</strong></p><ul><li><a href="index.html">Docs Home</a></li><li><a href="https://wiki.apache.org/tomcat/FAQ">FAQ</a></li><li><a href="#comments_section">User Comments</a></li></ul><p><strong>User Guide</strong></p><ul><li><a href="introduction.html">1) Introduction</a></li><li><a href="setup.html">2) Setup</a></li><li><a href="appdev/index.html">3) First webapp</a></li><li><a href="deployer-howto.html">4) Deployer</a></li><li><a href="manager-howto.html">5) Manager</a></li><li><a href="host-manager-howto.html">6) Host Manager</a></li><li><a href="realm-howto.html">7) Realms and AAA</a></li><li><a href="security-manager-howto.html">8) Security Manager</a></li><li><a href="jndi-resources-howto.html">9) JNDI Resources</a></li><li><a href="jndi-datasource-examples-howto.html">10) JDBC DataSources</a></li><li><a href="class-loader-howto.html">11) Classloading</a></li><li><a href="jasper-howto.html">12) JSPs</a></li><li><a href="ssl-howto.html">13) SSL/TLS</a></li><li><a href="ssi-howto.html">14) SSI</a></li><li><a href="cgi-howto.html">15) CGI</a></li><li><a href="proxy-howto.html">16) Proxy Support</a></li><li><a href="mbeans-descriptors-howto.html">17) MBeans Descriptors</a></li><li><a href="default-servlet.html">18) Default Servlet</a></li><li><a href="cluster-howto.html">19) Clustering</a></li><li><a href="balancer-howto.html">20) Load Balancer</a></li><li><a href="connectors.html">21) Connectors</a></li><li><a href="monitoring.html">22) Monitoring and Management</a></li><li><a href="logging.html">23) Logging</a></li><li><a href="apr.html">24) APR/Native</a></li><li><a href="virtual-hosting-howto.html">25) Virtual Hosting</a></li><li><a href="aio.html">26) Advanced IO</a></li><li><a href="extras.html">27) Additional Components</a></li><li><a href="maven-jars.html">28) Mavenized</a></li><li><a href="security-howto.html">29) Security Considerations</a></li><li><a href="windows-service-howto.html">30) Windows Service</a></li><li><a href="windows-auth-howto.html">31) Windows Authentication</a></li><li><a href="jdbc-pool.html">32) Tomcat's JDBC Pool</a></li><li><a href="web-socket-howto.html">33) WebSocket</a></li></ul><p><strong>Reference</strong></p><ul><li><a href="RELEASE-NOTES.txt">Release Notes</a></li><li><a href="config/index.html">Configuration</a></li><li><a href="api/index.html">Tomcat Javadocs</a></li><li><a href="servletapi/index.html">Servlet Javadocs</a></li><li><a href="jspapi/index.html">JSP 2.2 Javadocs</a></li><li><a href="elapi/index.html">EL 2.2 Javadocs</a></li><li><a href="websocketapi/index.html">WebSocket 1.1 Javadocs</a></li><li><a href="annotationapi/index.html">Common Annotations 1.1 Javadocs</a></li><li><a href="https://tomcat.apache.org/connectors-doc/">JK 1.2 Documentation</a></li></ul><p><strong>Apache Tomcat Development</strong></p><ul><li><a href="building.html">Building</a></li><li><a href="changelog.html">Changelog</a></li><li><a href="https://wiki.apache.org/tomcat/TomcatVersions">Status</a></li><li><a href="developers.html">Developers</a></li><li><a href="architecture/index.html">Architecture</a></li><li><a href="tribes/introduction.html">Tribes</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left" id="mainBody"><h1>Monitoring and Managing Tomcat</h1><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Table of Contents"><!--()--></a><a name="Table_of_Contents"><strong>Table of Contents</strong></a></font></td></tr><tr><td><blockquote> <ul><li><a href="#Introduction">Introduction</a></li><li><a href="#Enabling_JMX_Remote">Enabling JMX Remote</a></li><li><a href="#Manage_Tomcat_with_JMX_remote_Ant_Tasks">Manage Tomcat with JMX remote Ant Tasks</a></li><li><a href="#JMXAccessorOpenTask_-_JMX_open_connection_task">JMXAccessorOpenTask - JMX open connection task</a></li><li><a href="#JMXAccessorGetTask:__get_attribute_value_Ant_task">JMXAccessorGetTask: get attribute value Ant task</a></li><li><a href="#JMXAccessorSetTask:__set_attribute_value_Ant_task">JMXAccessorSetTask: set attribute value Ant task</a></li><li><a href="#JMXAccessorInvokeTask:__invoke_MBean_operation_Ant_task">JMXAccessorInvokeTask: invoke MBean operation Ant task</a></li><li><a href="#JMXAccessorQueryTask:__query_MBean_Ant_task">JMXAccessorQueryTask: query MBean Ant task</a></li><li><a href="#JMXAccessorCreateTask:__remote_create_MBean_Ant_task">JMXAccessorCreateTask: remote create MBean Ant task</a></li><li><a href="#JMXAccessorUnregisterTask:__remote_unregister_MBean_Ant_task">JMXAccessorUnregisterTask: remote unregister MBean Ant task</a></li><li><a href="#JMXAccessorCondition:__express_condition">JMXAccessorCondition: express condition</a></li><li><a href="#JMXAccessorEqualsCondition:__equals_MBean_Ant_condition">JMXAccessorEqualsCondition: equals MBean Ant condition</a></li><li><a href="#Using_the_JMXProxyServlet">Using the JMXProxyServlet</a></li></ul> </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> <p>Monitoring is a key aspect of system administration. Looking inside a running server, obtaining some statistics or reconfiguring some aspects of an application are all daily administration tasks.</p> </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Enabling JMX Remote"><!--()--></a><a name="Enabling_JMX_Remote"><strong>Enabling JMX Remote</strong></a></font></td></tr><tr><td><blockquote> <p><strong>Note:</strong> This configuration is needed only if you are going to monitor Tomcat remotely. It is not needed if you are going to monitor it locally, using the same user that Tomcat runs with.</p> <p>The Oracle website includes the list of options and how to configure JMX Remote on Java 8: <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/management/agent.html"> http://docs.oracle.com/javase/6/docs/technotes/guides/management/agent.html</a>. </p> <p>The following is a quick configuration guide for Java 8:</p> <p>Add the following parameters to <code>setenv.bat</code> script of your Tomcat (see <a href="RUNNING.txt">RUNNING.txt</a> for details).<br> <em>Note:</em> This syntax is for Microsoft Windows. The command has to be on the same line. It is wrapped to be more readable. If Tomcat is running as a Windows service, use its configuration dialog to set java options for the service. For Linux, MacOS, etc, remove <code>"set "</code> from beginning of the line. </p> <div class="codeBox"><pre><code>set CATALINA_OPTS=-Dcom.sun.management.jmxremote.port=%my.jmx.port% -Dcom.sun.management.jmxremote.rmi.port=%my.rmi.port% -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false</code></pre></div> <p>If you don't set <code>com.sun.management.jmxremote.rmi.port</code> then the JSR 160 JMX-Adaptor will select a port at random which will may it difficult to configure a firewall to allow access.</p> <p>If you require TLS:</p> <ol> <li>change and add this: <div class="codeBox"><pre><code> -Dcom.sun.management.jmxremote.ssl=true -Dcom.sun.management.jmxremote.registry.ssl=true </code></pre></div></li> <li>to configure the protocols and/or cipher suites use: <div class="codeBox"><pre><code> -Dcom.sun.management.jmxremote.ssl.enabled.protocols=%my.jmx.ssl.protocols% -Dcom.sun.management.jmxremote.ssl.enabled.cipher.suites=%my.jmx.cipher.suites% </code></pre></div></li> <li>to client certificate authentication use: <div class="codeBox"><pre><code> -Dcom.sun.management.jmxremote.ssl.need.client.auth=%my.jmx.ssl.clientauth%</code></pre></div></li> </ol> <p>If you require authorization (it is strongly recommended that TLS is always used with authentication):</p> <ol> <li>change and add this: <div class="codeBox"><pre><code> -Dcom.sun.management.jmxremote.authenticate=true -Dcom.sun.management.jmxremote.password.file=../conf/jmxremote.password -Dcom.sun.management.jmxremote.access.file=../conf/jmxremote.access</code></pre></div> </li> <li>edit the access authorization file <em>$CATALINA_BASE/conf/jmxremote.access</em>: <div class="codeBox"><pre><code>monitorRole readonly controlRole readwrite</code></pre></div> </li> <li>edit the password file <em>$CATALINA_BASE/conf/jmxremote.password</em>: <div class="codeBox"><pre><code>monitorRole tomcat controlRole tomcat</code></pre></div> <b>Tip</b>: The password file should be read-only and only accessible by the operating system user Tomcat is running as. </li> <li>Alterantively, you can configure a JAAS login module with: <div class="codeBox"><pre><code> -Dcom.sun.management.jmxremote.login.config=%login.module.name%</code></pre></div></li> </ol> <p>If you need to specify a host name to be used in the RMI stubs sent to the client (e.g. because the public host name that must be used to connect is not the same as the local host name) then you can set:</p> <div class="codeBox"><pre><code>set CATALINA_OPTS=-Djava.rmi.server.hostname</code></pre></div> <p>If you need to specify a specific interface for the JMX service to bind to then you can set:</p> <div class="codeBox"><pre><code>set CATALINA_OPTS=-Dcom.sun.management.jmxremote.host</code></pre></div> </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Manage Tomcat with JMX remote Ant Tasks"><!--()--></a><a name="Manage_Tomcat_with_JMX_remote_Ant_Tasks"><strong>Manage Tomcat with JMX remote Ant Tasks</strong></a></font></td></tr><tr><td><blockquote> <p>To simplify JMX usage with Ant, a set of tasks is provided that may be used with antlib.</p> <p><b>antlib</b>: Copy your catalina-ant.jar from $CATALINA_HOME/lib to $ANT_HOME/lib.</p> <p>The following example shows the JMX Accessor usage:<br> <em>Note:</em> The <code>name</code> attribute value was wrapped here to be more readable. It has to be all on the same line, without spaces.</p> <table border="1"> <tr><td><pre> <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,context=/ClusterTest,host=localhost" attribute="maxActiveSessions" resultproperty="clustertest.maxActiveSessions.orginal" echo="true" /> <!-- set maxActiveSession to 100 --> <jmx:set name="Catalina:type=Manager,context=/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,context=/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,context=/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> </pre> </td></tr> </table> <p><b>import:</b> Import the JMX Accessor Project with <em><import file="${CATALINA.HOME}/bin/catalina-tasks.xml" /></em> and reference the tasks with <em>jmxOpen</em>, <em>jmxSet</em>, <em>jmxGet</em>, <em>jmxQuery</em>, <em>jmxInvoke</em>, <em>jmxEquals</em> and <em>jmxCondition</em>.</p> </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="JMXAccessorOpenTask - JMX open connection task"><!--()--></a><a name="JMXAccessorOpenTask_-_JMX_open_connection_task"><strong>JMXAccessorOpenTask - JMX open connection task</strong></a></font></td></tr><tr><td><blockquote> <p> List of Attributes<br> <table border="1" cellpadding="5"> <tr> <th align="center" bgcolor="aqua">Attribute</th> <th align="center" bgcolor="aqua">Description</th> <th align="center" bgcolor="aqua">Default value</th> </tr> <tr> <td>url</td> <td>Set JMX connection URL - <em>service:jmx:rmi:///jndi/rmi://localhost:8050/jmxrmi</em> </td> <td></td> </tr> <tr> <td>host</td> <td>Set the host, shortcut the very long URL syntax. </td> <td><code>localhost</code></td> </tr> <tr> <td>port</td> <td>Set the remote connection port </td> <td><code>8050</code></td> </tr> <tr> <td>username</td> <td>remote JMX connection user name. </td> <td></td> </tr> <tr> <td>password</td> <td>remote JMX connection password. </td> <td></td> </tr> <tr> <td>ref</td> <td>Name of the internal connection reference. With this attribute you can configure more the one connection inside the same Ant project. </td> <td><code>jmx.server</code></td> </tr> <tr> <td>echo</td> <td>Echo the command usage (for access analysis or debugging) </td> <td><code>false</code></td> </tr> <tr> <td>if</td> <td>Only execute if a property of the given name <b>exists</b> in the current project. </td> <td></td> </tr> <tr> <td>unless</td> <td>Only execute if a property of the given name <b>not exists</b> in the current project. </td> <td></td> </tr> </table> </p> <p> Example to open a new JMX connection<br> <div class="codeBox"><pre><code> <jmx:open host="${jmx.server.name}" port="${jmx.server.port}" /> </code></pre></div> </p> <p> Example to open a JMX connection from URL, with authorization and store at other reference <br> <div class="codeBox"><pre><code> <jmx:open url="service:jmx:rmi:///jndi/rmi://localhost:9024/jmxrmi" ref="jmx.server.9024" username="controlRole" password="tomcat" /> </code></pre></div> </p> <p> Example to open a JMX connection from URL, with authorization and store at other reference, but only when property <em>jmx.if</em> exists and <em>jmx.unless</em> not exists<br> <div class="codeBox"><pre><code> <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" /> </code></pre></div> </p> <p><b>Note</b>: All properties from <em>jmxOpen</em> task also exists at all other tasks and conditions. </p> </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="JMXAccessorGetTask: get attribute value Ant task"><!--()--></a><a name="JMXAccessorGetTask:__get_attribute_value_Ant_task"><strong>JMXAccessorGetTask: get attribute value Ant task</strong></a></font></td></tr><tr><td><blockquote> <p> List of Attributes<br> <table border="1" cellpadding="5"> <tr> <th align="center" bgcolor="aqua">Attribute</th> <th align="center" bgcolor="aqua">Description</th> <th align="center" bgcolor="aqua">Default value</th> </tr> <tr> <td>name</td> <td>Full qualified JMX ObjectName -- <em>Catalina:type=Server</em> </td> <td></td> </tr> <tr> <td>attribute</td> <td>Existing MBean attribute (see Tomcat MBean description above) </td> <td></td> </tr> <tr> <td>ref</td> <td>JMX Connection reference </td> <td><code>jmx.server</code></td> </tr> <tr> <td>echo</td> <td>Echo command usage (access and result) </td> <td><code>false</code></td> </tr> <tr> <td>resultproperty</td> <td>Save result at this project property </td> <td></td> </tr> <tr> <td>delimiter</td> <td>Split result with delimiter (java.util.StringTokenizer) and use resultproperty as prefix to store tokens. </td> <td></td> </tr> <tr> <td>separatearrayresults</td> <td>When return value is an array, save result as property list (<em>$resultproperty.[0..N]</em> and <em>$resultproperty.length</em>) </td> <td><code>true</code></td> </tr> </table> </p> <p> Example to get remote MBean attribute from default JMX connection <br> <div class="codeBox"><pre><code> <jmx:get name="Catalina:type=Manager,context=/servlets-examples,host=localhost" attribute="maxActiveSessions" resultproperty="servlets-examples.maxActiveSessions" /> </code></pre></div> </p> <p> Example to get and result array and split it at separate properties<br> <div class="codeBox"><pre><code> <jmx:get name="Catalina:type=ClusterSender,host=localhost" attribute="senderObjectNames" resultproperty="senderObjectNames" /> </code></pre></div> Access the senderObjectNames properties with: <div class="codeBox"><pre><code> ${senderObjectNames.length} give the number of returned sender list. ${senderObjectNames.[0..N]} found all sender object names </code></pre></div> </p> <p> Example to get IDataSender attribute connected only when cluster is configured.<br> <em>Note:</em> The <code>name</code> attribute value was wrapped here to be more readable. It has to be all on the same line, without spaces. </p> <div class="codeBox"><pre><code> <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" /> </code></pre></div> </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="JMXAccessorSetTask: set attribute value Ant task"><!--()--></a><a name="JMXAccessorSetTask:__set_attribute_value_Ant_task"><strong>JMXAccessorSetTask: set attribute value Ant task</strong></a></font></td></tr><tr><td><blockquote> <p> List of Attributes<br> <table border="1" cellpadding="5"> <tr> <th align="center" bgcolor="aqua">Attribute</th> <th align="center" bgcolor="aqua">Description</th> <th align="center" bgcolor="aqua">Default value</th> </tr> <tr> <td>name</td> <td>Full qualified JMX ObjectName -- <em>Catalina:type=Server</em> </td> <td></td> </tr> <tr> <td>attribute</td> <td>Existing MBean attribute (see Tomcat MBean description above) </td> <td></td> </tr> <tr> <td>value</td> <td>value that set to attribute </td> <td></td> </tr> <tr> <td>type</td> <td>type of the attribute. </td> <td>java.lang.String</td> </tr> <tr> <td>ref</td> <td>JMX Connection reference </td> <td><code>jmx.server</code></td> </tr> <tr> <td>echo</td> <td>Echo command usage (access and result) </td> <td><code>false</code></td> </tr> </table> </p> <p> Example to set remote MBean attribute value<br> <div class="codeBox"><pre><code> <jmx:set name="Catalina:type=Manager,context=/servlets-examples,host=localhost" attribute="maxActiveSessions" value="500" type="int" /> </code></pre></div> </p> </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="JMXAccessorInvokeTask: invoke MBean operation Ant task"><!--()--></a><a name="JMXAccessorInvokeTask:__invoke_MBean_operation_Ant_task"><strong>JMXAccessorInvokeTask: invoke MBean operation Ant task</strong></a></font></td></tr><tr><td><blockquote> <p> List of Attributes<br> <table border="1" cellpadding="5"> <tr> <th align="center" bgcolor="aqua">Attribute</th> <th align="center" bgcolor="aqua">Description</th> <th align="center" bgcolor="aqua">Default value</th> </tr> <tr> <td>name</td> <td>Full qualified JMX ObjectName -- <em>Catalina:type=Server</em> </td> <td></td> </tr> <tr> <td>operation</td> <td>Existing MBean operation </td> <td></td> </tr> <tr> <td>ref</td> <td>JMX Connection reference </td> <td><code>jmx.server</code></td> </tr> <tr> <td>echo</td> <td>Echo command usage (access and result) </td> <td><code>false</code></td> </tr> <tr> <td>resultproperty</td> <td>Save result at this project property </td> <td></td> </tr> <tr> <td>delimiter</td> <td>Split result with delimiter (java.util.StringTokenizer) and use resultproperty as prefix to store tokens. </td> <td></td> </tr> <tr> <td>separatearrayresults</td> <td>When return value is an array, save result as property list (<em>$resultproperty.[0..N]</em> and <em>$resultproperty.length</em>) </td> <td><code>true</code></td> </tr> </table> </p> <p> stop an application <br> <div class="codeBox"><pre><code> <jmx:invoke name="Catalina:type=Manager,context=/servlets-examples,host=localhost" operation="stop"/> </code></pre></div> Now you can find the sessionid at <em>${sessions.[0..N}</em> properties and access the count with ${sessions.length} property. </p> <p> Example to get all sessionids <br> <div class="codeBox"><pre><code> <jmx:invoke name="Catalina:type=Manager,context=/servlets-examples,host=localhost" operation="listSessionIds" resultproperty="sessions" delimiter=" " /> </code></pre></div> Now you can find the sessionid at <em>${sessions.[0..N}</em> properties and access the count with ${sessions.length} property. </p> <p> Example to get remote MBean session attribute from session ${sessionid.0}<br> <div class="codeBox"><pre><code> <jmx:invoke name="Catalina:type=Manager,context=/ClusterTest,host=localhost" operation="getSessionAttribute" resultproperty="hello"> <arg value="${sessionid.0}"/> <arg value="Hello" /> </jmx:invoke> </code></pre></div> </p> <p> Example to create a new access logger valve at vhost <em>localhost</em> <div class="codeBox"><pre><code> <jmx:invoke name="Catalina:type=MBeanFactory" operation="createAccessLoggerValve" resultproperty="accessLoggerObjectName" > <arg value="Catalina:type=Host,host=localhost"/> </jmx:invoke> </code></pre></div> Now you can find new MBean with name stored at <em>${accessLoggerObjectName}</em> property. </p> </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="JMXAccessorQueryTask: query MBean Ant task"><!--()--></a><a name="JMXAccessorQueryTask:__query_MBean_Ant_task"><strong>JMXAccessorQueryTask: query MBean Ant task</strong></a></font></td></tr><tr><td><blockquote> <p> List of Attributes<br> <table border="1" cellpadding="5"> <tr> <th align="center" bgcolor="aqua">Attribute</th> <th align="center" bgcolor="aqua">Description</th> <th align="center" bgcolor="aqua">Default value</th> </tr> <tr> <td>name</td> <td>JMX ObjectName query string -- <em>Catalina:type=Manager,*</em> </td> <td></td> </tr> <tr> <td>ref</td> <td>JMX Connection reference </td> <td><code>jmx.server</code></td> </tr> <tr> <td>echo</td> <td>Echo command usage (access and result) </td> <td><code>false</code></td> </tr> <tr> <td>resultproperty</td> <td>Prefix project property name to all founded MBeans (<em>mbeans.[0..N].objectname</em>) </td> <td></td> </tr> <tr> <td>attributebinding</td> <td>bind ALL MBean attributes in addition to <em>name</em> </td> <td><code>false</code></td> </tr> <tr> <td>delimiter</td> <td>Split result with delimiter (java.util.StringTokenizer) and use resultproperty as prefix to store tokens. </td> <td></td> </tr> <tr> <td>separatearrayresults</td> <td>When return value is an array, save result as property list (<em>$resultproperty.[0..N]</em> and <em>$resultproperty.length</em>) </td> <td><code>true</code></td> </tr> </table> </p> <p> Get all Manager ObjectNames from all services and Hosts <br> <div class="codeBox"><pre><code> <jmx:query name="Catalina:type=Manager,* resultproperty="manager" /> </code></pre></div> Now you can find the Session Manager at <em>${manager.[0..N].name}</em> properties and access the result object counter with ${manager.length} property. </p> <p> Example to get the Manager from <em>servlet-examples</em> application an bind all MBean properties<br> <div class="codeBox"><pre><code> <jmx:query name="Catalina:type=Manager,context=/servlet-examples,host=localhost*" attributebinding="true" resultproperty="manager.servletExamples" /> </code></pre></div> Now you can find the manager at <em>${manager.servletExamples.0.name}</em> property and can access all properties from this manager with <em>${manager.servletExamples.0.[manager attribute names]</em>}. The result object counter from MBeans is stored ad ${manager.length} property. </p> <p> Example to get all MBeans from a server and store inside an external XML property file<br> <div class="codeBox"><pre><code> <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> </code></pre></div> Now you can find all MBeans inside the file <em>mbeans.properties</em>. </p> </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="JMXAccessorCreateTask: remote create MBean Ant task"><!--()--></a><a name="JMXAccessorCreateTask:__remote_create_MBean_Ant_task"><strong>JMXAccessorCreateTask: remote create MBean Ant task</strong></a></font></td></tr><tr><td><blockquote> <p> List of Attributes<br> <table border="1" cellpadding="5"> <tr> <th align="center" bgcolor="aqua">Attribute</th> <th align="center" bgcolor="aqua">Description</th> <th align="center" bgcolor="aqua">Default value</th> </tr> <tr> <td>name</td> <td>Full qualified JMX ObjectName -- <em>Catalina:type=MBeanFactory</em> </td> <td></td> </tr> <tr> <td>className</td> <td>Existing MBean full qualified class name (see Tomcat MBean description above) </td> <td></td> </tr> <tr> <td>classLoader</td> <td>ObjectName of server or web application classloader <br> ( <em>Catalina:type=ServerClassLoader,name=[server,common,shared]</em> or<br> <em>Catalina:type=WebappClassLoader,context=/myapps,host=localhost</em>) </td> <td></td> </tr> <tr> <td>ref</td> <td>JMX Connection reference </td> <td><code>jmx.server</code></td> </tr> <tr> <td>echo</td> <td>Echo command usage (access and result) </td> <td><code>false</code></td> </tr> </table> </p> <p> Example to create remote MBean<br> <div class="codeBox"><pre><code> <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> </code></pre></div> </p> <p> <b>Warning</b>: Many Tomcat MBeans can't be linked to their parent once<br> created. The Valve, Cluster and Realm MBeans are not automatically<br> connected with their parent. Use the <em>MBeanFactory</em> create<br> operation instead. </p> </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="JMXAccessorUnregisterTask: remote unregister MBean Ant task"><!--()--></a><a name="JMXAccessorUnregisterTask:__remote_unregister_MBean_Ant_task"><strong>JMXAccessorUnregisterTask: remote unregister MBean Ant task</strong></a></font></td></tr><tr><td><blockquote> <p> List of Attributes<br> <table border="1" cellpadding="5"> <tr> <th align="center" bgcolor="aqua">Attribute</th> <th align="center" bgcolor="aqua">Description</th> <th align="center" bgcolor="aqua">Default value</th> </tr> <tr> <td>name</td> <td>Full qualified JMX ObjectName -- <em>Catalina:type=MBeanFactory</em> </td> <td></td> </tr> <tr> <td>ref</td> <td>JMX Connection reference </td> <td><code>jmx.server</code></td> </tr> <tr> <td>echo</td> <td>Echo command usage (access and result) </td> <td><code>false</code></td> </tr> </table> </p> <p> Example to unregister remote MBean<br> <div class="codeBox"><pre><code> <jmx:unregister name="Catalina:type=MBeanFactory" /> </code></pre></div> </p> <p> <b>Warning</b>: A lot of Tomcat MBeans can't be unregister.<br> The MBeans are not unlinked from their parent. Use <em>MBeanFactory</em><br> remove operation instead. </p> </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="JMXAccessorCondition: express condition"><!--()--></a><a name="JMXAccessorCondition:__express_condition"><strong>JMXAccessorCondition: express condition</strong></a></font></td></tr><tr><td><blockquote> <p> List of Attributes<br> <table border="1" cellpadding="5"> <tr> <th align="center" bgcolor="aqua">Attribute</th> <th align="center" bgcolor="aqua">Description</th> <th align="center" bgcolor="aqua">Default value</th> </tr> <tr> <td>url</td> <td>Set JMX connection URL - <em>service:jmx:rmi:///jndi/rmi://localhost:8050/jmxrmi</em> </td> <td></td> </tr> <tr> <td>host</td> <td>Set the host, shortcut the very long URL syntax. </td> <td><code>localhost</code></td> </tr> <tr> <td>port</td> <td>Set the remote connection port </td> <td><code>8050</code></td> </tr> <tr> <td>username</td> <td>remote JMX connection user name. </td> <td></td> </tr> <tr> <td>password</td> <td>remote JMX connection password. </td> <td></td> </tr> <tr> <td>ref</td> <td>Name of the internal connection reference. With this attribute you can configure more the one connection inside the same Ant project. </td> <td><code>jmx.server</code></td> </tr> <tr> <td>name</td> <td>Full qualified JMX ObjectName -- <em>Catalina:type=Server</em> </td> <td></td> </tr> <tr> <td>echo</td> <td>Echo condition usage (access and result) </td> <td><code>false</code></td> </tr> <tr> <td>if</td> <td>Only execute if a property of the given name <b>exists</b> in the current project. </td> <td></td> </tr> <tr> <td>unless</td> <td>Only execute if a property of the given name <b>not exists</b> in the current project. </td> <td></td> </tr> <tr> <td>value (required)</td> <td>Second arg for operation </td> <td></td> </tr> <tr> <td>type</td> <td>Value type to express operation (support <em>long</em> and <em>double</em>) </td> <td><code>long</code></td> </tr> <tr> <td>operation</td> <td> express one <ul> <li>== equals</li> <li>!= not equals</li> <li>> greater than (&gt;)</li> <li>>= greater than or equals (&gt;=)</li> <li>< lesser than (&lt;)</li> <li><= lesser than or equals (&lt;=)</li> </ul> </td> <td><code>==</code></td> </tr> </table> </p> <p> Wait for server connection and that cluster backup node is accessible<br> <div class="codeBox"><pre><code> <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> </code></pre></div> </p> </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="JMXAccessorEqualsCondition: equals MBean Ant condition"><!--()--></a><a name="JMXAccessorEqualsCondition:__equals_MBean_Ant_condition"><strong>JMXAccessorEqualsCondition: equals MBean Ant condition</strong></a></font></td></tr><tr><td><blockquote> <p> List of Attributes<br> <table border="1" cellpadding="5"> <tr> <th align="center" bgcolor="aqua">Attribute</th> <th align="center" bgcolor="aqua">Description</th> <th align="center" bgcolor="aqua">Default value</th> </tr> <tr> <td>url</td> <td>Set JMX connection URL - <em>service:jmx:rmi:///jndi/rmi://localhost:8050/jmxrmi</em> </td> <td></td> </tr> <tr> <td>host</td> <td>Set the host, shortcut the very long URL syntax. </td> <td><code>localhost</code></td> </tr> <tr> <td>port</td> <td>Set the remote connection port </td> <td><code>8050</code></td> </tr> <tr> <td>username</td> <td>remote JMX connection user name. </td> <td></td> </tr> <tr> <td>password</td> <td>remote JMX connection password. </td> <td></td> </tr> <tr> <td>ref</td> <td>Name of the internal connection reference. With this attribute you can configure more the one connection inside the same Ant project. </td> <td><code>jmx.server</code></td> </tr> <tr> <td>name</td> <td>Full qualified JMX ObjectName -- <em>Catalina:type=Server</em> </td> <td></td> </tr> <tr> <td>echo</td> <td>Echo condition usage (access and result) </td> <td><code>false</code></td> </tr> </table> </p> <p> Wait for server connection and that cluster backup node is accessible<br> <div class="codeBox"><pre><code> <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> </code></pre></div> </p> </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Using the JMXProxyServlet"><!--()--></a><a name="Using_the_JMXProxyServlet"><strong>Using the JMXProxyServlet</strong></a></font></td></tr><tr><td><blockquote> <p> Tomcat offers an alternative to using remote (or even local) JMX connections while still giving you access to everything JMX has to offer: Tomcat's <a href="api/org/apache/catalina/manager/JMXProxyServlet.html">JMXProxyServlet</a>. </p> <p> The JMXProxyServlet allows a client to issue JMX queries via an HTTP interface. This technique offers the following advantages over using JMX directly from a client program: </p> <ul> <li>You don't have to launch a full JVM and make a remote JMX connection just to ask for one small piece of data from a running server</li> <li>You don't have to know how to work with JMX connections</li> <li>You don't need any of the complex configuration covered in the rest of this page</li> <li>Your client program does not have to be written in Java</li> </ul> <p> A perfect example of JMX overkill can be seen in the case of popular server-monitoring software such as Nagios or Icinga: if you want to monitor 10 items via JMX, you will have to launch 10 JVMs, make 10 JMX connections, and then shut them all down every few minutes. With the JMXProxyServlet, you can make 10 HTTP connections and be done with it. </p> <p> You can find out more information about the JMXProxyServlet in the documentation for the <a href="manager-howto.html#Using_the_JMX_Proxy_Servlet">Tomcat manager</a>. </p> </blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em> Copyright © 1999-2020, Apache Software Foundation </em></font></div></td></tr></table></body></html>
Close
