Collect JVM memory metrics (#2937)

* add jvm metrics * include all changes * Fix tests and lint errors * Fix formatting * Instantiate jvmmetrics class in stackdriver module * add metrics registration behaviour and explicit call * redo tests * fix formatting/variable name * lint
2026-08-21 06:36:15 +00:00 · 2026-01-21 21:27:07 +00:00
parent 41393e5f8d
commit a5c1412aac
3 changed files with 205 additions and 2 deletions
@@ -0,0 +1,96 @@
+// Copyright 2017 The Nomulus Authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package google.registry.monitoring.whitebox;
+
+import static com.google.common.truth.Truth.assertThat;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableMap;
+import com.google.monitoring.metrics.MetricRegistry;
+import com.google.monitoring.metrics.MetricRegistryImpl;
+import java.lang.management.MemoryMXBean;
+import java.lang.management.MemoryUsage;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+/** Unit tests for {@link JvmMetrics}. */
+class JvmMetricsTests {
+
+  private MetricRegistry registry;
+  private JvmMetrics jvmMetrics;
+  private MemoryMXBean mockMemoryMXBean = mock(MemoryMXBean.class);
+
+  private static final MemoryUsage HEAP_USAGE =
+      new MemoryUsage(/*init*/ 100, /*used*/ 200, /*commited*/ 500, /*max*/ 1000);
+  private static final MemoryUsage NON_HEAP_USAGE =
+      new MemoryUsage(/*init*/ 50, /*used*/ 100, /*commited*/ 250, /*max*/ 500);
+
+  @BeforeEach
+  public void setUp() {
+    MetricRegistryImpl.getDefault().unregisterAllMetrics();
+    registry = MetricRegistryImpl.getDefault();
+
+    when(mockMemoryMXBean.getHeapMemoryUsage()).thenReturn(HEAP_USAGE);
+    when(mockMemoryMXBean.getNonHeapMemoryUsage()).thenReturn(NON_HEAP_USAGE);
+
+    jvmMetrics = new JvmMetrics(mockMemoryMXBean);
+  }
+
+  @Test
+  public void metricsRegistered() {
+    jvmMetrics.register();
+
+    assertThat(registry.getRegisteredMetrics()).hasSize(3);
+
+    for (var metric : registry.getRegisteredMetrics()) {
+      assertThat(metric).isInstanceOf(com.google.monitoring.metrics.VirtualMetric.class);
+    }
+  }
+
+  @Test
+  public void testGetUsedMemory() {
+    jvmMetrics.register();
+    ImmutableMap<ImmutableList<String>, Long> values = jvmMetrics.getUsedMemory();
+
+    assertThat(values)
+        .containsExactly(
+            ImmutableList.of("heap"), 200L,
+            ImmutableList.of("non_heap"), 100L);
+  }
+
+  @Test
+  public void testGetCommittedMemory() {
+    jvmMetrics.register();
+    ImmutableMap<ImmutableList<String>, Long> values = jvmMetrics.getCommittedMemory();
+
+    assertThat(values)
+        .containsExactly(
+            ImmutableList.of("heap"), 500L,
+            ImmutableList.of("non_heap"), 250L);
+  }
+
+  @Test
+  public void testGetMaxMemory() {
+    jvmMetrics.register();
+    ImmutableMap<ImmutableList<String>, Long> values = jvmMetrics.getMaxMemory();
+
+    assertThat(values)
+        .containsExactly(
+            ImmutableList.of("heap"), 1000L,
+            ImmutableList.of("non_heap"), 500L);
+  }
+}