wilkinsona
commented
1 year ago Thanks for the suggestion, @cmdjulian. I think this is something that we could support out of the box. In the meantime, you can enable it yourself by adding something like the following to your app:
package com.example.demo;
import java.io.File;
import java.io.IOException;
import java.lang.reflect.Method;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import org.springframework.aot.hint.MemberCategory;
import org.springframework.aot.hint.RuntimeHints;
import org.springframework.aot.hint.RuntimeHintsRegistrar;
import org.springframework.aot.hint.TypeReference;
import org.springframework.boot.actuate.management.HeapDumpWebEndpoint;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.ImportRuntimeHints;
import org.springframework.core.NativeDetector;
import org.springframework.util.ClassUtils;
import org.springframework.util.ReflectionUtils;
import com.example.demo.GraalHeapDumpWebEndpointConfiguration.GraalHeapDumpWebEndpoint.GraalHeapDumper;
import com.example.demo.GraalHeapDumpWebEndpointConfiguration.GraalHeapDumperRuntimeHints;
@Configuration(proxyBeanMethods = false)
@ImportRuntimeHints(GraalHeapDumperRuntimeHints.class)
class GraalHeapDumpWebEndpointConfiguration {
@Bean
HeapDumpWebEndpoint heapDumpWebEndpoint() {
return new GraalHeapDumpWebEndpoint();
}
static class GraalHeapDumpWebEndpoint extends HeapDumpWebEndpoint {
@Override
protected HeapDumper createHeapDumper() throws HeapDumperUnavailableException {
if (NativeDetector.inNativeImage()) {
return new GraalHeapDumper();
}
return super.createHeapDumper();
}
static class GraalHeapDumper implements HeapDumper {
private static final String VM_RUNTIME_CLASS_NAME = "org.graalvm.nativeimage.VMRuntime";
private final Method dumpHeap;
GraalHeapDumper() {
try {
Class<?> vmRuntimeClass = ClassUtils.resolveClassName(GraalHeapDumper.VM_RUNTIME_CLASS_NAME, null);
this.dumpHeap = vmRuntimeClass.getMethod("dumpHeap", String.class, boolean.class);
}
catch (Throwable ex) {
throw new HeapDumperUnavailableException("Cound not find dumpHeap method on VMRuntime", ex);
}
}
@Override
public File dumpHeap(Boolean live) throws IOException {
String date = DateTimeFormatter.ofPattern("yyyy-MM-dd-HH-mm").format(LocalDateTime.now());
File file = File.createTempFile("heap-" + date, ".hprof");
ReflectionUtils.invokeMethod(this.dumpHeap, null, file.getAbsolutePath(), (live != null) ? live : true);
return file;
}
}
}
static class GraalHeapDumperRuntimeHints implements RuntimeHintsRegistrar {
@Override
public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
hints.reflection()
.registerType(TypeReference.of(GraalHeapDumper.VM_RUNTIME_CLASS_NAME),
MemberCategory.INVOKE_PUBLIC_METHODS);
}
}
}
cmdjulian
tse-eche
Spring Boot Actuator is a tremendous help, especially when debugging prod issues.
Especially heap dump and thread profiling are very helpful.
This works very conveniently when running in JVM mode. When running in graalvm native image, this two features don't work.
I stumbled up on https://www.graalvm.org/latest/reference-manual/native-image/guides/create-heap-dump/ this graalvm feature and was wondering if we can't use this to allow heap dumps to work in native image as well by using the in-native-image detector and than run the example code conditionally.