監(jiān)控是系統(tǒng)管理中的重要環(huán)節(jié)。系統(tǒng)管理員的日常工作就包括:觀察服務(wù)器的運(yùn)行細(xì)節(jié),獲取統(tǒng)計(jì)數(shù)據(jù),或者重新配置應(yīng)用的某些內(nèi)容。
注意:該配置只適用于需用遠(yuǎn)程監(jiān)控 Tomcat 的情況,使用同樣的用戶(hù)在本地監(jiān)控 Tomcat 則不需要這么配置。
Oracle 的網(wǎng)站上介紹了如何在 Java 6 上配置 JMX 遠(yuǎn)程: http://docs.oracle.com/javase/6/docs/technotes/guides/management/agent.html。
下面是在 Java 6 上的快速配置向?qū)В?/p>
將下列參數(shù)添加到 Tomcat 的 setenv.bat
腳本(具體詳細(xì)信息請(qǐng)查看 RUNNING.txt)。
注意:該語(yǔ)法格式適用于 Windows 系統(tǒng)。命令行只能寫(xiě)在同一行中,包裝起來(lái)更具可讀性。如果 Tomcat 以 Windows 服務(wù)的形式運(yùn)行,使用它的系統(tǒng)配置對(duì)話設(shè)置該服務(wù)的 java 選項(xiàng)。對(duì)于 UN\*X
系統(tǒng)來(lái)說(shuō),要將命令行開(kāi)頭的 "set "
去掉。
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
1.如果需要授權(quán),則添加并修改下列命令:
-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.編輯訪問(wèn)權(quán)限文件 $CATALINA_BASE/conf/jmxremote.access
:
monitorRole readonly
controlRole readwrite
3.編輯密碼文件 $CATALINA_BASE/conf/jmxremote.password
:
monitorRole tomcat
controlRole tomcat
技巧:密碼文件應(yīng)該是只讀的,并且只能被運(yùn)行 Tomcat 的操作系統(tǒng)用戶(hù)所訪問(wèn)。
注意:JSR 160 JMX 適配器在一個(gè)隨機(jī)端口上打開(kāi)了第二個(gè)數(shù)據(jù)通道。假如本地安裝了防火墻,這就會(huì)出現(xiàn)問(wèn)題。要想解決它,可以按照偵聽(tīng)器文檔中介紹的方法,配置一個(gè) JmxRemoteLifecycleListener
。
為了簡(jiǎn)化 JMX 的用法,加入了一些可能會(huì)與 antlib 使用的一系列任務(wù)。
antlib:將 catalina-ant.jar 從 $CATALINA_HOME/lib
復(fù)制到 $ANT_HOME/lib
。
下面的例子展示了 JMX 存儲(chǔ)器的用法。
注意:為了提高可讀性,這里將 name
屬性值予以包裝。它必須寫(xiě)在同一行中,不允許帶有空格。
<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>
導(dǎo)入:利用 <import file="${CATALINA.HOME}/bin/catalina-tasks.xml" />
導(dǎo)入 JMX 存取器項(xiàng)目,利用 jmxOpen、jmxSet、jmxGet、jmxQuery、jmxInvoke、jmxEquals 和 jmxCondition 來(lái)引用任務(wù)。
屬性列表
屬性 | 描述 | 默認(rèn)值 |
---|---|---|
url | 設(shè)定 JMX 連接 URL——service:jmx:rmi:///jndi/rmi://localhost:8050/jmxrmi
|
- |
host | 設(shè)定主機(jī),縮短長(zhǎng)的 URL 格式 | localhost
|
port | 設(shè)定遠(yuǎn)程連接端口 | 8050 |
username | 遠(yuǎn)程 JMX 連接用戶(hù)名 | - |
password | 遠(yuǎn)程 JMX 連接密碼 | - |
ref | 內(nèi)部連接引用的名稱(chēng)。利用該屬性,在同一個(gè) Ant 項(xiàng)目中配置不止一個(gè)連接 | jmx.server |
echo | Echo 命令用途(用于訪問(wèn)分析或調(diào)試) | false
|
if | 只有當(dāng)指定名稱(chēng)的屬性存在于當(dāng)前項(xiàng)目時(shí)才執(zhí)行 | - |
unless | 只有當(dāng)指定名稱(chēng)的屬性不存在于當(dāng)前項(xiàng)目時(shí)才執(zhí)行 | - |
打開(kāi)新的 JMX 連接的范例如下:
<jmx:open
host="${jmx.server.name}"
port="${jmx.server.port}"
/>
打開(kāi)指定 URL 的 JMX 連接的范例,帶有授權(quán)并存儲(chǔ)在其他引用中:
<jmx:open
url="service:jmx:rmi:///jndi/rmi://localhost:9024/jmxrmi"
ref="jmx.server.9024"
username="controlRole"
password="tomcat"
/>
打開(kāi)指定 URL 的 JMX 連接的范例,帶有授權(quán)并存儲(chǔ)在其他引用中,但是必須要求 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 任務(wù)中所有屬性也存在于其他所有任務(wù)和條件中。
屬性列表
屬性 | 描述 | 默認(rèn)值 |
---|---|---|
name
|
完全限定的 JMX ObjectName——Catalina:type=Server | - |
attribute
|
已有的 MBean 屬性(參看上文介紹的 Tomcat MBean 描述) | - |
ref
|
JMX 連接引用 | jmx.server
|
echo
|
Echo 命令用途(訪問(wèn)與結(jié)果) | false
|
resultproperty
|
在該項(xiàng)目屬性中保存結(jié)果 | - |
delimiter
|
用分隔符(java.util.StringTokenizier )分隔結(jié)果,使用 resultproperty 作為前綴來(lái)保存令牌 |
- |
separatearrayresults
|
返回值為數(shù)組時(shí),將結(jié)果保存為屬性列表($resultproperty.[0..N] 和 $resultproperty.length) | true
|
從默認(rèn)的 JMX 連接中獲取遠(yuǎn)程 MBean 屬性:
<jmx:get
name="Catalina:type=Manager,context=/servlets-examples,host=localhost"
attribute="maxActiveSessions"
resultproperty="servlets-examples.maxActiveSessions"
/>
獲取結(jié)果數(shù)組,并將其分隔成獨(dú)立的一些屬性:
<jmx:get
name="Catalina:type=ClusterSender,host=localhost"
attribute="senderObjectNames"
resultproperty="senderObjectNames"
/>
訪問(wèn) senderObjectNames 屬性:
${senderObjectNames.length} give the number of returned sender list.
${senderObjectNames.[0..N]} found all sender object names
獲取連接的 IDataSender 屬性(只有在配置了集群時(shí))。
注意:這里為了可讀性,將 name
屬性加以包裝。代碼應(yīng)該位于同一行中,并且不含有空格。
<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" />
屬性列表
屬性 | 說(shuō)明 | 默認(rèn)值 |
---|---|---|
name
|
完全限定的 JMX ObjectName——Catalina:type=Server
|
- |
attribute
|
已有的 MBean 屬性(詳情參見(jiàn)上文介紹的 Tomcat MBean 說(shuō)明) | - |
value
|
設(shè)定為屬性的值 | - |
type
|
屬性類(lèi)型 | java.lang.String
|
ref
|
JMX 連接引用 | jmx.server
|
echo
|
Echo 命令用途(訪問(wèn)與結(jié)果) | false
|
設(shè)定遠(yuǎn)程 MBean 屬性值的范例如下:
<jmx:set
name="Catalina:type=Manager,context=/servlets-examples,host=localhost"
attribute="maxActiveSessions"
value="500"
type="int"
/>
屬性列表
屬性 | 說(shuō)明 | 默認(rèn)值 | |
---|---|---|---|
name
|
完全限定的 JMX ObjectName——Catalina:type=Server
|
- | |
operation
|
已有的 MBean 操作(funcspecs/fs-admin-opers.html) | - | |
ref
|
JMX 連接引用 | jmx.server
|
jmx.server
|
echo
|
Echo 命令用途(訪問(wèn)與結(jié)果) | false
|
|
resultproperty
|
在這一項(xiàng)目屬性中保存結(jié)果 | - | |
delimiter
|
用分隔符(java.util.StringTokenizier )分隔結(jié)果,使用 resultproperty 作為前綴來(lái)保存令牌 |
- | |
separatearrayresults
|
返回值為數(shù)組時(shí),將結(jié)果保存為屬性列表($resultproperty.[0..N] 和 $resultproperty.length) | true
|
停止應(yīng)用:
<jmx:invoke
name="Catalina:type=Manager,context=/servlets-examples,host=localhost"
operation="stop"/>
可以在 ${sessions.[0..N} 屬性中找到 sessionid,然后利用 ${sessions.length}
屬性來(lái)訪問(wèn)計(jì)數(shù)。
獲取所有 sessionid 的范例如下:
<jmx:invoke
name="Catalina:type=Manager,context=/servlets-examples,host=localhost"
operation="listSessionIds"
resultproperty="sessions"
delimiter=" "
/>
現(xiàn)在你可以在 ${sessions.[0..N} 屬性中找到 sessionid,然后利用 ${sessions.length}
屬性來(lái)訪問(wèn)計(jì)數(shù)。
從 ${sessionid.0} 會(huì)話中獲取遠(yuǎn)程 MBean 會(huì)話屬性:
<jmx:invoke
name="Catalina:type=Manager,context=/ClusterTest,host=localhost"
operation="getSessionAttribute"
resultproperty="hello">
<arg value="${sessionid.0}"/>
<arg value="Hello" />
</jmx:invoke>
在虛擬主機(jī) localhost 上創(chuàng)建新的訪問(wèn)日志記錄器值:
<jmx:invoke
name="Catalina:type=MBeanFactory"
operation="createAccessLoggerValve"
resultproperty="accessLoggerObjectName"
>
<arg value="Catalina:type=Host,host=localhost"/>
</jmx:invoke>
現(xiàn)在可以利用 ${accessLoggerObjectName} 屬性上存儲(chǔ)的名稱(chēng)找到新的 MBean 了。
屬性列表:
屬性 | 描述 | 默認(rèn)值 |
---|---|---|
name
|
JMX ObjectName 查詢(xún)字符串——Catalina:type=Manager,* | - |
ref
|
JMX 連接引用 | jmx.server
|
echo
|
Echo 命令用途(訪問(wèn)及結(jié)果) | false
|
resultproperty
|
將項(xiàng)目屬性名做為前綴加到所有已建立的 MBean 上(mbeans.[0..N].objectname ) |
- |
attributebinduing
|
除了 name 之外,綁定所有的 MBean 屬性 |
false
|
delimiter
|
用分隔符(java.util.StringTokenizier )分隔結(jié)果,使用 resultproperty 作為前綴來(lái)保存令牌 |
- |
separatearrayresults
|
返回值為數(shù)組時(shí),將結(jié)果保存為屬性列表($resultproperty.[0..N] 和 $resultproperty.length) | true
|
從所有的服務(wù)及主機(jī)中獲取所有的 Manager ObjectName:
<jmx:query
name="Catalina:type=Manager,*
resultproperty="manager" />
現(xiàn)在,在 ${manager.[0..N].name} 屬性上可以找到 Session Manager,利用 ${manager.length} 屬性來(lái)訪問(wèn)結(jié)果對(duì)象計(jì)數(shù)器。
從 servlet-examples 程序中獲取 Manager,并綁定所有的 MBean 屬性:
<jmx:query
name="Catalina:type=Manager,context=/servlet-examples,host=localhost*"
attributebinding="true"
resultproperty="manager.servletExamples" />
現(xiàn)在我們可以在 ${manager.servletExamples.0.name} 屬性中找到 manager,并利用 ${manager.servletExamples.0.[manager attribute names]} 訪問(wèn)該 manager 的所有屬性。MBean 的結(jié)果對(duì)象計(jì)數(shù)器被保存在 ${manager.length} 屬性中。
在下面范例中,從服務(wù)器中獲取所有的 MBean,并保存在外部的 XML 屬性文件中。
<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>
現(xiàn)在就可以在 mbeans.properties 文件中找到所有的 MBean 了。
屬性列表
屬性 | 描述 | 默認(rèn)值 |
---|---|---|
name
|
完全限定的 JMX ObjectName——Catalina:type=MBeanFactory | - |
className
|
已有的 MBean 完全限定的類(lèi)名(參見(jiàn)上文的 Tomcat MBean 說(shuō)明) | - |
classLoader
|
服務(wù)器或 Web 應(yīng)用類(lèi)加載器的 ObjectName
(Catalina:type=ServerClassLoader,name=[server,common,shared] 或 Catalina:type=WebappClassLoader,context=/myapps,host=localhost) |
- |
ref
|
JMX 連接引用 | jmx.server
|
echo
|
Echo 命令用途(訪問(wèn)及結(jié)果) | false
|
創(chuàng)建遠(yuǎn)程 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 一經(jīng)創(chuàng)建就沒(méi)有與父級(jí)連接。Valve、集群以及Realm 的 MBean 都不會(huì)自動(dòng)與父級(jí)相連。作為替代,可以使用 MBeanFactory 來(lái)創(chuàng)建操作。
屬性列表
屬性 | 描述 | 默認(rèn)值 |
---|---|---|
name
|
完全限定的 JMX ObjectName——Catalina:type=MBeanFactory | = |
ref
|
JMX 連接引用 | jmx.server
|
echo
|
Echo 命令使用(訪問(wèn)及結(jié)果) | false
|
注銷(xiāo)遠(yuǎn)程 MBean 范例如下:
<jmx:unregister
name="Catalina:type=MBeanFactory"
/>
警告:許多 Tomcat MBean 都無(wú)法注銷(xiāo)。MBean 無(wú)法從其父級(jí)脫離。可以使用 MBeanFactory 來(lái)移除操作。
屬性列表
屬性 | 描述 | 默認(rèn)值 |
---|---|---|
url
|
設(shè)定 JMX 連接 URL ——service:jmx:rmi:///jndi/rmi://localhost:8050/jmxrmi | - |
host
|
設(shè)定主機(jī),將非常長(zhǎng)的 URL 格式予以縮短 | localhost
|
port
|
設(shè)定遠(yuǎn)程連接端口 | 8050 |
username
|
遠(yuǎn)程 JMX 連接用戶(hù)名 | - |
password
|
遠(yuǎn)程 JMX 連接密碼 | - |
ref
|
內(nèi)部連接引用名稱(chēng)。利用這一屬性,可以在同一個(gè) Ant 項(xiàng)目中配置多個(gè)連接。 | jmx.server
|
name
|
完全限定的 JMX ObjectName——Catalina:type=Server | - |
echo
|
Echo 命令使用(訪問(wèn)及結(jié)果) | false
|
if
|
只有當(dāng)給定名稱(chēng)的屬性存在于當(dāng)前項(xiàng)目中才執(zhí)行 | - |
unless
|
只有當(dāng)給定名稱(chēng)的屬性不存在于當(dāng)前項(xiàng)目中才執(zhí)行 | - |
value (必須)
|
操作的第二個(gè)參數(shù) | - |
type
|
表達(dá)操作的值類(lèi)型(支持 long 和 double) | long
|
operation
|
提供以下操作
== 等于!= 不等于> 大于(> )>= 大于或等于(>= )< 小于(< )<= 小于或等于(<= ) |
==
|
等待服務(wù)器連接,集群備份節(jié)點(diǎn)可訪問(wèn)。
<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>
屬性列表
屬性 | 描述 | 默認(rèn)值 |
---|---|---|
url
|
設(shè)定 JMX 連接 URL ——service:jmx:rmi:///jndi/rmi://localhost:8050/jmxrmi | - |
host
|
設(shè)定主機(jī),將非常長(zhǎng)的 URL 格式予以縮短 | localhost
|
port
|
設(shè)定遠(yuǎn)程連接端口 | 8050 |
username
|
遠(yuǎn)程 JMX 連接用戶(hù)名 | - |
password
|
遠(yuǎn)程 JMX 連接密碼 | - |
ref
|
內(nèi)部連接引用名稱(chēng)。利用這一屬性,可以在同一個(gè) Ant 項(xiàng)目中配置多個(gè)連接。 | jmx.server
|
name
|
完全限定的 JMX ObjectName——Catalina:type=Server | - |
echo
|
Echo 命令使用(訪問(wèn)及結(jié)果) | false
|
等待服務(wù)器連接,集群備份節(jié)點(diǎn)可訪問(wèn)。
<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>
Tomcat 為使用遠(yuǎn)程(或者甚至本地的)JMX 連接提供了一個(gè)替代方案:Tomcat 的 JMXProxyServlet,但它仍能讓你訪問(wèn) JMX 所提供的任何內(nèi)容。
JMXProxyServlet 允許客戶(hù)端通過(guò) HTTP 接口來(lái)發(fā)送 JMX 查詢(xún)。相比直接從客戶(hù)端程序使用 JMX 來(lái)說(shuō),該技術(shù)具有以下優(yōu)勢(shì):
常見(jiàn)的服務(wù)器監(jiān)控軟件(比如 Nagios 或 Ichinga)中都存在過(guò)度使用 JMX 的問(wèn)題:如果想通過(guò) JMX 監(jiān)控 10 項(xiàng),就必須啟動(dòng) 10 個(gè) JVM,保持 10 個(gè) JMX 連接,每過(guò)幾分鐘就要將它們?nèi)筷P(guān)閉。有了 JMXProxyServlet,利用 10 個(gè) HTTP 連接就能搞定了。
關(guān)于 JMXProxyServlet 的詳細(xì)說(shuō)明,可查閱 Tomcat Manager。
更多建議: