### _Why are the changes needed?_ Add Docs for kyuubi tools spark-block-cleaner. * Explain the parameters * Introduction to basic startup * Give an example ### _How was this patch tested?_ - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible - [ ] Add screenshots for manual tests if appropriate - [X] [Run test](https://kyuubi.readthedocs.io/en/latest/tools/testing.html#running-tests) locally before make a pull request Closes #815 from zwangsheng/doc/spark_block_cleaner. Closes #815 1ec6795f [Binjie Yang] delete todo bbf4d6e2 [Binjie Yang] make it common 9cf3e159 [Binjie Yang] format 0803995a [Binjie Yang] straighten out the article f834b382 [Binjie Yang] refactor 25be318f [Binjie Yang] fix 7304e595 [Binjie Yang] docs for spark-block-cleaner Authored-by: Binjie Yang <2213335496@qq.com> Signed-off-by: ulysses-you <ulyssesyou18@gmail.com>
41 lines
922 B
Markdown
41 lines
922 B
Markdown
<div align=center>
|
|
|
|

|
|
|
|
</div>
|
|
|
|
# Debugging Kyuubi
|
|
|
|
You can use the [Java Debug Wire Protocol](https://docs.oracle.com/javase/8/docs/technotes/guides/jpda/conninv.html#Plugin) to debug Kyuubi
|
|
with your favorite IDE tool, e.g. Intellij IDEA.
|
|
|
|
## Debugging Server
|
|
|
|
We can configure the JDWP agent in `KYUUBI_JAVA_OPTS` for debugging.
|
|
|
|
|
|
For example,
|
|
```bash
|
|
KYUUBI_JAVA_OPTS=-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005 \
|
|
bin/kyuubi start
|
|
```
|
|
|
|
In the IDE, you set the corresponding parameters(host&port) in debug configurations, for example,
|
|
<div align=center>
|
|
|
|

|
|
|
|
</div>
|
|
|
|
## Debugging Apps
|
|
|
|
- Spark Driver
|
|
|
|
```bash
|
|
spark.driver.extraJavaOptions -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005
|
|
```
|
|
|
|
- Spark Executor
|
|
```bash
|
|
spark.executor.extraJavaOptions -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005
|
|
``` |