Author: rob.stryker(a)jboss.com Date: 2009-01-23 02:34:01 -0500 (Fri, 23 Jan 2009) New Revision: 13221 Modified: trunk/jmx/docs/reference/en/master.xml trunk/jmx/docs/reference/en/modules/connection.xml trunk/jmx/docs/reference/en/modules/how_to.xml trunk/jmx/docs/reference/en/modules/introduction.xml trunk/jmx/docs/reference/en/modules/mbean_editor.xml trunk/jmx/docs/reference/en/modules/mbean_explorer.xml Log: fixing up / improving docs Modified: trunk/jmx/docs/reference/en/master.xml =================================================================== --- trunk/jmx/docs/reference/en/master.xml 2009-01-23 00:40:39 UTC (rev 13220) +++ trunk/jmx/docs/reference/en/master.xml 2009-01-23 07:34:01 UTC (rev 13221) @@ -3,8 +3,8 @@ "http://www.docbook.org/xml/4.3/docbookx.dtd" [<!ENTITY introduction SYSTEM "modules/introduction.xml"> +<!ENTITY mbean_explorer SYSTEM "modules/mbean_explorer.xml"> <!ENTITY mbean_editor SYSTEM "modules/mbean_editor.xml"> -<!ENTITY mbean_explorer SYSTEM "modules/mbean_explorer.xml"> <!ENTITY connection SYSTEM "modules/connection.xml"> <!ENTITY how_to SYSTEM "modules/how_to.xml"> @@ -41,7 +41,7 @@ <holder>JBoss, a division of Red Hat Inc.</holder> </copyright> <releaseinfo> - Version: 0.5.0.CR1 + Version: 1.0.0.CR2 </releaseinfo> <abstract> <title/> @@ -55,8 +55,8 @@ <toc/> &introduction; + &mbean_explorer; &mbean_editor; - &mbean_explorer; &connection; &how_to; Modified: trunk/jmx/docs/reference/en/modules/connection.xml =================================================================== --- trunk/jmx/docs/reference/en/modules/connection.xml 2009-01-23 00:40:39 UTC (rev 13220) +++ trunk/jmx/docs/reference/en/modules/connection.xml 2009-01-23 07:34:01 UTC (rev 13221) @@ -2,20 +2,38 @@ <chapter id="connection" xreflabel="connection"> <?dbhtml filename="connection.html"?> - <title>Connection</title> - <para> There are two ways to connect to an application with remote management enabled:</para> - <para> The first step is the same for both - to connect to a MBean Server - click on the - Connect... icon () in the MBean Explorer menu bar, </para> - <para>Then to follow the simple one you just need to specify host, port (and optionally user - name &amp; password) and click OK</para> - <para>The default JMX URL is service:jmx:rmi:///jndi/rmi://localhost:3000/jmxrmi </para> + <title>Connections</title> + + <para>The MBean Explorer supports several different types of connections. + The tooling itself comes only with a default connection type, however other + adopters can provide additional connection types that may require additional + or non-spec behavior. Connections can be in either the connected state or + the disconnected state. Some connection types (such as the default connection type) + allow you to control the current state. Other connection types may not. </para> - <para> In case you need to connect to an application which has not used the "standard" JMX URL - (e.g. Eclipse Equinox), you need chose more advance way, where it's necessary to specify - explicitly a JMX URL in the Advanced Tab of the JMX Connection window </para> + <para>Similarly, some connection types may be able to be created, and others may not. + The default connection type, for example, can be created and deleted by you + at will. The ASTools connection type, which represents a JBoss server, does not + allow you this level of control. A JBoss JMX connection is created when a JBoss server is created + in the server's view, and deleted when said server is deleted. The JMX connection for + this server is in the connected state only when the server is started. </para> + + + <section><title>The Default Connection</title> + <para> There are two ways to connect to an application with remote management enabled:</para> + <para> The first step is the same for both - to connect to a MBean Server - click on the + Connect... icon () in the MBean Explorer menu bar, </para> + <para>Then to follow the simple one you just need to specify host, port (and optionally user + name &amp; password) and click OK</para> + <para>The default JMX URL is service:jmx:rmi:///jndi/rmi://localhost:3000/jmxrmi </para> - <note> - <title>Note</title> - <para>only JMX URL based on RMI are supported </para> - </note> -</chapter> \ No newline at end of file + <para> In case you need to connect to an application which has not used the "standard" JMX URL + (e.g. Eclipse Equinox), you need chose more advance way, where it's necessary to specify + explicitly a JMX URL in the Advanced Tab of the JMX Connection window </para> + + <note> + <title>Note</title> + <para>only JMX URL based on RMI are supported </para> + </note> + </section> +</chapter> Modified: trunk/jmx/docs/reference/en/modules/how_to.xml =================================================================== --- trunk/jmx/docs/reference/en/modules/how_to.xml 2009-01-23 00:40:39 UTC (rev 13220) +++ trunk/jmx/docs/reference/en/modules/how_to.xml 2009-01-23 07:34:01 UTC (rev 13221) @@ -16,14 +16,14 @@ </section> <section> - <title>How to manage Eclipse Equinox using eclipse-jmx</title> + <title>How to manage Eclipse Equinox</title> - <para> You can manage Equinox using eclipse-jmx through Equinox monitoring framework.</para> - <para> Once you have installed Equinox monitoring framework and restarted Eclipse:</para> + <para> You can manage Equinox through the Equinox monitoring framework.</para> + <para> Once you have installed the Equinox monitoring framework and restarted Eclipse:</para> <itemizedlist> <listitem><para> Go to Window > Open Perspective > Other... and select the JMX Resource Management perspective</para></listitem> <listitem><para> Select JMX Server > Open Connection and click on OK</para></listitem> - <listitem><para> Switch to eclipse-jmx perspective by going to Window > Open Perspective > Other... and selecting the JMX perspective</para></listitem> + <listitem><para> Switch to the MBean explorer by going to Window > Show View > Other... and selecting the MBean Explorer</para></listitem> <listitem><para> click on the Connect... icon () in the MBean Explorer menu bar </para></listitem> <listitem><para> select the Advanced tab and set the JMX URL to service:jmx:rmi:///jndi/rmi://:8118/jmxserver </para></listitem> </itemizedlist> @@ -31,6 +31,25 @@ </section> + <section> + <title>Managing JBoss Instances</title> + <para>Managing JBoss instnaces is not supported with the JMX Tools alone. + You must also download and install the ASTools portion of the JBossTools distribution. + Even after installing the proper tooling, you cannot create a JBoss JMX connection yourself + or through the Connection Wizard. The first step is to create a JBoss Server. + The full instructions for this can be found in the AS Tools section, however, + the short summary is: </para> + <itemizedlist> + <listitem><para>Open the JBoss Servers View or the Servers View</para></listitem> + <listitem><para>Right-click in the view and select New -> Server</para></listitem> + <listitem><para>In the "JBoss, a division of Red Hat" section, select a server version</para></listitem> + <listitem><para>If a runtime has not yet been created, you'll be prompted for the server's home directory, JDK, and configuration.</para></listitem> + <listitem><para>Finish the wizard and note that you have a new entry in both the Server View and the MBean Explorer</para></listitem> + <listitem><para>Start the server by right-clicking it and selecting Start</para></listitem> + <listitem><para>Note that once the server is started, the JMX connection can be expanded</para></listitem> + </itemizedlist> + + <para>Now you can explore MBeans exposed by a JBoss instance</para> + </section> - -</chapter> \ No newline at end of file +</chapter> Modified: trunk/jmx/docs/reference/en/modules/introduction.xml =================================================================== --- trunk/jmx/docs/reference/en/modules/introduction.xml 2009-01-23 00:40:39 UTC (rev 13220) +++ trunk/jmx/docs/reference/en/modules/introduction.xml 2009-01-23 07:34:01 UTC (rev 13221) @@ -8,7 +8,7 @@ applications through JMX and its RMI Connector.</para> <figure> - <title>Eclipse JMX</title> + <title>JMX Tools</title> <mediaobject> <imageobject> <imagedata fileref="images/eclipse-jmx_0.2.png"/> @@ -18,87 +18,59 @@ <section> <title> Requirements </title> - <para> Requirements to use eclipse-jmx are the following: </para> + <para> Requirements to use JMX Tools are the following: </para> <itemizedlist> <listitem> - <para> eclipse-jmx is developed on Eclipse 3.3 milestones. It is also tested on latest - stable 3.2 release.</para> + <para> JMX Tools is developed on Eclipse 3.4.x milestones.</para> </listitem> <listitem> - <para> eclipse-jmx requires that Eclipse is run on a JDK 1.5.0 or above (due to dependencies + <para> JMX Tools requires that Eclipse is run on a JDK 1.5.0 or above (due to dependencies on JMX packages which were introduced in Java 1.5.0)</para> </listitem> </itemizedlist> </section> + <section><title>History</title> + <para>JBossTools' JMX Tools project is a fork of <ulink url="http://code.google.com/p/eclipse-jmx/">eclipse-jmx</...;, a project by Jeff Mesnil. It was forked with permission. </para> + </section> + <section> <title>Installation</title> - - <para>eclipse-jmx can be installed either by using Eclipse update manager or by downloading it and installing it manually in Eclipse.</para> - - <tip><title>Tip</title> - <para>Check Requirements to see what is required to install and use eclipse-jmx. </para></tip> - - <section> <title>Manual Installation</title> - <para> Follow the next steps to install the plugin manually: </para> - - <itemizedlist> - <listitem> <para>Download the latest release from http://code.google.com/p/eclipse-jmx/downloads/list</para></list... - <listitem> <para> Unzip the file in you Eclipse installation</para></listitem> - <listitem><para>(Re)Start Eclipse </para></listitem> - </itemizedlist> - </section> - - <section> <title> Installation using Eclipes update manager</title> - - <para>In Eclipse:</para> - - <itemizedlist> - <listitem> <para> go to Help > Software Updates > Find and Install...</para></listitem> - <listitem> <para> check Search for new features to install and click Next </para></listitem> - <listitem> <para> click on New Remote Site...</para></listitem> - <listitem> <para> in the New Update Site window, type:</para></listitem> - <listitem> <para> Name: eclipse-jmx</para></listitem> - <listitem> <para> URL: http://eclipse-jmx.googlecode.com/svn/trunk/net.jmesnil.jmx.update/ </para></listitem> - <listitem> <para> click on OK</para></listitem> - <listitem> <para> check eclipse-jmx and click on Finish</para></listitem> - <listitem> <para> expand the features and select the latest one. Then click on Next </para></listitem> - <listitem> <para> check I accept the terms in the license agreement and click on Next </para></listitem> - <listitem> <para> click on Finish</para></listitem> - <listitem> <para> once all the plug-ins are downloaded, click on Install All</para></listitem> - <listitem> <para> finally, when ask to restart Eclipse, click on Yes</para></listitem> - </itemizedlist> - </section> - + <para>Here, we are going to explain how to install the JMX plugins into Eclipse.</para> + + <para>JMX Tools is one module of the JBoss Tools project. JMX Tools has no dependency on any other part of JBossTools, and can be downloaded standalone. Even though the JMX Tools have no dependencies, other plugins, such as ASTools, do depend on the JMX Tooling and even extend it. </para> + + <para>You can find the JBossTools plugins over at the <ulink url="http://labs.jboss.com/tools/download/index.html">download pages</ulink>. The only package you'll need to get is the JMX Tooling, however the AS Tools would give you a more full experience when using JMX with JBoss Servers. +You can find further download and installation instructions on the JBoss Wiki in the <ulink url="http://labs.jboss.com/wiki/InstallingJBossTools">Instal... section.</para> </section> - + + <section> <title>Quick Start</title> - <para>To start using it, it's necessary to open JMX perspective. Go to Window > Open Perspective > - Other... and then select JMX and click OK </para> + <para>To start using the JMX Tools, it's necessary to open MBean explorer. Go to Window > Show View > + Other... and then select MBean Explorer and click OK </para> - <para>The JMX perspective is composed of a single view - MBean Explorer which lists the mbeans. + <para>The MBean Explorer lists all of the domains, mbeans, attributes, and operations inside a connection. When you double-click on a MBean in the MBean Explorer view, it opens a multi-page editor to manage the MBean. The MBeanEditor is composed of these pages:</para> <itemizedlist> <listitem> - <para> Attributes to get/set the attributes of the MBean</para> + <para> Attributes page, to get/set the attributes of the MBean</para> </listitem> <listitem> - <para>Operations to invoke operations on the MBean</para> + <para>Operations page, to invoke operations on the MBean</para> </listitem> <listitem> - <para> Notifications to receive notifications from the MBean</para> + <para> Notifications page, to receive notifications from the MBean</para> </listitem> <listitem> - <para> Info which displays general information about the MBean </para> + <para> Info page, which displays general information about the MBean </para> </listitem> </itemizedlist> - <para>There is a button to update the MBean attribute value (if it is writable)</para> </section> -</chapter> \ No newline at end of file +</chapter> Modified: trunk/jmx/docs/reference/en/modules/mbean_editor.xml =================================================================== --- trunk/jmx/docs/reference/en/modules/mbean_editor.xml 2009-01-23 00:40:39 UTC (rev 13220) +++ trunk/jmx/docs/reference/en/modules/mbean_editor.xml 2009-01-23 07:34:01 UTC (rev 13221) @@ -50,34 +50,5 @@ <para>It is only possible to subscribe to MBean, which emits notifications (they must be NotificationBroadcaster).</para></note> </section> - <section id="AttributeDisplayExtensionPoints"> - <title>Attribute Display Extension Points</title> - - <para>The value of the MBean attributes that are displayed in the MBean Editor is now contributed through 2 extension points:</para> - <orderedlist> - <listitem><para>net.jmesnil.jmx.ui.attribute.controls</para></listitem> - <listitem><para>net.jmesnil.jmx.ui.attribute.bindings</para> </listitem> - </orderedlist> - <para>This means that you can now contribute new display for MBean attributes (see some use cases and a simple example in net.jmesnil.jmx.ui.test.interactive plugin.xml)</para> - - </section> - - - <section id="OpenMBeanAction"> - <title>Open MBean Action </title> - <para>A Navigation action helps opening MBeans in a MBean Editor. This action is available - either through the menu Navigate > Open MBean... or using the key shortcut Ctrl + Shift + M - (&#8984;+ Shift + M on Mac OS X)</para> - - <figure> - <title>Opening MBean Dialog</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/open-mbean-dialog_0.2.0.png"/> - </imageobject> - </mediaobject> - </figure> - - </section> - -</chapter> \ No newline at end of file + +</chapter> Modified: trunk/jmx/docs/reference/en/modules/mbean_explorer.xml =================================================================== --- trunk/jmx/docs/reference/en/modules/mbean_explorer.xml 2009-01-23 00:40:39 UTC (rev 13220) +++ trunk/jmx/docs/reference/en/modules/mbean_explorer.xml 2009-01-23 07:34:01 UTC (rev 13221) @@ -33,7 +33,20 @@ the few ones, which interest you.</para> <para>For example, if you are only interested by MBeans related to memory, typing memo will show - only the MBeans registered under an ObjectName, which contains memo: </para> + any node (domain, mbean, attribute, or operation) that matches that text, as well as + that node's parents and children. So if an MBean matches, all attributes and operations from + that bean will show. If, however, an attribute or operation name (a leaf node) matches, + only that node and its parents in the tree will show.</para> + + <figure> + <title>Query Filter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-explorer-query.png"/> + </imageobject> + </mediaobject> + </figure> + <para>A Collapse All button on the MBean Explorer toolbar is used to collapse all the MBeans and display only the domains. It is also possible to double click on a node to expand/collapse it. </para>