This is an automated email from the ASF dual-hosted git repository.
chengpan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-kyuubi.git
The following commit(s) were added to refs/heads/master by this push:
new b8389da [KYUUBI #1866][FOLLOWUP] Add logging of Flink SQL Engine
b8389da is described below
commit b8389dae40ec2f813800fc0290146eee7a89b6a2
Author: SteNicholas <[email protected]>
AuthorDate: Sat Mar 12 20:44:29 2022 +0800
[KYUUBI #1866][FOLLOWUP] Add logging of Flink SQL Engine
### _Why are the changes needed?_
Add logging of Flink SQL Engine in `logging.md`.
### _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 #2111 from SteNicholas/KYUUBI-1866.
Closes #1866
7a0bdbb8 [SteNicholas] [KYUUBI #1866] Add logging of Flink SQL Engine
Authored-by: SteNicholas <[email protected]>
Signed-off-by: Cheng Pan <[email protected]>
---
docs/monitor/logging.md | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/docs/monitor/logging.md b/docs/monitor/logging.md
index 9081446..ce4267f 100644
--- a/docs/monitor/logging.md
+++ b/docs/monitor/logging.md
@@ -148,6 +148,26 @@ Different session users have different folders to group
all live and historical
Each engine will have one and only engine log.
When using `cluster` deploy mode, the local engine logs only contain very
little information, the main parts of engine logs are on the remote driver
side, e.g. for YARN cluster, they are in ApplicationMasters' log.
+## Logs of Flink SQL Engine
+
+Flink SQL Engine is one type of Kyuubi Engines and also a typical Flink
application.
+Thus, its logs mainly contain the logs of a Flink JobManager and TaskManager.
+Meanwhile, it also includes how all the services of an engine start/stop, how
does it response the incoming calls from Kyuubi servers, etc.
+
+In general, when an exception occurs, we are able to find more information and
clues in the engine's logs.
+
+#### Configuring Engine Logging
+
+Please refer to Apache Flink online documentation -[Configuring
Logging](https://nightlies.apache.org/flink/flink-docs-master/docs/deployment/advanced/logging)
for instructions.
+
+#### Where to Find the Engine Log
+
+The engine logs locate differently based on the deploy mode and the cluster
manager.
+When using local backend or `client` deploy mode for other cluster managers,
such as YARN, you can find the whole engine log in
`$KYUUBI_WORK_DIR_ROOT/${session username}/kyuubi-flink-sql-engine.log.${num}`.
+Different session users have different folders to group all live and
historical engine logs.
+Each engine will have one and only engine log.
+When using `cluster` deploy mode, the local engine logs only contain very
little information, the main parts of engine logs are on the remote driver
side, e.g. for YARN cluster, they are in ApplicationMasters' log.
+
## Operation Logs
Operation log will show how SQL queries are executed, such as query planning,
execution, and statistic reports.
