監視和管理Tomcat

allway2發表於2020-12-09
Tomcat

監視和管理Tomcat

目錄

介紹

監視是系統管理的關鍵方面。檢視正在執行的伺服器內部，獲取一些統計資訊或重新配置應用程式的某些方面，都是日常管理任務。

啟用JMX遠端

注意：僅當您要遠端監視Tomcat時才需要此配置。如果要使用與Tomcat一起執行的同一使用者在本地對其進行監視，則不需要它。

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

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

將以下引數新增到setenv.batTomcat指令碼中（有關詳細資訊，請參閱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"
    />
    <!-- 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>

import：使用<import file =“ $ {CATALINA.HOME} /bin/catalina-tasks.xml” />匯入JMX Accessor專案， 並使用jmxOpen，jmxSet，jmxGet， jmxQuery，jmxInvoke，jmxEquals和jmxCondition引用任務。

JMXAccessorOpenTask-JMX開啟連線任務

屬性清單

屬性描述預設值
網址設定JMX連線URL- service：jmx：rmi：/// jndi / rmi：// localhost：8050 / jmxrmi 
主辦設定主機，快捷方式非常長的URL語法。localhost
港口設定遠端連線埠8050
使用者名稱遠端JMX連線使用者名稱。 
密碼遠端JMX連線密碼。 
參考內部連線引用的名稱。使用此屬性，您可以在同一Ant專案中配置更多一個連線。jmx.server
回聲回顯命令用法（用於訪問分析或除錯）false
如果僅噹噹前專案中存在給定名稱的屬性時才執行。 
除非僅噹噹前專案中不存在給定名稱的屬性時才執行。 

開啟新的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 ObjectName- Catalina：type = Server 
屬性現有的MBean屬性（請參閱上面的Tomcat MBean描述） 
參考JMX連線參考jmx.server
回聲回聲命令用法（訪問和結果）false
結果屬性將結果儲存在此專案屬性中 
定界符使用定界符（java.util.StringTokenizer）分割結果，並使用resultproperty作為字首來儲存令牌。 
單獨的陣列結果當返回值是一個陣列時，將結果儲存為屬性列表（$ resultproperty。[0..N]和$ resultproperty.length）true

從預設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任務

屬性清單

屬性描述預設值
名稱完全限定的JMX ObjectName- Catalina：type = Server 
屬性現有的MBean屬性（請參閱上面的Tomcat MBean描述） 
值設定為屬性的值 
型別屬性的型別。java.lang.String
參考JMX連線參考jmx.server
回聲回聲命令用法（訪問和結果）false

設定遠端MBean屬性值的示例

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

JMXAccessorInvokeTask：呼叫MBean操作Ant任務

屬性清單

屬性描述預設值
名稱完全限定的JMX ObjectName- Catalina：type = Server 
操作現有的MBean操作 
參考JMX連線參考jmx.server
回聲回聲命令用法（訪問和結果）false
結果屬性將結果儲存在此專案屬性中 
定界符使用定界符（java.util.StringTokenizer）分割結果，並使用resultproperty作為字首來儲存令牌。 
單獨的陣列結果當返回值是一個陣列時，將結果儲存為屬性列表（$ resultproperty。[0..N]和$ resultproperty.length）true

停止申請

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

屬性清單

屬性描述預設值
名稱JMX ObjectName查詢字串-Catalina：type = Manager，* 
參考JMX連線參考jmx.server
回聲回聲命令用法（訪問和結果）false
結果屬性為所有已建立的MBean字首專案屬性名稱（mbeans。[0..N] .objectname） 
屬性繫結繫結除名稱之外的所有MBean屬性false
定界符使用定界符（java.util.StringTokenizer）分割結果，並使用resultproperty作為字首來儲存令牌。 
單獨的陣列結果當返回值是一個陣列時，將結果儲存為屬性列表（$ resultproperty。[0..N]和$ resultproperty.length）true

從所有服務和主機獲取所有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屬性檔案中的示例

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

現在，您可以在檔案mbeans.properties中找到所有MBean 。

