|
14 | 14 |
|
15 | 15 | <!-- ================================================================== -->
|
16 | 16 |
|
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> |
27 | 20 |
|
28 | 21 | <!-- ================================================================== -->
|
29 | 22 |
|
30 | 23 | <sect1 xml:id="enable">
|
31 | 24 | <title>Enabling the JMX agent</title>
|
32 | 25 |
|
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> |
35 | 27 | <programlisting xlink:href="listings/listing-1.txt"/>
|
36 | 28 | <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> |
40 | 30 | </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> |
45 | 32 | <programlisting xlink:href="listings/listing-2.txt"/>
|
46 | 33 | </sect1>
|
47 | 34 |
|
48 | 35 | <!-- ================================================================== -->
|
49 | 36 |
|
50 | 37 | <sect1 xml:id="monitoring">
|
51 | 38 | <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> |
53 | 40 |
|
54 | 41 |
|
55 | 42 |
|
|
58 | 45 | <sect2 xml:id="jconsole">
|
59 | 46 | <title>Use JConsole</title>
|
60 | 47 |
|
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> |
63 | 49 | <programlisting>jconsole localhost:1099</programlisting>
|
64 | 50 | <para>Clicking on the <guimenuitem>MBeans</guimenuitem> tab should show some
|
65 | 51 | eXist-specific MBeans below the standard Java MBeans (in the tree component to the
|
|
174 | 160 | <para>the client accesses the API on localhost</para>
|
175 | 161 | </listitem>
|
176 | 162 | <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> |
178 | 164 | </listitem>
|
179 | 165 | </itemizedlist>
|
180 | 166 | </note>
|
181 | 167 | <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> |
183 | 169 | </note>
|
184 | 170 | <para>This returns something like:</para>
|
185 | 171 | <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> |
189 | 173 | <variablelist>
|
190 | 174 | <varlistentry>
|
191 | 175 | <term><code>memory</code></term>
|
|
209 | 193 | <varlistentry>
|
210 | 194 | <term><code>system</code></term>
|
211 | 195 | <listitem>
|
212 |
| - <para>Contains system information: eXist version ...</para> |
| 196 | + <para>Contains system information, such as the running eXist version.</para> |
213 | 197 | </listitem>
|
214 | 198 | </varlistentry>
|
215 | 199 | <varlistentry>
|
|
0 commit comments