Skip to content

Commit 707b1d4

Browse files
committed
doc(jmx): copy-edits
- General spelling, capitalisation and grammar check - Added details for jmx access token (thanks, @dizzzz )
1 parent 203a363 commit 707b1d4

File tree

1 file changed

+12
-28
lines changed
  • src/main/xar-resources/data/jmx

1 file changed

+12
-28
lines changed

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

Lines changed: 12 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -14,42 +14,29 @@
1414

1515
<!-- ================================================================== -->
1616

17-
<para>eXist-db provides access to various management interfaces via Java Management Extensions
18-
(JMX). An agent in the Java virtual machine exposes agent services as so-called MBeans that
19-
belong to different components running within the virtual machine. A JMX-compliant
20-
management application can then connect to the agent through the MBeans and access the
21-
available services in a standardized way. </para>
22-
<para>The standard Java installation includes a simple client, JConsole, which will also display
23-
the eXist-specific services. eXist also provides a command-line client for quick access to
24-
server statistics and other information.</para>
25-
<para>Right now, eXist only exposes a limited set of read-only services. Most of them are useful
26-
for debugging purposes only.</para>
17+
<para>eXist-db provides access to various management interfaces via Java Management Extensions (JMX). An agent in the Java virtual machine exposes agent services as <emphasis>MBeans</emphasis> that belong to different components running within the virtual machine. A JMX-compliant management application can then connect to the agent through the MBeans and access the available services in a standardized way. </para>
18+
<para>The standard Java installation includes a simple client, JConsole, which will display the eXist-specific services. eXist also provides a command-line client for quick access to server statistics and other information.</para>
19+
<para>eXist only exposes a limited set of read-only services. Most of them are useful for debugging purposes only.</para>
2720

2821
<!-- ================================================================== -->
2922

3023
<sect1 xml:id="enable">
3124
<title>Enabling the JMX agent</title>
3225

33-
<para>To enable the platform server within the host virtual machine, pass the following Java
34-
system properties:</para>
26+
<para>To enable the platform server on the host virtual machine, pass the following Java system properties:</para>
3527
<programlisting xlink:href="listings/listing-1.txt"/>
3628
<warning>
37-
<para>These options makes the server publicly accessible. Please check the Oracle <link
38-
xlink:href="https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html">
39-
JMX documentation</link> for details.</para>
29+
<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>
4030
</warning>
41-
<para>The extension can now be activated by passing a <code>-j</code> or <code>-jmx</code>
42-
command-line parameter to the eXist start scripts (<literal>client.sh</literal>,
43-
<literal>startup.sh</literal> etc.). This parameter must be followed by the port number
44-
through which the JMX/RMI connections are enabled. For instance:</para>
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>
4532
<programlisting xlink:href="listings/listing-2.txt"/>
4633
</sect1>
4734

4835
<!-- ================================================================== -->
4936

5037
<sect1 xml:id="monitoring">
5138
<title>Monitoring and Management</title>
52-
<para>This sections explains how to monitor an exist instant using common java tools.</para>
39+
<para>This sections explains how to monitor an eXist instance using common Java tools.</para>
5340

5441

5542

@@ -58,8 +45,7 @@
5845
<sect2 xml:id="jconsole">
5946
<title>Use JConsole</title>
6047

61-
<para>Use a JMX-compliant management console to access the management interfaces. For
62-
example, call JConsole, which is included with the JDK:</para>
48+
<para>Use a JMX compliant management console to access the management interfaces. For example, call JConsole, which is included with the JDK:</para>
6349
<programlisting>jconsole localhost:1099</programlisting>
6450
<para>Clicking on the <guimenuitem>MBeans</guimenuitem> tab should show some
6551
eXist-specific MBeans below the standard Java MBeans (in the tree component to the
@@ -174,18 +160,16 @@
174160
<para>the client accesses the API on localhost</para>
175161
</listitem>
176162
<listitem>
177-
<para>a valid token is provided when accessing the API from a remote IP address</para>
163+
<para>a valid token is provided when accessing the API from a remote IP address. A file containing this token and an example of its use can be found in the eXist data directory at <filename>$(EXIST_HOME)/data/jmxservlet.token</filename>.</para>
178164
</listitem>
179165
</itemizedlist>
180166
</note>
181167
<note>
182-
<para>Use <link xlink:href="production_web_proxying">a web proxy</link> if you wish to provide this service separately from other eXist applications.</para>
168+
<para>Consider using <link xlink:href="production_web_proxying">a web proxy</link> if you wish to provide this service separately from other eXist applications.</para>
183169
</note>
184170
<para>This returns something like:</para>
185171
<programlisting language="xml" xlink:href="listings/listing-8.xml"/>
186-
<para>The different JMX objects in eXist are organized into categories. One or more
187-
categories can be passed to the servlet in parameter <literal>c</literal>. The
188-
following categories are recognized:</para>
172+
<para>The different JMX objects in eXist are organized into categories. One or more categories can be passed to the servlet in the URL parameter <literal>c</literal>. The following categories are recognized:</para>
189173
<variablelist>
190174
<varlistentry>
191175
<term><code>memory</code></term>
@@ -209,7 +193,7 @@
209193
<varlistentry>
210194
<term><code>system</code></term>
211195
<listitem>
212-
<para>Contains system information: eXist version ...</para>
196+
<para>Contains system information, such as the running eXist version.</para>
213197
</listitem>
214198
</varlistentry>
215199
<varlistentry>

0 commit comments

Comments
 (0)