Skip to content

Commit f91aaa9

Browse files
author
Tim Middleton
committed
Readme updates
1 parent 806d76e commit f91aaa9

File tree

1 file changed

+26
-7
lines changed

1 file changed

+26
-7
lines changed

README.adoc

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,29 @@ questions.
2424
///////////////////////////////////////////////////////////////////////////////
2525
= Coherence VisualVM Plugin
2626

27-
The Coherence-VisualVM Plugin provides management and monitoring of a single Coherence cluster using the VisualVM management utility.
27+
The Coherence-VisualVM Plugin (the Plugin) provides management and monitoring of a single Coherence cluster using the VisualVM management utility.
2828

29-
The plugin aggregates Coherence MBean data and shows a concise operational view of a single Coherence cluster.
29+
The Plugin aggregates Coherence MBean data and shows a concise operational view of a single Coherence cluster.
3030
Some management information is presented over time, which allows real-time analysis and troubleshooting.
3131
You can connect to clusters via JMX or via management over REST with Coherence versions 14.1.1 or above.
3232

3333
The Plugin is an ideal tool for monitoring and managing Coherence clusters during the development and testing lifecycle and supports connecting to both
3434
Community Edition and open source versions of Coherence.
3535

36-
NOTE: This version of the plugin requires VisualVM release 2.0.4 or later which is available from https://visualvm.github.io/.
36+
NOTE: This version of the Plugin requires VisualVM release 2.0.4 or later which is available from https://visualvm.github.io/.
3737

3838
image::assets/coherence-visualvm.png[Coherence VisualVM Plugin,800,479]
3939

40+
== Supported Coherence Versions
41+
42+
The Plugin will connect to and display data for the following Coherence versions:
43+
44+
**Community Editions**: 14.1.1.0.x, 20.06, 20.06.1
45+
46+
**Commercial Editions**: 12.2.1.5.x, 12.2.1.4.x, 12.1.3.x, 12.1.2.x and 3.7.1.x
47+
48+
NOTE: If you wish to connect to Coherence version 12.2.1.4.x via REST you should have Coherence version 12.2.1.4.7 or greater.
49+
4050
== Installing the Plugin from VisualVM
4151

4252
The Coherence VisualVM Plugin is available from the list of plugins in VisualVM versions 2.0.4 and above.
@@ -59,9 +69,19 @@ Other useful resources:
5969

6070
Read on if you want to build the Plugin manually.
6171

72+
== Connecting to a Coherence Cluster
73+
74+
Once the Plugin is installed, you can double-click to a Coherence process, usually
75+
`com.tangosol.net.DefaultCacheServer`, and the `Coherence` tab is displayed.
76+
77+
You can also connect via Coherence Management over REST by right-clicking on the
78+
`Coherence Clusters` tree item and choose `Add Coherence Cluster`. See the https://docs.oracle.com/en/middleware/standalone/coherence/14.1.1.0/manage/using-jmx-manage-oracle-coherence.html#GUID-9A5B5F14-26A6-49CF-8C0C-3533A5DFB9C6[Coherence Documentation]
79+
for more information on connecting via REST.
80+
81+
6282
== Changing the Plugin Behaviour via System Properties
6383

64-
There are a number of properties that change the behaviour of the VisualVM Plugin. To pass these properties
84+
There are a number of properties that change the behaviour of the Plugin. To pass these properties
6585
to VisvualVM you have to use the `-J` option. For example to change the refresh time from the default
6686
of 30 seconds, you can do the following:
6787

@@ -190,8 +210,7 @@ $ mvn -DnetbeansInstallDirectory=dist/visualvm \
190210
NOTE: See https://github.com/oracle/visualvm/blob/release204/README.md[here] for instructions on how to
191211
push the artefacts to a remote Maven repository.
192212

193-
=== Build the VisualVM Plugin
194-
NOTE: Ensure you change to a completely new directory to clone the Coherence CE repository.
213+
==== Build the VisualVM Plugin
195214

196215
1. Ensure you have JDK11 or above in your PATH.
197216

@@ -211,4 +230,4 @@ If you wish to run the Community Edition tests then leave out the `-DskipTests`.
211230
The plugin will be available in the location `coherence-visualvm-plugin/target/coherence-visualvm-plugin-{version}`
212231

213232
Follow the instructions https://docs.oracle.com/en/middleware/standalone/coherence/14.1.1.0/manage/using-jmx-manage-oracle-coherence.html[here]
214-
to install the plugin.
233+
to install the plugin manually.

0 commit comments

Comments
 (0)