监视和管理Tomcat

刺骨的言语ヽ痛彻心扉 2023-10-05 15:18 20阅读 0赞

### 监视和管理Tomcat ###

#### 目录 ####

*  [介绍][Link 1]
 *  [启用JMX远程][JMX]
 *  [使用JMX远程Ant任务管理Tomcat][JMX_Ant_Tomcat]
 *  [JMXAccessorOpenTask-JMX打开连接任务][JMXAccessorOpenTask-JMX]
 *  [JMXAccessorGetTask：获取属性值Ant任务][JMXAccessorGetTask_Ant]
 *  [JMXAccessorSetTask：设置属性值Ant任务][JMXAccessorSetTask_Ant]
 *  [JMXAccessorInvokeTask：调用MBean操作Ant任务][JMXAccessorInvokeTask_MBean_Ant]
 *  [JMXAccessorQueryTask：查询MBean Ant任务][JMXAccessorQueryTask_MBean Ant]
 *  [JMXAccessorCreateTask：远程创建MBean Ant任务][JMXAccessorCreateTask_MBean Ant]
 *  [JMXAccessorUnregisterTask：远程注销MBean Ant任务][JMXAccessorUnregisterTask_MBean Ant]
 *  [JMXAccessorCondition：表达条件][JMXAccessorCondition]
 *  [JMXAccessorEqualsCondition：等于MBean Ant条件][JMXAccessorEqualsCondition_MBean Ant]
 *  [使用JMXProxyServlet][JMXProxyServlet]

#### 介绍 ####

监视是系统管理的关键方面。查看正在运行的服务器内部，获取一些统计信息或重新配置应用程序的某些方面，都是日常管理任务。

#### 启用JMX远程 ####

**注意：**仅当您要远程监视Tomcat时才需要此配置。如果要使用与Tomcat一起运行的同一用户在本地对其进行监视，则不需要它。

