Skip to content

armgit / core

Public Imported from GitHub
0

100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps

Add JVM metrics to prometheus endpoint (#1970)

Eric Bariaux3735b7271e29
diff --git a/manager/src/main/java/org/openremote/manager/system/JvmHealthStatusProvider.java b/manager/src/main/java/org/openremote/manager/system/JvmHealthStatusProvider.java
index 7e4a78248..ef3cd10ca 100644
--- a/manager/src/main/java/org/openremote/manager/system/JvmHealthStatusProvider.java
+++ b/manager/src/main/java/org/openremote/manager/system/JvmHealthStatusProvider.java
@@ -19,6 +19,13 @@
*/
package org.openremote.manager.system;
+import io.micrometer.core.instrument.binder.jvm.JvmGcMetrics;
+import io.micrometer.core.instrument.binder.jvm.JvmHeapPressureMetrics;
+import io.micrometer.core.instrument.binder.jvm.JvmInfoMetrics;
+import io.micrometer.core.instrument.binder.jvm.JvmMemoryMetrics;
+import io.micrometer.core.instrument.binder.jvm.JvmThreadDeadlockMetrics;
+import io.micrometer.core.instrument.binder.jvm.JvmThreadMetrics;
+import io.micrometer.core.instrument.binder.system.ProcessorMetrics;
import org.openremote.model.Container;
import org.openremote.model.system.HealthStatusProvider;
@@ -26,12 +33,19 @@ import java.lang.management.ManagementFactory;
import java.lang.management.MemoryMXBean;
import java.lang.management.RuntimeMXBean;
import java.lang.management.ThreadMXBean;
+import java.util.ArrayList;
import java.util.HashMap;
+import java.util.List;
import java.util.Map;
+import static java.lang.System.Logger.Level.WARNING;
+
public class JvmHealthStatusProvider implements HealthStatusProvider {
public static final String NAME = "jvm";
+ public static final System.Logger LOG = System.getLogger(JvmHealthStatusProvider.class.getName());
+
+ private List<AutoCloseable> closeables;
@Override
public void init(Container container) throws Exception {
@@ -40,12 +54,36 @@ public class JvmHealthStatusProvider implements HealthStatusProvider {
@Override
public void start(Container container) throws Exception {
+ if (container.getMeterRegistry() != null) {
+ this.closeables = new ArrayList<>();
+ new JvmInfoMetrics().bindTo(container.getMeterRegistry());
+ new JvmMemoryMetrics().bindTo(container.getMeterRegistry());
+ JvmGcMetrics jvmGcMetrics = new JvmGcMetrics();
+ closeables.add(jvmGcMetrics);
+ jvmGcMetrics.bindTo(container.getMeterRegistry());
+ new ProcessorMetrics().bindTo(container.getMeterRegistry());
+ new JvmThreadMetrics().bindTo(container.getMeterRegistry());
+ new JvmThreadDeadlockMetrics().bindTo(container.getMeterRegistry());
+ JvmHeapPressureMetrics jvmHeapPressureMetrics = new JvmHeapPressureMetrics();
+ closeables.add(jvmHeapPressureMetrics);
+ jvmHeapPressureMetrics.bindTo(container.getMeterRegistry());
+ }
}
@Override
public void stop(Container container) throws Exception {
+ if (closeables != null) {
+ closeables.forEach(this::safeClose);
+ }
+ }
+ private void safeClose(AutoCloseable it) {
+ try {
+ it.close();
+ } catch (Exception e) {
+ LOG.log(WARNING, "Error when closing {}", it, e);
+ }
}
@Override
diff --git a/test/src/test/groovy/org/openremote/test/metrics/MetricsEndpointTest.groovy b/test/src/test/groovy/org/openremote/test/metrics/MetricsEndpointTest.groovy
index 9ec60eca6..c9ab1111d 100644
--- a/test/src/test/groovy/org/openremote/test/metrics/MetricsEndpointTest.groovy
+++ b/test/src/test/groovy/org/openremote/test/metrics/MetricsEndpointTest.groovy
@@ -32,6 +32,13 @@ class MetricsEndpointTest extends Specification implements ManagerContainerTrait
def responseStr = response.readEntity(String.class)
responseStr.contains("executor_pool_core_threads{name=\"ContainerExecutor\"}")
+ and: "JVM related metrics are present"
+ responseStr.contains("jvm_info")
+ responseStr.contains("jvm_buffer_")
+ responseStr.contains("jvm_gc_")
+ responseStr.contains("jvm_memory_")
+ responseStr.contains("jvm_threads_")
+
cleanup: "clean up"
if (response != null) {
response.close()