Merge pull request #304 from graalvm/ni-demos-refactoring-3

[GR-60094] Refactor the demo for Create a Heap Dump from a Native Executable guide.

.github/workflows/native-image-create-heap-dumps.yml

@@ -0,0 +1,35 @@
+name: native-image/create-heap-dumps
+on:
+  push:
+    paths:
+      - 'native-image/create-heap-dumps/**'
+      - '.github/workflows/native-image-create-heap-dumps.yml'
+  pull_request:
+    paths:
+      - 'native-image/create-heap-dumps/**'
+      - '.github/workflows/native-image-create-heap-dumps.yml'
+  schedule:
+    - cron: "0 0 1 * *" # run every month
+  workflow_dispatch:
+permissions:
+  contents: read
+jobs:
+  run:
+    name: Run 'native-image/create-heap-dumps'
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    strategy:
+      matrix:
+        java-version: ['21', '24-ea']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: graalvm/setup-graalvm@v1
+        with:
+          java-version: ${{ matrix.java-version }}
+          distribution: 'graalvm'
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          native-image-job-reports: 'true'
+      - name: Run 'native-image/create-heap-dumps'
+        run: |
+          cd native-image/create-heap-dumps
+          ./run.sh

README.md

@@ -84,7 +84,7 @@ cd graalvm-demos
       <td align="left" width="70%">Demonstrates how to build a fully static and a mostly-static native executable.<br><strong>Technologies: </strong> Native Image <br><strong>Reference: </strong><a href="https://www.graalvm.org/latest/reference-manual/native-image/guides/build-static-executables/">Build a Statically Linked or Mostly-Statically Linked Native Executable</a></td>
     </tr>
     <tr>
-      <td align="left" width="30%"><a href="/native-heapdump-examples/">native-heapdump-examples</a><br><a href="https://github.com/graalvm/graalvm-demos/actions/workflows/native-heapdump-examples.yml"><img alt="native-heapdump-examples" src="https://github.com/graalvm/graalvm-demos/actions/workflows/native-heapdump-examples.yml/badge.svg"/></a></td>
+      <td align="left" width="30%"><a href="/native-image/create-heap-dumps/">native-image/create-heap-dumps</a><br><a href="https://github.com/graalvm/graalvm-demos/actions/workflows/native-image-create-heap-dumps.yml"><img alt="native-image/create-heap-dumps" src="https://github.com/graalvm/graalvm-demos/actions/workflows/native-image-create-heap-dumps.yml/badge.svg"/></a></td>
       <td align="left" width="70%">Demonstrates different ways to generate a heap dump from a running native executable.<br><strong>Technologies: </strong> Native Image, VisualVM <br><strong>Reference: </strong><a href="https://www.graalvm.org/latest/reference-manual/native-image/guides/create-heap-dump/">Create a Heap Dump from a Native Executable</a></td>
     </tr>  
     <tr>

native-heapdump-examples/.gitignore → native-image/create-heap-dumps/.gitignore

@@ -1,5 +1,6 @@
 *.class
 *.txt
+helloworld
 svmheapdump
 *.hprof
 svmheapdumpapi

native-image/create-heap-dumps/README.md

@@ -0,0 +1,3 @@
+# Create a Heap Dump from a Native Executable
+
+You can find the steps to run this demo on [the website](https://www.graalvm.org/latest/reference-manual/native-image/guides/create-heap-dump/).

native-image/create-heap-dumps/run.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+set -ex
+
+# Dump the Initial Heap of a Native Executable
+javac HelloWorld.java 
+native-image -Ob HelloWorld --enable-monitoring=heapdump
+./helloworld -XX:+DumpHeapAndExit
+
+# Create a Heap Dump with SIGUSR1 (Linux/macOS only)
+javac SVMHeapDump.java
+native-image -Ob SVMHeapDump --enable-monitoring=heapdump
+./svmheapdump
+
+# Create a Heap Dump from within a Native Executable
+javac SVMHeapDumpAPI.java
+native-image -Ob SVMHeapDumpAPI
+./svmheapdumpapi --heapdump