Merge pull request #249 from v-thakkar/java-support-page

Add separate page for the java support

Author: brancz

docs/java-support.md

@@ -0,0 +1,9 @@
+# Java Support
+
+In order for Parca Agent to be able to make sense of the just-in-time compiled code by the Java VM, the Java process needs to comply to the [linux kernel perf jit-interface](https://github.com/torvalds/linux/blob/master/tools/perf/Documentation/jit-interface.txt). To do this, currently users need to start their java process with two flags `-XX:+PreserveFramePointer` and `-agentpath:/your/path/to/libperfmap.so` where the `libperfmap.so` agent can be downloaded [here](https://github.com/parca-dev/perf-map-agent/releases/tag/v0.0.1).
+
+Checkout the [demo example](https://github.com/parca-dev/parca-demo/tree/main/java) for more details.
+
+## Coming soon
+
+More integrated support without the need of perf-map agent and frame pointers for JVM runtimes using [async profiler](https://github.com/async-profiler/async-profiler)

docs/parca-agent-language-support.md

@@ -1,4 +1,4 @@
-# Language Support
+# Other languages
 
 Support in Parca Agent for various languages is constantly improving, here are some indications and examples to help you get started. 
 
@@ -19,7 +19,7 @@ All JIT compiled languages with frame pointer, and [Perf map](https://github.com
 * [.NET](https://github.com/parca-dev/parca-demo/tree/main/dotnet)
 * [Deno](https://github.com/parca-dev/parca-demo/tree/main/deno)
 * [Erlang](https://github.com/parca-dev/parca-demo/tree/main/erlang)
-* [Java](https://github.com/parca-dev/parca-demo/tree/main/java)
+* [Java](/docs/java-support)
 * [Julia](https://github.com/parca-dev/parca-demo/tree/main/julia)
 * [Node.js](https://github.com/parca-dev/parca-demo/tree/main/nodejs)
 * [PHP 8 and above](https://github.com/parca-dev/parca-demo/tree/main/php)
@@ -31,10 +31,6 @@ All JIT compiled languages with frame pointer, and [Perf map](https://github.com
 
 _Coming soon_
 
-## Coming Soon
-
-* Extended support for JVM runtimes via [async-profiler](https://github.com/jvm-profiling-tools/async-profiler)
-
 :::info
 
 [Further language support](https://github.com/parca-dev/parca-agent/issues?q=is%3Aissue+is%3Aopen+label%3Afeature%2Flanguage-support) is coming in the upcoming weeks and months.

sidebars.js

@@ -77,7 +77,11 @@ module.exports = {
         "parca-agent",
         "parca-agent-design",
         "parca-agent-labelling",
-        "parca-agent-language-support",
+        {
+          type: "category",
+          label: "Language Support",
+          items: ["java-support", "parca-agent-language-support"],
+        },
         "parca-agent-security",
       ],
     },

wordlist.txt

@@ -1,5 +1,6 @@
 aa
 addr
+agentpath
 ainur
 Akkoyun
 amd
@@ -128,6 +129,7 @@ io
 iterateLong
 iterateShort
 Jaeger
+jit
 JIT
 jitdump
 js
@@ -145,6 +147,7 @@ Ld
 libbpf
 libc
 libelf
+libperfmap
 libpthread
 libz
 LimitNOFILE
@@ -208,6 +211,7 @@ posts
 pprof
 pprof's
 pre
+PreserveFramePointer
 Println
 PrivateDevices
 Priyadarsini