JMXAccessorCreateTask：遠端建立MBean Ant任務

屬性清單

屬性描述預設值
名稱完全限定的JMX ObjectName- Catalina：type = MBeanFactory 
班級名稱現有的MBean完整合格的類名（請參閱上面的Tomcat MBean描述） 
classLoader伺服器或Web應用程式類載入器的ObjectName
（Catalina：type = ServerClassLoader，name = [伺服器，公共，共享]或
Catalina：type = WebappClassLoader，context = / myapps，host = localhost）		 
參考JMX連線參考jmx.server
回聲回聲命令用法（訪問和結果）false

建立遠端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任務

屬性清單

屬性描述預設值
名稱完全限定的JMX ObjectName- Catalina：type = MBeanFactory 
參考JMX連線參考jmx.server
回聲回聲命令用法（訪問和結果）false

取消註冊遠端MBean的示例

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

警告：不能取消註冊許多Tomcat MBean。
MBean並未與其父級解除連結。請改用MBeanFactory
刪除操作。

JMXAccessorCondition：表達條件

屬性清單

屬性描述預設值
網址設定JMX連線URL- service：jmx：rmi：/// jndi / rmi：// localhost：8050 / jmxrmi 
主辦設定主機，快捷方式非常長的URL語法。localhost
港口設定遠端連線埠8050
使用者名稱遠端JMX連線使用者名稱。 
密碼遠端JMX連線密碼。 
參考內部連線引用的名稱。使用此屬性，您可以在同一Ant專案中配置更多一個連線。jmx.server
名稱完全限定的JMX ObjectName- Catalina：type = Server 
回聲回聲條件的使用（訪問和結果）false
如果僅噹噹前專案中存在給定名稱的屬性時才執行。 
除非僅噹噹前專案中不存在給定名稱的屬性時才執行。 
值（必填）操作的第二個引數 
型別表示操作的值型別（支援long和double）long
操作表達一個
  • ==等於
  • ！=不等於
  • >大於（＆gt;）
  • > =大於或等於（> =）
  • <小於（＆lt;）
  • <=小於或等於（＆lt; =）
==

等待伺服器連線，並且該群集備份節點可訪問

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

JMXAccessorEqualsCondition：等於MBean Ant條件

屬性清單

屬性描述預設值
網址設定JMX連線URL- service：jmx：rmi：/// jndi / rmi：// localhost：8050 / jmxrmi 
主辦設定主機，快捷方式非常長的URL語法。localhost
港口設定遠端連線埠8050
使用者名稱遠端JMX連線使用者名稱。 
密碼遠端JMX連線密碼。 
參考內部連線引用的名稱。使用此屬性，您可以在同一Ant專案中配置更多一個連線。jmx.server
名稱完全限定的JMX ObjectName- Catalina：type = Server 
回聲回聲條件的使用（訪問和結果）false

等待伺服器連線，並且該群集備份節點可訪問

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

使用JMXProxyServlet

Tomcat提供了使用遠端（甚至本地）JMX連線的替代方法，同時仍使您可以訪問JMX必須提供的所有功能：Tomcat的 JMXProxyServlet。

JMXProxyServlet允許客戶端通過HTTP介面發出JMX查詢。與直接從客戶端程式使用JMX相比，該技術具有以下優點：

  • 您不必啟動完整的JVM並建立遠端JMX連線，而只需從正在執行的伺服器中請求一小部分資料
  • 您不必知道如何使用JMX連線
  • 您不需要本頁面其餘部分介紹的任何複雜配置
  • 您的客戶端程式不必用Java編寫

在流行的伺服器監視軟體（例如Nagios或Icinga）中，可以看到JMX過度殺傷的一個完美示例：如果要通過JMX監視10個專案，則必須啟動10個JVM，建立10個JMX連線，然後關閉他們每隔幾分鐘就下來。使用JMXProxyServlet，您可以建立10個HTTP連線並完成它。

您可以在Tomcat管理器的文件中找到有關JMXProxyServlet的更多資訊 。

相關文章