69d625a1be
### _Why are the changes needed?_ - to consolidate styles in markdown files from manual written or auto-generated - apply markdown formatting rules with flexmark from [spotless-maven-plugin](https://github.com/diffplug/spotless/tree/main/plugin-maven#markdown) to *.md files in `/docs` - use `flexmark` to format markdown generation in `TestUtils` of common module used by `AllKyuubiConfiguration` and `KyuubiDefinedFunctionSuite`, as the same way in `FlexmarkFormatterFunc ` of `spotless-maven-plugin` using with `COMMONMARK` as `FORMATTER_EMULATION_PROFILE` (https://github.com/diffplug/spotless/blob/maven/2.30.0/lib/src/flexmark/java/com/diffplug/spotless/glue/markdown/FlexmarkFormatterFunc.java) - using `flexmark` of` 0.62.2`, as the last version requiring Java 8+ (checked from pom file and bytecode version) ``` <markdown> <includes> <include>docs/**/*.md</include> </includes> <flexmark></flexmark> </markdown> ``` - Changes applied to markdown doc files, - no style change or breakings in built docs by `make html` - removal all the first blank in licences and comments to conform markdown style rules - tables regenerated by flexmark following as in [GitHub Flavored Markdown](https://help.github.com/articles/organizing-information-with-tables/) (https://github.com/vsch/flexmark-java/wiki/Extensions#tables) ### _How was this patch tested?_ - [x] regenerate docs using `make html` successfully and check all the markdown pages available - [x] regenerate `settings.md` and `functions.md` by `AllKyuubiConfiguration` and `KyuubiDefinedFunctionSuite`, and pass the checks by both themselves and spotless check via `dev/reformat` - [x] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request Closes #4200 from bowenliang123/markdown-formatting. Closes #4200 1eeafce4 [liangbowen] revert minor changes in AllKyuubiConfiguration 4f892857 [liangbowen] use flexmark in markdown doc generation 8c978abd [liangbowen] changes on markdown files a9190556 [liangbowen] apply markdown formatting rules with `spotless-maven-plugin` to markdown files with in `/docs` Authored-by: liangbowen <liangbowen@gf.com.cn> Signed-off-by: liangbowen <liangbowen@gf.com.cn>
112 lines
2.7 KiB
Markdown
112 lines
2.7 KiB
Markdown
<!--
|
|
- Licensed to the Apache Software Foundation (ASF) under one or more
|
|
- contributor license agreements. See the NOTICE file distributed with
|
|
- this work for additional information regarding copyright ownership.
|
|
- The ASF licenses this file to You under the Apache License, Version 2.0
|
|
- (the "License"); you may not use this file except in compliance with
|
|
- the License. You may obtain a copy of the License at
|
|
-
|
|
- http://www.apache.org/licenses/LICENSE-2.0
|
|
-
|
|
- Unless required by applicable law or agreed to in writing, software
|
|
- distributed under the License is distributed on an "AS IS" BASIS,
|
|
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
- See the License for the specific language governing permissions and
|
|
- limitations under the License.
|
|
-->
|
|
|
|
# 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 Engine
|
|
|
|
We can configure the Kyuubi properties to enable debugging engine.
|
|
|
|
### Flink Engine
|
|
|
|
```bash
|
|
kyuubi.engine.flink.java.options -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005
|
|
```
|
|
|
|
### Trino Engine
|
|
|
|
```bash
|
|
kyuubi.engine.trino.java.options -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005
|
|
```
|
|
|
|
### Hive Engine
|
|
|
|
```bash
|
|
kyuubi.engine.hive.java.options -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005
|
|
```
|
|
|
|
## Debugging Apps
|
|
|
|
### Spark Engine
|
|
|
|
- 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
|
|
```
|
|
|
|
### Flink Engine
|
|
|
|
- Flink Processes
|
|
|
|
```bash
|
|
env.java.opts -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005
|
|
```
|
|
|
|
- Flink JobManager
|
|
|
|
```bash
|
|
env.java.opts.jobmanager -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005
|
|
```
|
|
|
|
- Flink TaskManager
|
|
|
|
```bash
|
|
env.java.opts.taskmanager -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005
|
|
```
|
|
|
|
- Flink HistoryServer
|
|
|
|
```bash
|
|
env.java.opts.historyserver -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005
|
|
```
|
|
|
|
- Flink Client
|
|
|
|
```bash
|
|
env.java.opts.client -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005
|
|
```
|
|
|