Skip to content

Commit

Permalink
[KYUUBI #6673] [DOC] Fix typos in logging.md
Browse files Browse the repository at this point in the history
# 🔍 Description
## Issue References 🔗

This pull request fixes typos in the logging.md documentation file.

## Describe Your Solution 🔧

Fixed typos while reading through the page.

## Types of changes 🔖

- [x] Bugfix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Test Plan 🧪

Not needed.

---

# Checklist 📝

- [x] This patch was not authored or co-authored using [Generative Tooling](https://www.apache.org/legal/generative-tooling.html)

**Be nice. Be informative.**

Closes #6673 from MLNW/patch-1.

Closes #6673

02ea731 [Bowen Liang] Update docs/monitor/logging.md
659580e [Lucas Resch] Fix typos in logging.md

Lead-authored-by: Lucas Resch <[email protected]>
Co-authored-by: Bowen Liang <[email protected]>
Signed-off-by: Bowen Liang <[email protected]>
  • Loading branch information
MLNW and bowenliang123 committed Sep 5, 2024
1 parent 57ab60a commit d7219fc
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions docs/monitor/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The instructions for external system loggings will not be included in this artic

## Logs of Kyuubi Server

Logs of Kyuubi Server show us the activities of the server instance including how start/stop, how does it response client requests, etc.
Logs of Kyuubi Server show us the activities of the server instance including how it starts and stops, how it responds to client requests, etc.

### Configuring Server Logging

Expand All @@ -49,7 +49,7 @@ cp conf/log4j2.xml.template conf/log4j2.xml

With or without the above step, by default the server logging will redirect the logs to a file named `kyuubi-${env:USER}-org.apache.kyuubi.server.KyuubiServer-${env:HOSTNAME}.out` under the directory of `$KYUUBI_HOME/logs`.

For example, you can easily find where the server log goes when staring a Kyuubi server from the console output.
For example, you can easily find where the server log goes when starting a Kyuubi server from the console output.

```shell
$ export SPARK_HOME=/Users/kentyao/Downloads/spark/spark-3.2.0-bin-hadoop3.2
Expand Down Expand Up @@ -87,9 +87,9 @@ Welcome to

You may also notice that there is an environment variable called `KYUUBI_LOG_DIR` in the above example.

`KYUUBI_LOG_DIR` determines which folder we want to put our server log files.
`KYUUBI_LOG_DIR` determines into which folder we want to put our server log files.

For example, the below command will locate the log files to `/Users/kentyao/tmp`.
For example, the below command will write the log files to `/Users/kentyao/tmp`.

```shell
$ mkdir /Users/kentyao/tmp
Expand All @@ -102,7 +102,7 @@ Starting org.apache.kyuubi.server.KyuubiServer, logging to /Users/kentyao/tmp/ky

#### KYUUBI_MAX_LOG_FILES

`KYUUBI_MAX_LOG_FILES` controls how many log files will be remained after a Kyuubi server reboots.
`KYUUBI_MAX_LOG_FILES` controls how many log files will remain after a Kyuubi server reboots.

#### Custom Log4j2 Settings

Expand Down Expand Up @@ -134,20 +134,20 @@ Then everything goes to `log/dummy.log`.

Spark SQL Engine is one type of Kyuubi Engines and also a typical Spark application.
Thus, its logs mainly contain the logs of a Spark Driver.
Meanwhile, it also includes how all the services of an engine start/stop, how does it response the incoming calls from Kyuubi servers, etc.
Meanwhile, it also includes how all the services of an engine start/stop, how it responds to 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 Spark online documentation -[Configuring Logging](https://spark.apache.org/docs/latest/configuration.html#configuring-logging) for instructions.
Please refer to Apache Spark online documentation [Configuring Logging](https://spark.apache.org/docs/latest/configuration.html#configuring-logging) for instructions.

#### Where to Find the Engine Log

The engine logs locate differently based on the deploy mode and the cluster manager.
The engine logs are located 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-spark-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.
Each engine will have exactly one 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
Expand All @@ -160,23 +160,23 @@ In general, when an exception occurs, we are able to find more information and c

#### Configuring Engine Logging

Please refer to Apache Flink online documentation -[Configuring Logging](https://nightlies.apache.org/flink/flink-docs-stable/docs/deployment/advanced/logging) for instructions.
Please refer to Apache Flink online documentation [Configuring Logging](https://nightlies.apache.org/flink/flink-docs-stable/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.
The engine logs are located 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.
Each engine will have exactly one 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.

Operation logs can reveal directly to end-users how their queries are being executed on the server/engine-side, including some process-oriented information, and why their queries are slow or in error.
Operation logs can reveal directly to end-users how their queries are being executed on the server/engine-side, including some process-oriented information, and why their queries are slow or fail.

For example, when you, as an end-user, use `kyuubi-beeline` to connect a Kyuubi server and execute query like below.
For example, when you, as an end-user, use `kyuubi-beeline` to connect a Kyuubi server and execute query like below:

```shell
kyuubi-beeline -u 'jdbc:kyuubi://10.242.189.214:2181/;serviceDiscoveryMode=zooKeeper;zooKeeperNamespace=kyuubi' -n kent -e 'select * from src;'
Expand Down

0 comments on commit d7219fc

Please sign in to comment.