Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Add JVM hardware info to diagnostic details (#75561)

Rodrigo López Dato4015a7408ed1
diff --git a/src/metabase/util/system_info.clj b/src/metabase/util/system_info.clj
index 026e17c9684..0b1344d901b 100644
--- a/src/metabase/util/system_info.clj
+++ b/src/metabase/util/system_info.clj
@@ -1,20 +1,38 @@
-(ns metabase.util.system-info)
+(ns metabase.util.system-info
+ (:require
+ [metabase.util.format :as u.format])
+ (:import
+ (com.sun.management OperatingSystemMXBean)
+ (java.lang.management ManagementFactory)))
(set! *warn-on-reflection* true)
+(defn- jvm-hardware-info
+ "JVM hardware resources, useful for diagnosing performance problems."
+ []
+ (let [runtime (Runtime/getRuntime)
+ os-bean (ManagementFactory/getOperatingSystemMXBean)]
+ (cond-> {"jvm.available-processors" (.availableProcessors runtime)
+ "jvm.max-memory" (u.format/format-bytes (.maxMemory runtime))}
+ ;; total physical memory on the host, not just what the JVM was allotted
+ (instance? OperatingSystemMXBean os-bean)
+ (assoc "system.total-memory"
+ (u.format/format-bytes (.getTotalMemorySize ^OperatingSystemMXBean os-bean))))))
+
(defn system-info
"System info we ask for for bug reports"
[]
(into (sorted-map)
- (select-keys (System/getProperties) ["java.runtime.name"
- "java.runtime.version"
- "java.vendor"
- "java.vendor.url"
- "java.version"
- "java.vm.name"
- "java.vm.version"
- "os.name"
- "os.version"
- "user.language"
- "user.timezone"
- "file.encoding"])))
+ (merge (select-keys (System/getProperties) ["java.runtime.name"
+ "java.runtime.version"
+ "java.vendor"
+ "java.vendor.url"
+ "java.version"
+ "java.vm.name"
+ "java.vm.version"
+ "os.name"
+ "os.version"
+ "user.language"
+ "user.timezone"
+ "file.encoding"])
+ (jvm-hardware-info))))
diff --git a/test/metabase/bug_reporting/api_test.clj b/test/metabase/bug_reporting/api_test.clj
index bcc80166015..78736c864ed 100644
--- a/test/metabase/bug_reporting/api_test.clj
+++ b/test/metabase/bug_reporting/api_test.clj
@@ -9,7 +9,11 @@
(is (= "You don't have permissions to do that."
(mt/user-http-request :rasta :get 403 "bug-reporting/details"))))
(testing "Call successful for superusers"
- (is (map? (mt/user-http-request :crowberto :get 200 "bug-reporting/details"))))))
+ (let [details (mt/user-http-request :crowberto :get 200 "bug-reporting/details")]
+ (is (map? details))
+ (testing "system-info includes JVM hardware info"
+ (is (pos-int? (get-in details [:system-info :jvm.available-processors])))
+ (is (string? (get-in details [:system-info :jvm.max-memory]))))))))
;;; see also [[metabase-enterprise.advanced-permissions.api.monitoring-test/connection-pool-info-permissions-test]]
(deftest ^:parallel connection-pool-details-permissions-test
diff --git a/test/metabase/util/system_info_test.clj b/test/metabase/util/system_info_test.clj
new file mode 100644
index 00000000000..e8e5e807f8b
--- /dev/null
+++ b/test/metabase/util/system_info_test.clj
@@ -0,0 +1,14 @@
+(ns metabase.util.system-info-test
+ (:require
+ [clojure.test :refer :all]
+ [metabase.util.system-info :as u.system-info]))
+
+(deftest system-info-test
+ (testing "system-info includes JVM hardware info for diagnosing performance problems"
+ (let [info (u.system-info/system-info)]
+ (testing "number of CPUs available to the JVM"
+ (is (pos-int? (get info "jvm.available-processors"))))
+ (testing "max memory available to the JVM, formatted like the startup log line"
+ (is (re-matches #"[\d.]+ [KMGT]?B" (get info "jvm.max-memory"))))
+ (testing "total physical memory on the host"
+ (is (re-matches #"[\d.]+ [KMGT]?B" (get info "system.total-memory")))))))