From: markt Date: Sun, 2 Nov 2008 00:52:21 +0000 (+0000) Subject: Lots of typos. Make text consistent (Tomcat, MBean etc). Remove the section on JDK... X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=a52324c3068e3300aca4033dbc405d6a397f6eec;p=tomcat7.0 Lots of typos. Make text consistent (Tomcat, MBean etc). Remove the section on JDK 1.4 and MX4J since TC6 can't run on a 1.4 JVM. git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@709823 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/webapps/docs/monitoring.xml b/webapps/docs/monitoring.xml index 54b625b23..4a94a71ca 100644 --- a/webapps/docs/monitoring.xml +++ b/webapps/docs/monitoring.xml @@ -32,9 +32,9 @@
-

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

+

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.

@@ -44,8 +44,8 @@ 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: +

The following is a quick configuration guide for Java 5:

+

Add the following parameters to your Tomcat startup script: set CATALINA_OPTS="-Dcom.sun.management.jmxremote \ -Dcom.sun.management.jmxremote.port=%my.jmx.port% \ @@ -55,14 +55,14 @@

    -
  1. When you think authorisation is a good, add and change this : +
  2. If you require authorisation, add and change this : -Dcom.sun.management.jmxremote.authenticate=true \ -Dcom.sun.management.jmxremote.password.file=../conf/jmxremote.password \ -Dcom.sun.management.jmxremote.access.file=../conf/jmxremote.access \
    3. -
  3. edit the access allow file $CATALINA_BASE/conf/jmxremote.access : +
  4. edit the access authorisation file $CATALINA_BASE/conf/jmxremote.access : monitorRole readonly controlRole readwrite @@ -73,48 +73,21 @@ controlRole readwrite monitorRole tomcat controlRole tomcat - Tipp: Password File must be readonly and not accessable from every - other user! Remove all other users under windows to access this file. + Tip: The password file should be read-only and only accessible by the + operating system user Tomcat is running as.
- Note:The JSR 160 JMX-Adaptor opens a second data protocol port. That is a problem - when you have installed a local firewall.
-

-

Activate JMX MX4J Http Adaptor with Java 1.4: -

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

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

    -

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

    -

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

    -
    4. -
  4. Start your tomcat and look with a browser at http://${JMX.HOST}:${JMX.PORT}
    5. -
  5. With the mx connector parameter mx.authMode="basic" mx.authUser="tomcat" mx.authPassword="strange" - you can control the access!
    6. -
  6. A complete list of all tomcat core MBeans can you find at - funcspecs/mbean-names.html.
    7. -
+ Note:The JSR 160 JMX-Adaptor opens a second data channel on a random + port. That is a problem when you have a local firewall installed.

-

For simple tomcat ant task usage with ant 1.6.x we have integrate import and antlib support.

+

To simplify JMX usage with Ant 1.6.x, a set of tasks is provided that may + be used with antlib.

antlibCopy your catalina-ant.jar from $CATALINA_HOME/lib to $ANT_HOME/lib.

-

Following example show the JMX Accessor usage:

+

The following example shows the JMX Accessor usage:

 <project name="Catalina Ant JMX" 
@@ -145,7 +118,7 @@ controlRole tomcat
             echo="false"
         />
         <!-- get current maxActiveSession from ClusterTest application
-             echo it to ant output and store at 
+             echo it to Ant output and store at 
              property <em>clustertest.maxActiveSessions.orginal</em>
         -->
        <jmx:get
@@ -163,7 +136,7 @@ controlRole tomcat
             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].
+             access all session ids directly with Ant property sessions.[0..n].
         -->
         <jmx:invoke
             name="Catalina:type=Manager,path=/ClusterTest,host=localhost" 
@@ -184,7 +157,7 @@ controlRole tomcat
           <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.
+             and bind all attributes from all found manager MBeans.
         -->
         <jmx:query
             name="Catalina:type=Manager,*" 
@@ -213,8 +186,8 @@ controlRole tomcat

-

import: Import the JMX Accessor Projekt with - <import file="${CATALINA.HOME}/bin/jmxaccessor-tasks.xml" /> and +

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

@@ -223,7 +196,7 @@ controlRole tomcat -
+

