You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
NOTE: If you already have an older version of the plugin installed, click on `Check For Newest` and follow the prompts.
80
+
67
81
For more information about using the Coherence VisualVM plugin see the official https://docs.oracle.com/en/middleware/standalone/coherence/14.1.1.0/manage/using-jmx-manage-oracle-coherence.html[Coherence Documentation].
* https://github.com/oracle/coherence-operator[The Coherence Operator - Run your clusters in Kubernetes]
76
90
77
-
Read on if you want to build the Plugin manually.
78
-
91
+
[#connect]
79
92
== Connecting to a Coherence Cluster
80
93
81
-
Once the Plugin is installed, you can double-click on a Coherence process in the left pane, usually
82
-
`com.tangosol.net.DefaultCacheServer`, after which a `Coherence` tab will be displayed.
94
+
=== 1. Connecting Directly to a Process
95
+
96
+
Once the Plugin is installed, you can double-click on a Coherence process in the left pane, usually `com.tangosol.net.DefaultCacheServer`, after which a `Coherence` tab will be displayed.
97
+
98
+
=== 2. Connecting via Management over REST
99
+
100
+
You can also connect via Coherence Management over REST by right-clicking on the `Coherence Clusters` tree item and choose `Add Coherence Cluster`.
101
+
102
+
Provide a name for the cluster and use the following URL based upon what type of cluster you are connecting to:
2. WebLogic Server - `http://<admin-host>:<admin-port>/management/coherence/<version>/clusters` - You can use `latest` as the version.
83
107
84
-
You can also connect via Coherence Management over REST by right-clicking on the
85
-
`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]
86
-
for more information on connecting via REST.
108
+
NOTE: To enable Management over REST for a stand-alone cluster, please see the
=== 3. Connecting to Coherence in WebLogic Server via the Admin Server
89
112
90
113
If you have Coherence running within WebLogic Server using the `Managed Coherence Servers` functionality you can either
91
114
connect via REST as described above or if you want to connect to the `domain runtime MBean server`, use the instructions below.
@@ -131,41 +154,68 @@ You may remove it from the above `--cp` statement if you like.
131
154
132
155
7. Right-Click on the connection and select `Open`. The Coherence tab will be displayed.
133
156
157
+
NOTE: If you wish to secure access to the REST endpoints or via JMX, please refer to either the https://docs.oracle.com/en/middleware/standalone/coherence/14.1.1.0/index.html[Coherence Documentation]
158
+
or relevant JMX security documentation.
134
159
135
-
== Changing the Plugin Behaviour via System Properties
160
+
[#prefs]
161
+
== Changing the Plugin Behaviour via the Options Tab
136
162
137
-
There are a number of properties that change the behaviour of the Plugin. To pass these properties
138
-
to VisvualVM you have to use the `-J` option. For example to change the refresh time from the default
139
-
of 30 seconds, you can do the following:
163
+
In version 1.0.1 or above of the VisualVM Plugin, you can change the behaviour of the plugin
164
+
by using the Options pane. To open the options choose the following depending upon your platform:
There are tool tips for each of the preferences, but a summary is shown below.
175
+
176
+
.Table Coherence VisualVM Preferences
149
177
!===
150
-
|Property | Default | Usage
151
-
| coherence.plugin.visualvm.refreshtime| 30 | Time (in seconds) between refreshing data from the cluster. Do not set too low as this could adversely affect performance in large clusters
152
-
| coherence.plugin.visualvm.log.query.times| false | Enables logging of query times when retrieving data
| coherence.plugin.visualvm.persistence.list | true | Enables dropdown list of snapshots when performing snapshot operations
156
-
| coherence.plugin.visualvm.zoom.enabled | false | Enables additional zoom function for all graphs
157
-
| coherence.plugin.visualvm.rest.request.timeout | 30000 | The request timeout (in ms) when using REST to connect to a cluster
158
-
| coherence.plugin.visualvm.rest.request.debug | false | Enables HTTP request debugging using REST to connect to a cluster
159
-
| coherence.plugin.visualvm.disable.mbean.check | false | Disables the MBean check when connecting to WebLogic Server
178
+
|Preference | Default | Usage
179
+
| Data Refresh Time| 30 | Time (in seconds) between refreshing data from the cluster. Do not set too low as this could adversely affect performance in large clusters.
180
+
| Log Query Times| false | Enables logging of query times to the VisualVM logfile when retrieving data.
181
+
| Disable MBean Check | false | Disables the MBean check when connecting to WebLogic Server. This allows the plugin to startup without checking for Cluster MBean.
182
+
| REST Request Timeout | 30000 | The request timeout (in ms) when using REST to connect to a cluster.
183
+
| Enable REST Debug | false | Enables HTTP request debugging when using REST to connect to a cluster.
184
+
| Enable Persistence List | true | Enables dropdown list of snapshots rather than having to enter the snapshot when performing snapshot operations.
185
+
| Enable Zoom on Graphs | false | Enables additional zoom function for all graphs.
186
+
| Enable Cluster Snapshot tab | false | Enables experimental Cluster Snapshot tab. This tab is useful for seeing all the relevant cluster information on one pae in a text format.
187
+
| Enable Cluster Heap Dump | false | Enables the cluster heap dump button on the Cluster Overview tab.
160
188
!===
161
189
162
-
NOTE: If you have used older versions of the Coherence VisualVM plugin available with Coherence, you should
163
-
ensure you are using the new property names above.
190
+
[#capabilities]
191
+
== Monitoring Capabilities
192
+
193
+
For all Coherence clusters, the following tabs are displayed:
194
+
195
+
* **Cluster Overview** - Displays high-level information about the Coherence cluster including cluster name, version, member count and 'Cluster StatusHA'. Summary graphs show total cluster memory available and used, packet publisher and receiver success rates and load averages for machines running Coherence.
196
+
* **Machines** - Displays a list of the physical machines that make up the Coherence cluster as well as information about the load averages and available memory on these machines.
197
+
* **Members** - Displays the full list of Coherence members/nodes including individual publisher/ receiver success rates, memory and send queue sizes.
198
+
* **Services** - Displays information about the running services including partition counts and statusHA values.
199
+
If you select a service, on the next data refresh you will see detailed thread information for each node of the service as well as
200
+
graphs of that information
201
+
* **Caches** - Displays information about any caches including size, and memory usage information. To get the correct information to be displayed for memory usage, you must be using the binary unit-calculator. If you select a cache, on the next data refresh you will see detailed information about each node hosting that service and cache.
202
+
203
+
Depending upon the edition and functionality you are using, the following optional tabs may be displayed:
204
+
205
+
* **Proxy Servers** - If your cluster is running proxy servers, this tab displays information about the proxy servers and the number of connections across each proxy server and total connections.
206
+
* **HTTP Servers** - If your cluster is running proxy servers with HTTP acceptors, this tab displays information about the HTTP servers, the number of connections across each server, total connections and graphs of response codes, errors and requests over time for a selected service.
207
+
* **Coherence*Web** - If your cluster is configured for Coherence*Web, this tab displays information about the number applications deployed, the number of HTTP sessions being stored as well as other information regarding session reaping.
208
+
* **Federation** - If your cluster is configured with Federated Caching, this tab displays information about each federated service. If you select a service, on the next data refresh you will see detailed outbound/inbound federation traffic information for each node of the service as well as graphs of that information.
209
+
* **Persistence** - If your cluster is configured with Persistence, this tab displays information about each service configured with Persistence. Graphs showing active space used and any additional latencies incurred are also showed.
210
+
* **Elastic Data** - If your cluster is configured with Elastic Data, this tab displays graphs and information about RAM Journal and Flash Journal usage. You can click on each of the usage bars to show detailed node information
211
+
* **JCache** - If your cluster is being used to store JCache caches, this tab displays JCache "Management" and "Statistics" MBean information regarding the configured caches.
212
+
* **HotCache** - If your cluster contains HotCache node(s), then this tab lists the running HotCache instances. If you select an instance, on the next data refresh the console will display statistics and graphs for the operations performed. You may click on tabs and cache-ops to see further fine-grained information.
164
213
214
+
[#build]
165
215
== Building the Plugin
166
216
167
217
If you wish to build the Plugin from scratch you need to build the VisualVM dependencies first.
168
-
To build the plugin is a twostep process:
218
+
To build the plugin is a two-step process:
169
219
170
220
1. Generate the VisualVM dependencies
171
221
2. Build the Coherence VisualVM Plugin
@@ -197,7 +247,7 @@ NOTE: A Script `install-artifacts.sh` is available in the `bin` directory to run
which allows you to view Coherence related information for that cluster. <br><br> \
33
33
The following tabs are displayed: \
34
34
<ul> \
35
-
<li>Overview - Displays high-level information about the Coherence cluster including cluster name, version, member count and 'Cluster StatusHA'. Summary graphs show total cluster memory available and used, packet publisher and receiver success rates and load averages for machines running Coherence.</li> \
35
+
<li>Cluster Overview - Displays high-level information about the Coherence cluster including cluster name, version, member count and 'Cluster StatusHA'. Summary graphs show total cluster memory available and used, packet publisher and receiver success rates and load averages for machines running Coherence.</li> \
36
36
<li>Machines - Displays a list of the physical machines that make up the Coherence cluster as well as information about the load averages and available memory on these machines.</li> \
37
37
<li>Members - Displays the full list of Coherence members/nodes including individual publisher/ receiver success rates, memory and send queue sizes.</li> \
38
38
<li>Services - Displays information about the running services including partition counts and statusHA values. If you select a service, on the next data refresh you will see detailed thread information for each node of the service as well as graphs of that information. </li> \
0 commit comments