### _Why are the changes needed?_
Add debugging instructions for Flink engine.
### _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.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request
Closes #2098 from SteNicholas/KYUUBI-2089.
Closes #2089
08189b85 [SteNicholas] [KYUUBI #2089] Add debugging instructions for flink engine
Authored-by: SteNicholas <programgeek@163.com>
Signed-off-by: Kent Yao <yao@apache.org>
(cherry picked from commit 2486c5dff3)
Signed-off-by: Kent Yao <yao@apache.org>
2.3 KiB
2.3 KiB
Debugging Kyuubi
You can use the Java Debug Wire Protocol 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,
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,
Debugging Apps
Spark Engine
- Spark Driver
spark.driver.extraJavaOptions -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005
- Spark Executor
spark.executor.extraJavaOptions -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005
Flink Engine
- Flink Processes
env.java.opts -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005
- Flink JobManager
env.java.opts.jobmanager -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005
- Flink TaskManager
env.java.opts.taskmanager -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005
- Flink HistoryServer
env.java.opts.historyserver -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005
- Flink Client
env.java.opts.client -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005