List of Attributes
@@ -236,14 +209,14 @@ List of Attributes
- - @@ -257,22 +230,22 @@ List of Attributes
- - - @@ -301,7 +274,7 @@ List of Attributes
urlSet jmx connection url - service:jmx:rmi:///jndi/rmi://localhost:8050/jmxrmi + Set JMX connection URL - service:jmx:rmi:///jndi/rmi://localhost:8050/jmxrmi
hostSet the host, shortcut the very long url syntax. + Set the host, shortcut the very long URL syntax. localhost
usernameremote jmx connection user name. + remote JMX connection user name.
passwordremote jmx connection password. + remote JMX connection password.
refName of the internal connection referenz. With this attribute you can - configure more the one connection inside the same ant projekt. + Name of the internal connection reference. With this attribute you can + configure more the one connection inside the same Ant project. jmx.server

-Example to open a new jmx connection
+Example to open a new JMX connection
<jmx:open host="${jmx.server.name}" @@ -310,7 +283,7 @@ Example to open a new jmx connection

-Example to open a jmx connection from url, with authorisation and +Example to open a JMX connection from URL, with authorisation and store at other reference
<jmx:open @@ -323,7 +296,7 @@ store at other reference

-Example to open a jmx connection from url, with authorisation and +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
@@ -346,7 +319,7 @@ other tasks and conditions. -

+

List of Attributes
@@ -366,7 +339,7 @@ List of Attributes
- @@ -403,7 +376,7 @@ List of Attributes
@@ -411,7 +384,7 @@ List of Attributes
attributeExisting Mbean attribute (see Tomcat mbean description above) + Existing MBean attribute (see Tomcat MBean description above)
separatearrayresults When return value is an array, save result as property list - ($resultproperty.[0..N] and $resultproperty.lenght) + ($resultproperty.[0..N] and $resultproperty.length) true

-Example to get remote mbean attribute from default jmx connection
+Example to get remote MBean attribute from default JMX connection
<jmx:get name="Catalina:type=Manager,path=/servlets-examples,host=localhost" @@ -431,7 +404,7 @@ Example to get and result array and split it at separate properties
Access the senderObjectNames properties with: - ${senderObjectNames.lenght} give the number of returned sender list. + ${senderObjectNames.length} give the number of returned sender list. ${senderObjectNames.[0..N]} found all sender object names

@@ -457,7 +430,7 @@ Example to get IDataSender attribute connected only when cluster is configured. -
+

List of Attributes
@@ -477,7 +450,7 @@ List of Attributes
- @@ -513,7 +486,7 @@ List of Attributes
attributeExisting Mbean attribute (see Tomcat mbean description above) + Existing MBean attribute (see Tomcat MBean description above)

-Example to set remote mbean attribute value
+Example to set remote MBean attribute value
<jmx:set name="Catalina:type=Manager,path=/servlets-examples,host=localhost" @@ -529,7 +502,7 @@ Example to set remote mbean attribute value
-

+

