{"id":14748,"date":"2023-08-15T12:53:13","date_gmt":"2023-08-15T07:23:13","guid":{"rendered":"https:\/\/opstree.com\/blog\/\/?p=14748"},"modified":"2026-03-05T17:22:13","modified_gmt":"2026-03-05T11:52:13","slug":"how-to-get-java-heap-dump-from-kubernetes-container-into-a-local-machine","status":"publish","type":"post","link":"https:\/\/opstree.com\/blog\/2023\/08\/15\/how-to-get-java-heap-dump-from-kubernetes-container-into-a-local-machine\/","title":{"rendered":"How to get Java heap dump from Kubernetes container into a local machine?"},"content":{"rendered":"\r\n
\r\n\r\n\r\n

What is A Java heap dump?<\/strong><\/p>\r\n

Imagine you are running multiple Java applications within containers in a Kubernetes environment<\/strong>. Each container manages its own memory, but when something seems to be wrong, a Java heap dump becomes a useful tool for diagnosing the problem.This can help detect problems such as memory leaks or abnormally high memory consumption.<\/p>\r\n

Recently, one of our Java application containers in Kubernetes started running out of memory intermittently. Noticing this, our development team immediately sprung into action and analyzed the suspected memory leak in the application.<\/p>\r\n

The main purpose of this article is to show you how to quickly get a heap dump at these critical moments. I will walk you through the manual steps needed to reclaim JVM heap memory when you need it the most.<\/p>\r\n\r\n\r\n\r\n\r\n\r\n

Let’s take a quick look at the prerequisites to accomplish this task.<\/strong><\/h2>\r\n\r\n\r\n\r\n
    \r\n
  1. You have appropriate permission to exec into the k8s<\/a> pod. It means you have to kubectl configured a respected environment.<\/li>\r\n\r\n\r\n\r\n
  2. The pod should have Jmap or Jcmd installed<\/li>\r\n<\/ol>\r\n

    [ Are you looking DevSecOps Managed Services<\/a>]<\/strong><\/p>\r\n\r\n\r\n\r\n

    Let\u2019s do the following step to capture JVM dump and copy it into the local machine<\/strong><\/h2>\r\n\r\n\r\n\r\n

    Step-by-Step Guide<\/p>\r\n\r\n\r\n\r\n

    Step 1: Exec into the Container<\/strong><\/h3>\r\n\r\n\r\n\r\n

    First, you need to execute a command inside the Kubernetes pod where your Java application is running. Use the following command:
    kubectl exec -it -n [namespace] [pod] \/bin\/bash<\/code><\/p>\r\n\r\n\r\n\r\n

    Replace [namespace] with the appropriate namespace and [pod] with the name of the pod containing your Java application.<\/p>\r\n\r\n\r\n\r\n

    Step 2: Generate the Java Heap Dump<\/strong><\/h3>\r\n\r\n\r\n\r\n

    After moving to the container, you can generate a Java heap dump using the jmap command. This will save the heap dump to a specified file location. The structure of this command is as follows:<\/p>\r\n\r\n\r\n\r\n

    jmap -dump:[live],format=b,file=[file_path] [PID]<\/code>

    [live]: <\/strong>This option indicates that the heap dump will be captured from a live running JVM.
    format=b:<\/strong> Specifies the format of the dump file, which is binary.
    file=[file_path]:<\/strong> The path where the heap dump file will be saved inside the container.
    [PID]: <\/strong>The Process ID of the Java application. This PID can be found in the Kubernetes pod where the application is running.<\/p>\r\n\r\n\r\n\r\n

    Example:<\/strong>
    jmap -dump:[live],format=b,file=\/home\/nonrootuser\/dump.bin 001<\/code><\/p>\r\n\r\n\r\n\r\n

    Step 3: Copy the Dump File to Local Machine<\/strong><\/h3>\r\n\r\n\r\n\r\n

    After creating the heap dump, the next step is to transfer it from the Kubernetes pod to your local machine for in-depth analysis. You can get it using the following kubectl cp command:<\/p>\r\n\r\n\r\n\r\n

    kubectl cp -n [namespace] [pod]:[absolute path +dump] [destination path]<\/code>

    [namespace]: <\/strong>Replace with the appropriate namespace.
    [pod]: <\/strong>The name of the pod where the Java application is running.
    [source_file_path]: <\/strong>The absolute path to the heap dump file inside the pod.
    [destination_file_path]:<\/strong> The local path on your machine where the heap dump file will be copied.<\/p>\r\n\r\n\r\n\r\n

    Example:<\/strong>
    kubectl cp -n dump-dev dump-dev-59b8549f54-jzltb:\/home\/nonrootuser\/dump.bin dump.bin<\/code><\/p>\r\n\r\n\r\n\r\n

    Even in a sophisticated Kubernetes container environment, using Java heap dumps can be a powerful strategy for troubleshooting memory issues and ensuring that your Java applications work seamlessly.In short, Java heap dumps are an essential tool for identifying and resolving memory-related challenges in Java applications. As a trusted DevOps service provider<\/strong><\/a>, we help enterprises implement such best practices to achieve greater reliability and performance in their cloud-native ecosystem.<\/p>\r\n\r\n\r\n\r\n

    Conclusion<\/h2>\r\n\r\n\r\n\r\n

    Thanks for keeping up with me till the end of the blog. If you liked the blog please share it amongst your community and do share your views. If you have any questions, let us know through comments ! As a trusted provider of cloud engineering services<\/strong><\/a>, we help organizations simplify Kubernetes adoption, optimize containerized workloads, and build flexible, scalable cloud-native platforms<\/strong><\/a>.<\/p>\r\n\r\n\r\n\r\n\r\n\r\n