CODEWITHSUNDEEP
javaspring-bootdockerheap-dump
Deepak Gopal
Deepak Gopal

Reputation: 183

HeapDumpOnOutOfMemoryError doesn't dump heap when run inside docker container

I am running a Spring Boot service inside a Docker container and the serivce POM.xml file has this plugin

                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <jvmArguments>
                        -Xms1024m
                        -Xmx3096m
                        -XX:+UseConcMarkSweepGC
                        -XX:+HeapDumpOnOutOfMemoryError
                        -XX:HeapDumpPath=logs/heapdump.bin
                        -XX:+PrintGCDetails
                        -Xloggc:logs/data-pipeline-automation-gc.log
                        -XX:NativeMemoryTracking=summary
                        -XX:+CrashOnOutOfMemoryError
                        -XX:ErrorFile=logs/crashDump.log
                    </jvmArguments>
                </configuration>
            </plugin>

I see my service getting an OOM but I don't get the heapdump.bin or the GC logs. This is my configuration in log4j2.xml for springframework logs

            <AppenderRef ref="Console" />
            <AppenderRef ref="RollingFile" />
        </Logger>

So I get the logs created and dumped into /logs folder in the Docker container, but I don't the heapdump.bin file. I am putting it in logs because this is mounted on VM, hence we can access this folder contents from outside access.

Can someone please point out the issue here? I at least need the GC logs to verify the issue.

Upvotes: 1

Views: 4623

Answers (1)

dan1st
dan1st

Reputation: 16338

(JVM) arguments are not part of the JAR.

Eclipse even has a warning indicating this when you try to package an application with arguments to a JAR.

The JVM arguments in the spring-boot-maven-plugin are for running the program using mvn spring-boot:run.

If you want to execute a JAR with JVM arguments, run it by passing those using the command line:

java -XX:+HeapDumpOnOutOfMemoryError -jar yourjar.jar

If you don't want to write those arguments every time you run the program, you could create a wrapper script that just runs the java command with the arguments.

If you really want the jvm arguments to be part of the JAR, you could create another main class (and specify that to be written to the MANIFEST.MF) that just runs itself with the other main class and passes those arguments:

java -XX:+HeapDumpOnOutOfMemoryError -cp yourjar.jar fully.qualified.name.of.Main

However (depending on your needs), the program would need to redirect stdin/stdout, find out the path of the jar, find out the path of the java installation and also pass jvm arguments passed to itself to the program.

Upvotes: 3

Related Questions