List of Attributes
@@ -549,8 +522,8 @@ List of Attributes
- @@ -587,7 +560,7 @@ List of Attributes
@@ -602,7 +575,7 @@ stop an application
operation="stop"/> Now you can find the sessionid at ${sessions.[0..N} properties and access the count -with ${sessions.lenght} property. +with ${sessions.length} property.

Example to get all sessionids
@@ -615,10 +588,10 @@ Example to get all sessionids
/> Now you can find the sessionid at ${sessions.[0..N} properties and access the count -with ${sessions.lenght} property. +with ${sessions.length} property.

-Example to get remote mbean session attribute from session ${sessionid.0}
+Example to get remote MBean session attribute from session ${sessionid.0}
<jmx:invoke name="Catalina:type=Manager,path=/ClusterTest,host=localhost" @@ -640,8 +613,8 @@ Example to create a new access logger valve at vhost localhost <arg value="Catalina:type=Host,host=localhost"/> </jmx:invoke> -Now you can find new Mbean with name stored at ${acccesLoggerObjectName} -proeprty. +Now you can find new MBean with name stored at ${acccesLoggerObjectName} +property.

@@ -649,7 +622,7 @@ proeprty. -
+

List of Attributes

operationExisting Mbean operation (see Tomcat - funcspecs/fs-admin-opers.html. + Existing MBean operation (see Tomcat + funcspecs/fs-admin-opers.html).
separatearrayresults When return value is an array, save result as property list - ($resultproperty.[0..N] and $resultproperty.lenght) + ($resultproperty.[0..N] and $resultproperty.length) true
@@ -683,7 +656,7 @@ List of Attributes
- @@ -706,7 +679,7 @@ List of Attributes
@@ -724,7 +697,7 @@ 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
+Example to get the Manager from servlet-examples application an bind all MBean properties
<jmx:query name="Catalina:type=Manager,path=/servlet-examples,host=localhost*" @@ -737,7 +710,7 @@ 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
+Example to get all MBeans from a server and store inside an external XML property file
<project name="jmx.query" xmlns:jmx="antlib:org.apache.catalina.ant.jmx" @@ -780,7 +753,7 @@ Now you can find all MBeans inside the file mbeans.properties. -

+

List of Attributes

resultpropertyPrefix project property name to all founded Mbeans (mbeans.[0..N].objectname) + Prefix project property name to all founded MBeans (mbeans.[0..N].objectname)
separatearrayresults When return value is an array, save result as property list - ($resultproperty.[0..N] and $resultproperty.lenght) + ($resultproperty.[0..N] and $resultproperty.length) true
@@ -800,7 +773,7 @@ List of Attributes
- @@ -831,7 +804,7 @@ List of Attributes
classNameExisting MBean full qualified classname (see Tomcat mbean description above) + Existing MBean full qualified class name (see Tomcat MBean description above)

-Example to create remote mbean
+Example to create remote MBean
<jmx:create ref="${jmx.reference}" @@ -843,9 +816,10 @@ Example to create remote mbean

- 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. + Warning: Many Tomcat MBeans can't be linked to their parent once
+ created. The Valve, Cluster and Realm MBeans are not automatically
+ connected with their parent. Use the MBeanFacrory create
+ operation instead.

@@ -853,7 +827,7 @@ Example to create remote mbean
-
+

List of Attributes
@@ -888,7 +862,7 @@ List of Attributes

-Example to unregister remote mbean
+Example to unregister remote MBean
<jmx:unregister name="Catalina:type=MBeanFactory" @@ -896,8 +870,8 @@ Example to unregister remote mbean

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

@@ -919,14 +893,14 @@ List of Attributes
url - Set jmx connection url - service:jmx:rmi:///jndi/rmi://localhost:8050/jmxrmi + Set JMX connection URL - service:jmx:rmi:///jndi/rmi://localhost:8050/jmxrmi host - Set the host, shortcut the very long url syntax. + Set the host, shortcut the very long URL syntax. localhost @@ -940,14 +914,14 @@ List of Attributes
username - remote jmx connection user name. + remote JMX connection user name. password - remote jmx connection password. + remote JMX connection password. @@ -955,7 +929,7 @@ List of Attributes
ref Name of the internal connection reference. With this attribute you can - configure more the one connection inside the same ant projekt. + configure more the one connection inside the same Ant project. jmx.server @@ -1050,7 +1024,7 @@ Wait for server connection and that cluster backup node is accessable
-
+

List of Attributes
@@ -1063,14 +1037,14 @@ List of Attributes
- - @@ -1084,22 +1058,22 @@ List of Attributes
- - - @@ -1122,7 +1096,7 @@ List of Attributes
urlSet jmx connection url - service:jmx:rmi:///jndi/rmi://localhost:8050/jmxrmi + Set JMX connection URL - service:jmx:rmi:///jndi/rmi://localhost:8050/jmxrmi
hostSet the host, shortcut the very long url syntax. + Set the host, shortcut the very long URL syntax. localhost
usernameremote jmx connection user name. + remote JMX connection user name.
passwordremote jmx connection password. + remote JMX connection password.
refName of the internal connection referenz. With this attribute you can - configure more the one connection inside the same ant projekt. + Name of the internal connection reference. With this attribute you can + configure more the one connection inside the same Ant project. jmx.server

-Wait for server connection and that cluster backup node is accessable
+Wait for server connection and that cluster backup node is accessible
<target name="wait"> <waitfor maxwait="${maxwait}" maxwaitunit="second" timeoutproperty="server.timeout" >