You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[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#18667a0bdbb [SteNicholas] [KYUUBI #1866] Add logging of Flink SQL Engine
Authored-by: SteNicholas <programgeek@163.com>
Signed-off-by: Cheng Pan <chengpan@apache.org>
(cherry picked from commit b8389da)
Signed-off-by: Cheng Pan <chengpan@apache.org>
Copy file name to clipboardExpand all lines: docs/monitor/logging.md
+20Lines changed: 20 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -147,6 +147,26 @@ Different session users have different folders to group all live and historical
147
147
Each engine will have one and only engine log.
148
148
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.
149
149
150
+
## Logs of Flink SQL Engine
151
+
152
+
Flink SQL Engine is one type of Kyuubi Engines and also a typical Flink application.
153
+
Thus, its logs mainly contain the logs of a Flink JobManager and TaskManager.
154
+
Meanwhile, it also includes how all the services of an engine start/stop, how does it response the incoming calls from Kyuubi servers, etc.
155
+
156
+
In general, when an exception occurs, we are able to find more information and clues in the engine's logs.
157
+
158
+
#### Configuring Engine Logging
159
+
160
+
Please refer to Apache Flink online documentation -[Configuring Logging](https://nightlies.apache.org/flink/flink-docs-master/docs/deployment/advanced/logging) for instructions.
161
+
162
+
#### Where to Find the Engine Log
163
+
164
+
The engine logs locate differently based on the deploy mode and the cluster manager.
165
+
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}`.
166
+
Different session users have different folders to group all live and historical engine logs.
167
+
Each engine will have one and only engine log.
168
+
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.
169
+
150
170
## Operation Logs
151
171
152
172
Operation log will show how SQL queries are executed, such as query planning, execution, and statistic reports.
0 commit comments