Skip to content

Commit 0ba51a4

Browse files
author
Tim Middleton
authored
Add ability to analyze log files created with Partition Events Logging (#8)
* Add ability to analyze log files created with Partition Events Logging enabled * Minor formatting * Add workaround for REST bug
1 parent 1fbc1ce commit 0ba51a4

File tree

15 files changed

+2823
-43
lines changed

15 files changed

+2823
-43
lines changed

‎README.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ image::assets/coherence-visualvm.png[Coherence VisualVM Plugin,800,479]
5656

5757
The Plugin will connect to and display data for the following Coherence versions:
5858

59-
**Community Editions**: 14.1.1.0.x, 20.06.x and 20.12.x
59+
**Community Editions**: 14.1.1.0.x, 20.06.x, 20.12.x and 21.06
6060

6161
**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
6262

@@ -185,6 +185,7 @@ There are tool tips for each of the preferences, but a summary is shown below.
185185
| Enable Zoom on Graphs | false | Enables additional zoom function for all graphs.
186186
| 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.
187187
| Enable Cluster Heap Dump | false | Enables the cluster heap dump button on the Cluster Overview tab.
188+
| Analyze Unavailable Time in LogFile| | Provides the ability to analyze log files where Partition Events Logging has been enabled for logs generated from Coherence versions 21.06 and above. See https://coherence.community/21.06/docs/#/docs/core/07_partition_events_logging[here] for more details. Note: You select a Coherence log file to analyze and don't need to be connected to a running cluster.
188189
!===
189190

190191
[#capabilities]

‎assets/coherence-visualvm-preferences.png‎

2.12 KB
Loading

‎coherence-visualvm-plugin/pom.xml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,18 @@
115115
<groupId>com.fasterxml.jackson.core</groupId>
116116
<artifactId>jackson-databind</artifactId>
117117
</dependency>
118+
119+
<dependency>
120+
<groupId>org.hamcrest</groupId>
121+
<artifactId>hamcrest</artifactId>
122+
<scope>test</scope>
123+
</dependency>
124+
125+
<dependency>
126+
<groupId>junit</groupId>
127+
<artifactId>junit</artifactId>
128+
<scope>test</scope>
129+
</dependency>
118130
</dependencies>
119131

120132
<build>

‎coherence-visualvm-plugin/src/main/java/com/oracle/coherence/plugin/visualvm/CoherenceOptionsPanel.java‎

Lines changed: 354 additions & 4 deletions
Large diffs are not rendered by default.

‎coherence-visualvm-plugin/src/main/java/com/oracle/coherence/plugin/visualvm/helper/HttpRequestSender.java‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -804,9 +804,10 @@ public JsonNode getDataForStorageManagerMembers(String sServiceName, String sDom
804804
{
805805
URLBuilder urlBuilder = getBasePath().addPathSegment("services")
806806
.addPathSegment(encodeServiceName(sServiceName)).addPathSegment("caches").addPathSegment(sCacheName)
807-
.addPathSegment("members").addQueryParameter("fields", "nodeId," +
808-
"locksGranted,locksPending,listenerRegistrations,maxQueryDurationMillis,maxQueryDescription," +
809-
"nonOptimizedQueryAverageMillis,optimizedQueryAverageMillis,indexTotalUnits");
807+
.addPathSegment("members").addQueryParameter("fields",
808+
"nodeId,locksGranted,locksPending,listenerRegistrations,maxQueryDurationMillis,maxQueryDescription," +
809+
"nonOptimizedQueryAverageMillis,optimizedQueryAverageMillis,indexTotalUnits,indexingTotalMillis")
810+
.addQueryParameter("links", "");
810811

811812
if (sDomainPartition != null)
812813
{

‎coherence-visualvm-plugin/src/main/java/com/oracle/coherence/plugin/visualvm/panel/util/AbstractMenuOption.java‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131

3232
import java.awt.BorderLayout;
3333
import java.awt.Dialog;
34+
import java.awt.Font;
3435
import java.awt.Toolkit;
3536
import java.awt.Window;
3637
import java.awt.Dimension;
@@ -93,7 +94,7 @@ public AbstractMenuOption(VisualVMModel model, RequestSender requestSender, Expo
9394
* @param sMessage the message to display
9495
* @param nDialogType the type of dialog, e.g. JOptionPane.INFORMATION_MESSAGE
9596
*/
96-
protected void showMessageDialog(String sTitle, String sMessage, int nDialogType)
97+
protected static void showMessageDialog(String sTitle, String sMessage, int nDialogType)
9798
{
9899
showMessageDialog(sTitle, sMessage, nDialogType, 500, 400);
99100
}
@@ -108,7 +109,7 @@ protected void showMessageDialog(String sTitle, String sMessage, int nDialogType
108109
* @param nWidth the width of the dialog window
109110
* @param fCopySave true if copy and save buttons should be displayed
110111
*/
111-
protected void showMessageDialog(String sTitle, String sMessage, int nDialogType, int nLength, int nWidth, boolean fCopySave)
112+
public static void showMessageDialog(String sTitle, String sMessage, int nDialogType, int nLength, int nWidth, boolean fCopySave)
112113
{
113114
JTextArea txtArea = new JTextArea(sMessage);
114115
final JPanel panel = new JPanel();
@@ -118,6 +119,7 @@ protected void showMessageDialog(String sTitle, String sMessage, int nDialogType
118119
txtArea.setEditable(false);
119120
txtArea.setLineWrap(false);
120121
txtArea.setWrapStyleWord(true);
122+
txtArea.setFont(new Font("monospaced", Font.PLAIN, 12));
121123
pneMessage.setPreferredSize(new Dimension(nLength, nWidth));
122124

123125
setResizable(pneMessage);
@@ -174,7 +176,7 @@ protected void showMessageDialog(String sTitle, String sMessage, int nDialogType
174176
*
175177
* @return a filler {@link JLabel}
176178
*/
177-
private JLabel getFiller()
179+
private static JLabel getFiller()
178180
{
179181
JLabel label = new JLabel();
180182
label.setText(" ");
@@ -188,7 +190,7 @@ private JLabel getFiller()
188190
*
189191
* @return true if the file was saved
190192
*/
191-
private boolean saveContentsToFile(File file, String sContents)
193+
private static boolean saveContentsToFile(File file, String sContents)
192194
{
193195
PrintStream fileWriter = null;
194196

@@ -223,7 +225,7 @@ private boolean saveContentsToFile(File file, String sContents)
223225
* @param nLength the length of the dialog window
224226
* @param nWidth the width of the dialog window
225227
*/
226-
protected void showMessageDialog(String sTitle, String sMessage, int nDialogType, int nLength, int nWidth)
228+
protected static void showMessageDialog(String sTitle, String sMessage, int nDialogType, int nLength, int nWidth)
227229
{
228230
showMessageDialog(sTitle, sMessage, nDialogType, nLength, nWidth,false);
229231
}

‎coherence-visualvm-plugin/src/main/java/com/oracle/coherence/plugin/visualvm/panel/util/ExportableJTable.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -308,8 +308,7 @@ private boolean validateFileSelection(File file)
308308
{
309309
if (file.exists())
310310
{
311-
String sQuestion = Localization.getLocalText("LBL_file_already_exists",
312-
new String[] {file.getAbsolutePath()});
311+
String sQuestion = Localization.getLocalText("LBL_file_already_exists", file.getAbsolutePath());
313312

314313
if (JOptionPane.showConfirmDialog(null, sQuestion, Localization.getLocalText("LBL_confirm"),
315314
JOptionPane.YES_NO_OPTION) == JOptionPane.YES_OPTION)

‎coherence-visualvm-plugin/src/main/java/com/oracle/coherence/plugin/visualvm/tablemodel/model/CacheStorageManagerData.java‎

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -100,14 +100,17 @@ public List<Map.Entry<Object, Data>> getJMXData(RequestSender requestSender, Vis
100100
new String[]{ ATTR_LOCKS_GRANTED, ATTR_LOCKS_PENDING, ATTR_LISTENER_REG });
101101

102102
String sLocksGranted = getAttributeValueAsString(listAttr, ATTR_LOCKS_GRANTED);
103+
String sLocksPending = getAttributeValueAsString(listAttr, ATTR_LOCKS_PENDING);
104+
String sListenerReg = getAttributeValueAsString(listAttr, ATTR_LOCKS_PENDING);
105+
103106
data.setColumn(CacheStorageManagerData.NODE_ID, Integer.valueOf(sNodeId));
104107
data.setColumn(CacheStorageManagerData.LOCKS_GRANTED,
105-
Integer.parseInt(getAttributeValueAsString(listAttr, ATTR_LOCKS_GRANTED)));
108+
Integer.parseInt(sLocksGranted == null ? "0" : sLocksGranted));
106109
// locks pending may be returns as null over REST
107110
data.setColumn(CacheStorageManagerData.LOCKS_PENDING,
108-
Integer.parseInt(sLocksGranted == null ? "0" : sLocksGranted));
111+
Integer.parseInt(sLocksPending == null ? "0" : sLocksPending));
109112
data.setColumn(CacheStorageManagerData.LISTENER_REGISTRATIONS,
110-
Long.parseLong(getAttributeValueAsString(listAttr, ATTR_LISTENER_REG)));
113+
Long.parseLong(sListenerReg == null ? "0" : sListenerReg));
111114
try {
112115
data.setColumn(CacheStorageManagerData.MAX_QUERY_DURATION,
113116
Long.parseLong(requestSender.getAttribute(objName, "MaxQueryDurationMillis")));
@@ -258,14 +261,26 @@ public SortedMap<Object, Data> getAggregatedDataFromHttpQuerying(VisualVMModel
258261
for (int i = 0; i < nodeCacheItems.size(); i++)
259262
{
260263
JsonNode nodeCacheStorage = nodeCacheItems.get(i);
261-
Data data = new CacheStorageManagerData();
264+
// Workaround Bug 33107052
265+
if (nodeCacheStorage.size() < 2)
266+
{
267+
continue;
268+
}
269+
Data data = new CacheStorageManagerData();
262270

263-
JsonNode locksGranted = nodeCacheStorage.get("locksGranted");
271+
JsonNode locksGranted = nodeCacheStorage.get("locksGranted");
264272
if (locksGranted == null)
265273
{
266274
// Connecting to version without Bug 32134281 fix so force less efficient way
267275
List<Map.Entry<Object, Data>> jmxData = getJMXData(requestSender, model);
268-
jmxData.forEach(e -> mapData.put(e.getKey(), e.getValue()));
276+
if (jmxData == null || jmxData.size() == 0)
277+
{
278+
return null;
279+
}
280+
else
281+
{
282+
jmxData.forEach(e -> mapData.put(e.getKey(), e.getValue()));
283+
}
269284
return mapData;
270285
}
271286

@@ -281,7 +296,7 @@ public SortedMap<Object, Data> getAggregatedDataFromHttpQuerying(VisualVMModel
281296
try
282297
{
283298
data.setColumn(CacheStorageManagerData.INDEX_TOTAL_UNITS,nodeCacheStorage.get("indexTotalUnits").asLong());
284-
data.setColumn(CacheStorageManagerData.INDEXING_TOTAL_MILLIS,nodeCacheStorage.get("IndexingTotalMillis").asLong());
299+
data.setColumn(CacheStorageManagerData.INDEXING_TOTAL_MILLIS,nodeCacheStorage.get("indexingTotalMillis").asLong());
285300
}
286301
catch (Exception ignore)
287302
{

‎coherence-visualvm-plugin/src/main/resources/com/oracle/coherence/plugin/visualvm/Bundle.properties‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -537,12 +537,13 @@ LBL_rest_request_timeout=REST Request Timeout\:
537537
LBL_millis=millis.
538538
LBL_enable_rest_debug=Enable REST debug\:
539539
LBL_other=Other / Experimental
540-
LBL_enable_heatmap=Enable Heat Map* \:
540+
LBL_analyze_log_file=Analyze Unavailable Time in Logfile
541541
LBL_enable_zoom=Enable Zoom on Graphs* \:
542542
LBL_enable_cluster_snapshot=Enable Cluster Snapshot Tab* \:
543543
LBL_enable_admin_functions=Enable Cluster Heap Dump* \:
544544
LBL_enable_persistence_list=Enable Persistence List* \:
545545
LBL_reconnect=Items marked with (*) take effect when you reconnect to a Coherence cluster.
546+
LBL_verbose=Do you want to include verbose partition level output?
546547
TTIP_refresh_time=Time (in seconds) between refreshing data from the cluster. Do not set too low as this could adversely affect performance in large clusters.
547548
TTIP_log_query_times=Enables logging of query times to the VisualVM logfile when retrieving data.
548549
TTIP_disable_mbean_check=Disables the MBean check when connecting to WebLogic Server. This allows the plugin to startup without checking for Cluster MBean.
@@ -551,4 +552,5 @@ TTIP_rest_debug=Enables HTTP request debugging when using REST to connect to a c
551552
TTIP_persistence_list=Enables dropdown list of snapshots rather than having to enter the snapshot when performing snapshot operations.
552553
TTIP_zoom_enabled=Enables additional zoom function for all graphs.
553554
TTIP_enable_cluster_snapshot=Enables experimental cluster snapshot tab.
554-
TTIP_enable_cluster_head_dump=Enables the cluster heap dump button on the Cluster Overview tab.
555+
TTIP_enable_cluster_head_dump=Enables the cluster heap dump button on the Cluster Overview tab.
556+
TTIP_LBL_analyze_log_file=Analyzes a Coherence log file that has Partition Events Logging enabled.

‎coherence-visualvm-plugin/src/test/java/com/oracle/coherence/plugin/visualvm/UnavailabilityTimeAnalyzerTest.java‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
/*
2+
* Copyright (c) 2021 Oracle and/or its affiliates. All rights reserved.
3+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
*
5+
* This code is free software; you can redistribute it and/or modify it
6+
* under the terms of the GNU General Public License version 2 only, as
7+
* published by the Free Software Foundation. Oracle designates this
8+
* particular file as subject to the "Classpath" exception as provided
9+
* by Oracle in the LICENSE file that accompanied this code.
10+
*
11+
* This code is distributed in the hope that it will be useful, but WITHOUT
12+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14+
* version 2 for more details (a copy is included in the LICENSE file that
15+
* accompanied this code).
16+
*
17+
* You should have received a copy of the GNU General Public License version
18+
* 2 along with this work; if not, write to the Free Software Foundation,
19+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20+
*
21+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22+
* or visit www.oracle.com if you need additional information or have any
23+
* questions.
24+
*/
25+
26+
package com.oracle.coherence.plugin.visualvm;
27+
28+
import org.junit.Test;
29+
30+
import java.io.File;
31+
import java.net.URL;
32+
33+
import static org.junit.Assert.assertNotNull;
34+
import static org.junit.Assert.assertTrue;
35+
36+
/**
37+
* Tests for the UnavailabilityTimeAnalyzer.
38+
*
39+
* @author Tim Middleton 2021.07.06
40+
*/
41+
public class UnavailabilityTimeAnalyzerTest
42+
{
43+
@Test
44+
public void testAnalyzeLogFile()
45+
{
46+
File fileLogFile = getTestResource("/test-logfile-1.log");
47+
48+
assertNotNull(fileLogFile);
49+
CoherenceOptionsPanel.UnavailabilityTimeAnalyzer analyzer =
50+
new CoherenceOptionsPanel.UnavailabilityTimeAnalyzer(fileLogFile);
51+
52+
String sResults = analyzer.analyze(true);
53+
assertNotNull(sResults);
54+
}
55+
56+
@Test
57+
public void testInvalidFile()
58+
{
59+
File fileLogFile = getTestResource("/test-logfile-2.log");
60+
61+
assertNotNull(fileLogFile);
62+
CoherenceOptionsPanel.UnavailabilityTimeAnalyzer analyzer =
63+
new CoherenceOptionsPanel.UnavailabilityTimeAnalyzer(fileLogFile);
64+
65+
String sResults = analyzer.analyze(true);
66+
assertTrue(sResults.contains("No services found. This may not be a Coherence log file."));
67+
}
68+
69+
// ----- helpers --------------------------------------------------------
70+
71+
private File getTestResource(String sResource)
72+
{
73+
URL resource = this.getClass().getResource(sResource);
74+
assertNotNull(resource);
75+
return new File(resource.getFile());
76+
}
77+
78+
// ----- data members ---------------------------------------------------
79+
80+
private File testLogfile;
81+
}

0 commit comments

Comments
 (0)