Add GarbageCollectorInfo to ProcessInfo

Author: jonatan-ivanov

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/info/ProcessInfo.java

@@ -16,11 +16,13 @@
 
 package org.springframework.boot.info;
 
+import java.lang.management.GarbageCollectorMXBean;
 import java.lang.management.ManagementFactory;
 import java.lang.management.MemoryMXBean;
 import java.lang.management.MemoryUsage;
 import java.lang.management.PlatformManagedObject;
 import java.lang.reflect.Method;
+import java.util.List;
 
 import org.springframework.util.ClassUtils;
 
@@ -40,6 +42,9 @@ public class ProcessInfo {
 
 	private static final Runtime runtime = Runtime.getRuntime();
 
+	private static final List<GarbageCollectorMXBean> garbageCollectorMXBeans = ManagementFactory
+		.getGarbageCollectorMXBeans();
+
 	private final long pid;
 
 	private final long parentPid;
@@ -117,6 +122,19 @@ private <T> T invokeMethod(Class<?> mxbeanClass, Object mxbean, String name) thr
 		return (T) method.invoke(mxbean);
 	}
 
+	/**
+	 * Garbage Collector information for the process. This list provides details about the
+	 * currently used GC algorithms selected by the user or JVM ergonomics. It might not
+	 * be trivial to know the used GC algorithms since that usually depends on the
+	 * {@link Runtime#availableProcessors()} (see: {@link ProcessInfo#getCpus()}) and the
+	 * available memory (see: {@link ProcessInfo#getMemory()}).
+	 * @return {@link List} of {@link GarbageCollectorInfo}.
+	 * @since 3.5.0
+	 */
+	public List<GarbageCollectorInfo> getGarbageCollectors() {
+		return garbageCollectorMXBeans.stream().map(GarbageCollectorInfo::new).toList();
+	}
+
 	public long getPid() {
 		return this.pid;
 	}
@@ -223,4 +241,30 @@ public long getMax() {
 
 	}
 
+	/**
+	 * Garbage Collector information.
+	 *
+	 * @since 3.5.0
+	 */
+	public static class GarbageCollectorInfo {
+
+		private final String name;
+
+		private final long collectionCount;
+
+		GarbageCollectorInfo(GarbageCollectorMXBean garbageCollectorMXBean) {
+			this.name = garbageCollectorMXBean.getName();
+			this.collectionCount = garbageCollectorMXBean.getCollectionCount();
+		}
+
+		public String getName() {
+			return this.name;
+		}
+
+		public long getCollectionCount() {
+			return this.collectionCount;
+		}
+
+	}
+
 }

spring-boot-project/spring-boot/src/test/java/org/springframework/boot/info/ProcessInfoTests.java

@@ -16,10 +16,13 @@
 
 package org.springframework.boot.info;
 
+import java.util.List;
+
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.condition.EnabledForJreRange;
 import org.junit.jupiter.api.condition.JRE;
 
+import org.springframework.boot.info.ProcessInfo.GarbageCollectorInfo;
 import org.springframework.boot.info.ProcessInfo.MemoryInfo.MemoryUsageInfo;
 import org.springframework.boot.info.ProcessInfo.VirtualThreadsInfo;
 
@@ -77,4 +80,15 @@ void virtualThreadsInfoIfNotAvailable() {
 		assertThat(processInfo.getVirtualThreads()).isNull();
 	}
 
+	@Test
+	void garbageCollectorsInfoIsAvailable() {
+		ProcessInfo processInfo = new ProcessInfo();
+		List<GarbageCollectorInfo> garbageCollectorsInfo = processInfo.getGarbageCollectors();
+		assertThat(garbageCollectorsInfo).isNotEmpty();
+		assertThat(garbageCollectorsInfo).allSatisfy((garbageCollectorInfo) -> {
+			assertThat(garbageCollectorInfo.getName()).isNotEmpty();
+			assertThat(garbageCollectorInfo.getCollectionCount()).isNotNegative();
+		});
+	}
+
 }