dongjoon-hyun commented on code in PR #44021:
URL: https://github.com/apache/spark/pull/44021#discussion_r1408066447


##########
connector/profiler/README.md:
##########
@@ -0,0 +1,86 @@
+# Spark Code Profiler Plugin
+
+## Build
+
+To build 
+``` 
+  ./build/mvn clean package -P code-profiler
+```
+
+## Executor Code Profiling
+
+The spark profiler module enables code profiling of executors in cluster mode 
based on the the [async 
profiler](https://github.com/async-profiler/async-profiler/blob/master/README.md),
 a low overhead sampling profiler. This allows a Spark application to capture 
CPU and memory profiles for application running on a cluster which can later be 
analyzed for performance issues. The profiler captures [Java Flight Recorder 
(jfr)](https://developers.redhat.com/blog/2020/08/25/get-started-with-jdk-flight-recorder-in-openjdk-8u#)
 files for each executor; these can be read by many tools including Java 
Mission Control and Intellij.
+
+The profiler writes the jfr files to the executor's working directory in the 
executor's local file system and the files can grow to be large so it is 
advisable that the executor machines have adequate storage. The profiler can be 
configured to copy the jfr files to a hdfs location before the executor shuts 
down.
+
+Code profiling is currently only supported for
+
+*   Linux (x64)
+*   Linux (arm 64)
+*   Linux (musl, x64)
+*   MacOS
+
+To get maximum profiling information set the following jvm options for the 
executor -

Review Comment:
   `-` -> `:`



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

Reply via email to