Merge pull request #4963 from evolvedbinary/hotfix/jmx-tabular-data

Improve JMX output

Author: dizzzz

exist-core/src/main/java/org/exist/management/impl/ExistMBean.java

@@ -0,0 +1,40 @@
+/*
+ * eXist-db Open Source Native XML Database
+ * Copyright (C) 2001 The eXist-db Authors
+ *
+ * [email protected]
+ * http://www.exist-db.org
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+package org.exist.management.impl;
+
+import javax.management.MalformedObjectNameException;
+import javax.management.ObjectName;
+
+/**
+ * Interface for all eXist-db provided MBeans.
+ */
+public interface ExistMBean {
+
+    /**
+     * Get the name of the MBean.
+     *
+     * @return the name of the mbean.
+     *
+     * @throws MalformedObjectNameException if the name cannot be constructed.
+     */
+    ObjectName getName() throws MalformedObjectNameException;
+}

exist-core/src/main/java/org/exist/management/impl/JMXAgent.java

@@ -70,7 +70,8 @@ public JMXAgent() {
 
     private void registerSystemMBeans() {
         try {
-            addMBean(new ObjectName(SystemInfo.OBJECT_NAME), new org.exist.management.impl.SystemInfo());
+            final SystemInfoMXBean systemInfoMXBean = new org.exist.management.impl.SystemInfo();
+            addMBean(systemInfoMXBean.getName(), systemInfoMXBean);
         } catch (final MalformedObjectNameException | DatabaseConfigurationException e) {
             LOG.warn("Exception while registering cache mbean.", e);
         }

exist-core/src/main/java/org/exist/management/impl/PerInstanceMBean.java

@@ -22,10 +22,6 @@
 
 package org.exist.management.impl;
 
-import javax.management.MalformedObjectNameException;
-import javax.management.ObjectName;
-
-public interface PerInstanceMBean {
+public interface PerInstanceMBean extends ExistMBean {
     String getInstanceId();
-    ObjectName getName() throws MalformedObjectNameException;
 }

exist-core/src/main/java/org/exist/management/impl/ProcessReport.java

@@ -21,8 +21,10 @@
  */
 package org.exist.management.impl;
 
-import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
+import java.util.HashMap;
+import java.util.TreeMap;
 
 import org.exist.scheduler.ScheduledJobInfo;
 import org.exist.scheduler.Scheduler;
@@ -66,30 +68,30 @@ public String getInstanceId() {
     }
 
     @Override
-    public List<Job> getScheduledJobs() {
-        final List<Job> jobList = new ArrayList<>();
+    public Map<String, Job> getScheduledJobs() {
+        final Map<String, Job> jobList = new HashMap<>();
 
         final List<ScheduledJobInfo> jobs = scheduler.getScheduledJobs();
         for (final ScheduledJobInfo job : jobs) {
-            jobList.add(new Job(job.getName(), job.getGroup(), job.getTriggerExpression()));
+            jobList.put(job.getName(), new Job(job.getName(), job.getGroup(), job.getTriggerExpression()));
         }
         return jobList;
     }
 
     @Override
-    public List<Job> getRunningJobs() {
-        final List<Job> jobList = new ArrayList<>();
+    public Map<String, Job> getRunningJobs() {
+        final Map<String, Job> jobList = new HashMap<>();
 
         final ProcessMonitor.JobInfo[] jobs = processMonitor.runningJobs();
         for (final ProcessMonitor.JobInfo job : jobs) {
-            jobList.add(new Job(job.getThread().getName(), job.getAction(), job.getAddInfo().toString()));
+            jobList.put(job.getThread().getName(), new Job(job.getThread().getName(), job.getAction(), job.getAddInfo().toString()));
         }
         return jobList;
     }
 
     @Override
-    public List<RunningQuery> getRunningQueries() {
-        final List<RunningQuery> queries = new ArrayList<>();
+    public Map<QueryKey, RunningQuery> getRunningQueries() {
+        final Map<QueryKey, RunningQuery> queries = new TreeMap<>();
 
         final XQueryWatchDog[] watchdogs = processMonitor.getRunningXQueries();
         for (final XQueryWatchDog watchdog : watchdogs) {
@@ -98,7 +100,8 @@ public List<RunningQuery> getRunningQueries() {
                 requestURI = ProcessMonitor.getRequestURI(watchdog);
             }
 
-            queries.add(new RunningQuery(watchdog, requestURI));
+            final RunningQuery runningQuery = new RunningQuery(watchdog, requestURI);
+            queries.put(new QueryKey(runningQuery.getId(), runningQuery.getSourceKey()), runningQuery);
         }
         return queries;
     }
@@ -119,12 +122,12 @@ public void killQuery(final int id) {
     }
 
     @Override
-    public List<RecentQueryHistory> getRecentQueryHistory() {
-        final List<RecentQueryHistory> history = new ArrayList<>();
+    public Map<QueryKey, RecentQueryHistory> getRecentQueryHistory() {
+        final Map<QueryKey, RecentQueryHistory> history = new TreeMap<>();
         final QueryHistory[] queryHistories = processMonitor.getRecentQueryHistory();
-        int i = 0;
-        for (final QueryHistory queryHistory : queryHistories) {
-            history.add(new RecentQueryHistory(i++, queryHistory));
+        for (int i = 0; i < queryHistories.length; i++) {
+            final QueryHistory queryHistory = queryHistories[i];
+            history.put(new QueryKey(i, queryHistory.getSource()), new RecentQueryHistory(i, queryHistory));
         }
         return history;
     }

exist-core/src/main/java/org/exist/management/impl/ProcessReportMXBean.java

@@ -21,18 +21,18 @@
  */
 package org.exist.management.impl;
 
-import java.util.List;
+import java.util.Map;
 
 public interface
 ProcessReportMXBean extends PerInstanceMBean {
 
-    List<Job> getScheduledJobs();
+    Map<String, Job> getScheduledJobs();
 
-    List<Job> getRunningJobs();
+    Map<String, Job> getRunningJobs();
 
-    List<RunningQuery> getRunningQueries();
+    Map<QueryKey, RunningQuery> getRunningQueries();
 
-    List<RecentQueryHistory> getRecentQueryHistory();
+    Map<QueryKey, RecentQueryHistory> getRecentQueryHistory();
 
     void killQuery(int id);
 
@@ -77,4 +77,54 @@
     void setTrackRequestURI(boolean track);
 
     boolean getTrackRequestURI();
+
+    class QueryKey implements Comparable<QueryKey> {
+        private final int id;
+        private final String key;
+
+        public QueryKey(final int id, final String key) {
+            this.id = id;
+            this.key = key;
+        }
+
+        public int getId() {
+            return id;
+        }
+
+        public String getKey() {
+            return key;
+        }
+
+        @Override
+        public boolean equals(final Object other) {
+            if (this == other) {
+                return true;
+            }
+            if (other == null || getClass() != other.getClass()) {
+                return false;
+            }
+
+            QueryKey queryKey = (QueryKey) other;
+            if (id != queryKey.id) {
+                return false;
+            }
+            return key.equals(queryKey.key);
+        }
+
+        @Override
+        public int hashCode() {
+            int result = id;
+            result = 31 * result + key.hashCode();
+            return result;
+        }
+
+        @Override
+        public int compareTo(final QueryKey other) {
+            if (other == null) {
+                return 1;
+            }
+
+            return key.compareTo(other.key);
+        }
+    }
 }

exist-core/src/main/java/org/exist/management/impl/RecentQueryHistory.java

@@ -29,14 +29,14 @@
  */
 public class RecentQueryHistory {
 
-    private int idx;
-    private String sourceKey;
-    private int recentInvocationCount;
-    private long mostRecentExecutionTime;
-    private long mostRecentExecutionDuration;
-    private String requestURI;
+    private final int idx;
+    private final String sourceKey;
+    private final int recentInvocationCount;
+    private final long mostRecentExecutionTime;
+    private final long mostRecentExecutionDuration;
+    private final String requestURI;
 
-    public RecentQueryHistory(int idx, ProcessMonitor.QueryHistory queryHistory) {
+    public RecentQueryHistory(final int idx, final ProcessMonitor.QueryHistory queryHistory) {
         this.idx = idx;
         this.sourceKey = queryHistory.getSource();
         this.recentInvocationCount = queryHistory.getInvocationCount();

exist-core/src/main/java/org/exist/management/impl/RunningQuery.java

@@ -29,13 +29,13 @@
  */
 public class RunningQuery {
 
-    int id;
-    String sourceType;
-    String sourceKey;
-    boolean terminating;
-    String requestURI;
-    String thread;
-    long elapsed;
+    private final int id;
+    private final String sourceType;
+    private final String sourceKey;
+    private final boolean terminating;
+    private final String requestURI;
+    private final String thread;
+    private final long startTime;
 
     public RunningQuery(final XQueryWatchDog watchdog, final String requestURI) {
         this.id = watchdog.getContext().hashCode();
@@ -44,7 +44,7 @@ public RunningQuery(final XQueryWatchDog watchdog, final String requestURI) {
         this.terminating = watchdog.isTerminating();
         this.requestURI = requestURI;
         this.thread = watchdog.getRunningThread();
-        this.elapsed = System.currentTimeMillis() - watchdog.getStartTime();
+        this.startTime = watchdog.getStartTime();
     }
 
     public int getId() {
@@ -71,7 +71,11 @@ public String getThread() {
         return thread;
     }
 
+    public long getStartTime() {
+        return startTime;
+    }
+
     public long getElapsed() {
-        return elapsed;
+        return System.currentTimeMillis() - startTime;
     }
 }

exist-core/src/main/java/org/exist/management/impl/SystemInfo.java

@@ -26,6 +26,9 @@
 
 import org.exist.SystemProperties;
 
+import javax.management.MalformedObjectNameException;
+import javax.management.ObjectName;
+
 /**
  * Class SystemInfo
  * 
@@ -36,6 +39,11 @@ public class SystemInfo implements SystemInfoMXBean {
 
     public static final String OBJECT_NAME = "org.exist.management:type=SystemInfo";
 
+    @Override
+    public ObjectName getName() throws MalformedObjectNameException {
+        return new ObjectName(OBJECT_NAME);
+    }
+
     @Override
     public String getProductName() {
         return SystemProperties.getInstance().getSystemProperty("product-name","eXist");

exist-core/src/main/java/org/exist/management/impl/SystemInfoMXBean.java

@@ -27,7 +27,7 @@
  * @author wessels
  * @author ljo
  */
-public interface SystemInfoMXBean {
+public interface SystemInfoMXBean extends ExistMBean {
     String getProductName();
 
     String getProductVersion();