Skip to content

Commit 2f5bcb9

Browse files
committed
fix(jmx): updated and clarified enabling JMX
And accessing with `jconsole`
1 parent 9927307 commit 2f5bcb9

File tree

1 file changed

+7
-5
lines changed
  • src/main/xar-resources/data/jmx

1 file changed

+7
-5
lines changed

src/main/xar-resources/data/jmx/jmx.xml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,12 @@
2222

2323
<sect1 xml:id="enable">
2424
<title>Enabling the JMX agent</title>
25-
26-
<para>To enable the platform server on the host virtual machine, pass the following Java system properties:</para>
25+
<para>The JMX agent is enabled by default for connections to local processes only: it is not exposed over TCP by default.</para>
26+
<para>To enable the platform server on the host virtual machine over TCP, pass the following Java system properties (e.g. as part of the <code>JAVA_OPTS</code> environment variable):</para>
2727
<programlisting xlink:href="listings/listing-1.txt"/>
2828
<warning>
2929
<para>These options make the server publicly accessible. Please check the Oracle <link xlink:href="https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html"> JMX documentation</link> for details.</para>
3030
</warning>
31-
<para>The extension can now be activated by passing a <code>-j</code> or <code>-jmx</code> command-line parameter to the eXist start scripts (<literal>client.sh</literal>, <literal>startup.sh</literal> etc.). This parameter must be followed by the port number through which the JMX/RMI connections are enabled, for instance:</para>
32-
<programlisting xlink:href="listings/listing-2.txt"/>
3331
</sect1>
3432

3533
<!-- ================================================================== -->
@@ -46,7 +44,11 @@
4644
<title>Use JConsole</title>
4745

4846
<para>Use a JMX compliant management console to access the management interfaces. For example, call JConsole, which is included with the JDK:</para>
49-
<programlisting>jconsole localhost:1099</programlisting>
47+
<programlisting>jconsole</programlisting>
48+
<para>When connecting locally, select the entry starting <code>org.codehaus.mojo.appessembler.booter.Appass...</code> under "Local Proccess"</para>
49+
<para>When connecting remotely over TVP, provide the hostname and port under "Remote Process", or provide them directly from the command line:</para>
50+
<programlisting>jconsole hostname:port</programlisting>
51+
<para>You may be presented with a dialogue box stating that a secure connection could not be established: it should be possible to continue with an insecure connection.</para>
5052
<para>Clicking on the <guimenuitem>MBeans</guimenuitem> tab should show some
5153
eXist-specific MBeans below the standard Java MBeans (in the tree component to the
5254
left).</para>

0 commit comments

Comments
 (0)