Oracle网站包含选项列表以及如何在Java 8上配置JMX Remote：[ http][http] : [//docs.oracle.com/javase/6/docs/technotes/guides/management/agent.html][http]。

以下是Java 8的快速配置指南：

将以下参数添加到`setenv.bat`Tomcat脚本中（有关详细信息，请参阅[RUNNING.txt][]）。  
*注意：*此语法适用于Microsoft Windows。该命令必须在同一行上。它被包装为更具可读性。如果Tomcat作为Windows服务运行，请使用其配置对话框为该服务设置java选项。对于Linux，MacOS等，请`"set "`从该行的开头删除。

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

如果您未设置，`com.sun.management.jmxremote.rmi.port`那么JSR 160 JMX-Adaptor将随机选择一个端口，这可能会难以配置防火墙以允许访问。

如果您需要TLS：

1.  更改并添加以下内容：
    
        -Dcom.sun.management.jmxremote.ssl=true
          -Dcom.sun.management.jmxremote.registry.ssl=true
2.  配置协议和/或密码套件使用：
    
        -Dcom.sun.management.jmxremote.ssl.enabled.protocols=%my.jmx.ssl.protocols%
          -Dcom.sun.management.jmxremote.ssl.enabled.cipher.suites=%my.jmx.cipher.suites%
3.  客户端证书身份验证使用：
    
        -Dcom.sun.management.jmxremote.ssl.need.client.auth=%my.jmx.ssl.clientauth%

如果您需要授权（强烈建议始终将TLS与身份验证一起使用）：

1.  更改并添加以下内容：
    
        -Dcom.sun.management.jmxremote.authenticate=true
          -Dcom.sun.management.jmxremote.password.file=../conf/jmxremote.password
          -Dcom.sun.management.jmxremote.access.file=../conf/jmxremote.access
2.  编辑访问授权文件*$ CATALINA\_BASE / conf / jmxremote.access*：
    
        monitorRole readonly
        controlRole readwrite
3.  编辑密码文件*$ CATALINA\_BASE / conf / jmxremote.password*：
    
        monitorRole tomcat
        controlRole tomcat
    
    **提示**：密码文件应该是只读的，并且只能由运行Tomcat的操作系统用户访问。
4.  或者，您可以使用以下方式配置JAAS登录模块：
    
        -Dcom.sun.management.jmxremote.login.config=%login.module.name%

如果您需要指定要在发送给客户端的RMI存根中使用的主机名（例如，由于必须用于连接的公共主机名与本地主机名不同），则可以设置：

set CATALINA_OPTS=-Djava.rmi.server.hostname

如果需要为JMX服务指定要绑定的特定接口，则可以设置：

set CATALINA_OPTS=-Dcom.sun.management.jmxremote.host

#### 使用JMX远程Ant任务管理Tomcat ####

为了简化Ant对JMX的使用，提供了一组可与antlib一起使用的任务。

**antlib**：将catalina-ant.jar从$ CATALINA\_HOME / lib复制到$ ANT\_HOME / lib。

下面的示例示出了访问器JMX使用：  
*注意：*该`name`属性值在这里缠绕成为更具有可读性。它必须全部在同一行上，没有空格。

<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"
 />
 
 <jmx:get
 name="Catalina:type=Manager,context=/ClusterTest,host=localhost"
 attribute="maxActiveSessions"
 resultproperty="clustertest.maxActiveSessions.orginal"
 echo="true"
 />
 
 <jmx:set
 name="Catalina:type=Manager,context=/ClusterTest,host=localhost"
 attribute="maxActiveSessions"
 value="100"
 type="int"
 />
 
 <jmx:invoke
 name="Catalina:type=Manager,context=/ClusterTest,host=localhost"
 operation="listSessionIds"
 resultproperty="sessions"
 echo="false"
 delimiter=" "
 />
 
 <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>
 
 <jmx:query
 name="Catalina:type=Manager,*"
 resultproperty="manager"
 echo="true"
 attributebinding="true"
 />
 
 <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 file =“ $ \{CATALINA.HOME\} /bin/catalina-tasks.xml” />*导入JMX Accessor项目， 并使用*jmxOpen*，*jmxSet*，*jmxGet*， *jmxQuery*，*jmxInvoke*，*jmxEquals*和*jmxCondition*引用任务。

#### JMXAccessorOpenTask-JMX打开连接任务 ####

属性清单

打开新的JMX连接的示例

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

使用URL打开具有授权的JMX连接并在其他参考处进行存储的示例

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

打开具有授权的URL并通过其他参考存储JMX连接的示例，但仅当属性*jmx.if*存在且 *jmx.unless*不存在时

<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"
 />

**注意**：*jmxOpen*任务的所有属性在所有其他任务和条件下也存在。

#### JMXAccessorGetTask：获取属性值Ant任务 ####

属性清单

从默认JMX连接获取远程MBean属性的示例

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

获取和结果数组并将其拆分为单独属性的示例

<jmx:get
 name="Catalina:type=ClusterSender,host=localhost"
 attribute="senderObjectNames"
 resultproperty="senderObjectNames"
 />

通过以下方式访问senderObjectNames属性：

${senderObjectNames.length} give the number of returned sender list.
      ${senderObjectNames.[0..N]} found all sender object names

仅在配置集群时使IDataSender属性连接的示例。  
*注意：*将`name`属性值包装在此处以便于阅读。它必须全部在同一行上，没有空格。

<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" />

#### JMXAccessorSetTask：设置属性值Ant任务 ####

属性清单

设置远程MBean属性值的示例

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

#### JMXAccessorInvokeTask：调用MBean操作Ant任务 ####

属性清单

停止申请

<jmx:invoke
 name="Catalina:type=Manager,context=/servlets-examples,host=localhost"
 operation="stop"/>

现在，您可以在*$ \{sessions。\[0..N\}\]*属性中找到sessionid，并使用$ \{sessions.length\}属性访问计数。

获取所有会话ID的示例

<jmx:invoke
 name="Catalina:type=Manager,context=/servlets-examples,host=localhost"
 operation="listSessionIds"
 resultproperty="sessions"
 delimiter=" "
 />

现在，您可以在*$ \{sessions。\[0..N\}\]*属性中找到sessionid，并使用$ \{sessions.length\}属性访问计数。

从会话$ \{sessionid.0\}获取远程MBean会话属性的示例

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

在vhost*本地主机*上创建新的访问记录器阀门的示例

<jmx:invoke
 name="Catalina:type=MBeanFactory"
 operation="createAccessLoggerValve"
 resultproperty="accessLoggerObjectName"
 >
 <arg value="Catalina:type=Host,host=localhost"/>
 </jmx:invoke>

现在，您可以找到名称存储在*$ \{accessLoggerObjectName\}* 属性中的新MBean 。

#### JMXAccessorQueryTask：查询MBean Ant任务 ####

属性清单

从所有服务和主机获取所有Manager ObjectNames

<jmx:query
 name="Catalina:type=Manager,*
 resultproperty="manager" />

现在，您可以在*$ \{manager。\[0..N\] .name\}* 属性中找到会话管理器，并使用$ \{manager.length\}属性访问结果对象计数器。

从*servlet-examples*应用程序获取Manager*的示例*绑定所有MBean属性

<jmx:query
 name="Catalina:type=Manager,context=/servlet-examples,host=localhost*"
 attributebinding="true"
 resultproperty="manager.servletExamples" />

现在，您可以在*$ \{manager.servletExamples.0.name\}*属性中找到管理器，并可以使用*$ \{manager.servletExamples.0。\[manager属性名称\]* \}从该管理器访问所有属性。MBeans的结果对象计数器存储在$ \{manager.length\}属性中。

从服务器获取所有MBean并将其存储在外部XML属性文件中的示例

现在，您可以在文件*mbeans.properties中*找到所有MBean 。

#### JMXAccessorCreateTask：远程创建MBean Ant任务 ####

属性清单

创建远程MBean的示例

<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>

**警告**：许多Tomcat MBean一旦  
创建就无法链接到其父级。Valve，Cluster和Realm MBean不会自动  
与其父级连接。请改用*MBeanFactory*创建  
操作。

#### JMXAccessorUnregisterTask：远程注销MBean Ant任务 ####

属性清单

取消注册远程MBean的示例

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

**警告**：不能取消注册许多Tomcat MBean。  
MBean并未与其父级解除链接。请改用*MBeanFactory*  
删除操作。

#### JMXAccessorCondition：表达条件 ####

属性清单

<table> 
 <tbody> 
 <tr> 
 <th style="text-align:left;">属性</th> 
 <th style="text-align:left;">描述</th> 
 <th style="text-align:left;">默认值</th> 
 </tr> 
 <tr> 
 <td>网址</td> 
 <td>设置JMX连接URL-&nbsp;service：jmx：rmi：/// jndi / rmi：// localhost：8050 / jmxrmi</td> 
 <td>&nbsp;</td> 
 </tr> 
 <tr> 
 <td>主办</td> 
 <td>设置主机，快捷方式非常长的URL语法。</td> 
 <td><code>localhost</code></td> 
 </tr> 
 <tr> 
 <td>港口</td> 
 <td>设置远程连接端口</td> 
 <td><code>8050</code></td> 
 </tr> 
 <tr> 
 <td>用户名</td> 
 <td>远程JMX连接用户名。</td> 
 <td>&nbsp;</td> 
 </tr> 
 <tr> 
 <td>密码</td> 
 <td>远程JMX连接密码。</td> 
 <td>&nbsp;</td> 
 </tr> 
 <tr> 
 <td>参考</td> 
 <td>内部连接引用的名称。使用此属性，您可以在同一Ant项目中配置更多一个连接。</td> 
 <td><code>jmx.server</code></td> 
 </tr> 
 <tr> 
 <td>名称</td> 
 <td>完全限定的JMX ObjectName-&nbsp;Catalina：type = Server</td> 
 <td>&nbsp;</td> 
 </tr> 
 <tr> 
 <td>回声</td> 
 <td>回声条件的使用（访问和结果）</td> 
 <td><code>false</code></td> 
 </tr> 
 <tr> 
 <td>如果</td> 
 <td>仅当当前项目中存在给定名称的属性时才执行。</td> 
 <td>&nbsp;</td> 
 </tr> 
 <tr> 
 <td>除非</td> 
 <td>仅当当前项目中不存在给定名称的属性时才执行。</td> 
 <td>&nbsp;</td> 
 </tr> 
 <tr> 
 <td>值（必填）</td> 
 <td>操作的第二个参数</td> 
 <td>&nbsp;</td> 
 </tr> 
 <tr> 
 <td>类型</td> 
 <td>表示操作的值类型（支持long和double）</td> 
 <td><code>long</code></td> 
 </tr> 
 <tr> 
 <td>操作</td> 
 <td>表达一个 
 <ul> 
 <li>==等于</li> 
 <li>！=不等于</li> 
 <li>&gt;大于（＆gt;）</li> 
 <li>&gt; =大于或等于（&gt; =）</li> 
 <li>&lt;小于（＆lt;）</li> 
 <li>&lt;=小于或等于（＆lt; =）</li> 
 </ul></td> 
 <td><code>==</code></td> 
 </tr> 
 </tbody> 
</table>

等待服务器连接，并且该群集备份节点可访问

#### JMXAccessorEqualsCondition：等于MBean Ant条件 ####

属性清单

等待服务器连接，并且该群集备份节点可访问

#### 使用JMXProxyServlet ####

Tomcat提供了使用远程（甚至本地）JMX连接的替代方法，同时仍使您可以访问JMX必须提供的所有功能：Tomcat的 [JMXProxyServlet][JMXProxyServlet 1]。

JMXProxyServlet允许客户端通过HTTP接口发出JMX查询。与直接从客户端程序使用JMX相比，该技术具有以下优点：

*  您不必启动完整的JVM并建立远程JMX连接，而只需从正在运行的服务器中请求一小部分数据
 *  您不必知道如何使用JMX连接
 *  您不需要本页面其余部分介绍的任何复杂配置
 *  您的客户端程序不必用Java编写

在流行的服务器监视软件（例如Nagios或Icinga）中，可以看到JMX过度杀伤的一个完美示例：如果要通过JMX监视10个项目，则必须启动10个JVM，建立10个JMX连接，然后关闭他们每隔几分钟就下来。使用JMXProxyServlet，您可以建立10个HTTP连接并完成它。

您可以在[Tomcat管理器][Tomcat]的文档中找到有关JMXProxyServlet的更多信息 。

[Link 1]: https://tomcat.apache.org/tomcat-9.0-doc/monitoring.html#Introduction
[JMX]: https://tomcat.apache.org/tomcat-9.0-doc/monitoring.html#Enabling_JMX_Remote
[JMX_Ant_Tomcat]: https://tomcat.apache.org/tomcat-9.0-doc/monitoring.html#Manage_Tomcat_with_JMX_remote_Ant_Tasks
[JMXAccessorOpenTask-JMX]: https://tomcat.apache.org/tomcat-9.0-doc/monitoring.html#JMXAccessorOpenTask_-_JMX_open_connection_task
[JMXAccessorGetTask_Ant]: https://tomcat.apache.org/tomcat-9.0-doc/monitoring.html#JMXAccessorGetTask:__get_attribute_value_Ant_task
[JMXAccessorSetTask_Ant]: https://tomcat.apache.org/tomcat-9.0-doc/monitoring.html#JMXAccessorSetTask:__set_attribute_value_Ant_task
[JMXAccessorInvokeTask_MBean_Ant]: https://tomcat.apache.org/tomcat-9.0-doc/monitoring.html#JMXAccessorInvokeTask:__invoke_MBean_operation_Ant_task
[JMXAccessorQueryTask_MBean Ant]: https://tomcat.apache.org/tomcat-9.0-doc/monitoring.html#JMXAccessorQueryTask:__query_MBean_Ant_task
[JMXAccessorCreateTask_MBean Ant]: https://tomcat.apache.org/tomcat-9.0-doc/monitoring.html#JMXAccessorCreateTask:__remote_create_MBean_Ant_task
[JMXAccessorUnregisterTask_MBean Ant]: https://tomcat.apache.org/tomcat-9.0-doc/monitoring.html#JMXAccessorUnregisterTask:__remote_unregister_MBean_Ant_task
[JMXAccessorCondition]: https://tomcat.apache.org/tomcat-9.0-doc/monitoring.html#JMXAccessorCondition:__express_condition
[JMXAccessorEqualsCondition_MBean Ant]: https://tomcat.apache.org/tomcat-9.0-doc/monitoring.html#JMXAccessorEqualsCondition:__equals_MBean_Ant_condition
[JMXProxyServlet]: https://tomcat.apache.org/tomcat-9.0-doc/monitoring.html#Using_the_JMXProxyServlet
[http]: https://docs.oracle.com/javase/8/docs/technotes/guides/management/agent.html
[RUNNING.txt]: https://tomcat.apache.org/tomcat-9.0-doc/RUNNING.txt
[JMXProxyServlet 1]: https://tomcat.apache.org/tomcat-9.0-doc/api/org/apache/catalina/manager/JMXProxyServlet.html
[Tomcat]: https://tomcat.apache.org/tomcat-9.0-doc/manager-howto.html#Using_the_JMX_Proxy_Servlet