yaooqinn commented on a change in pull request #1302: URL: https://github.com/apache/incubator-kyuubi/pull/1302#discussion_r737371256
########## File path: docs/monitor/logging.md ########## @@ -21,11 +21,224 @@ </div> -# Logging +# Monitoring Kyuubi - Logging System -## Server Logging +Kyuubi uses [Apache Log4j](https://logging.apache.org/log4j/2.x/) for logging. -## Process Logging +In general, there are mainly three components in the Kyuubi architecture that will produce component-oriented logs to help you trace breadcrumbs for SQL workloads against Kyuubi. -## Operation Logging +- Logs of Kyuubi Server +- Logs of Kyuubi Engines +- Operation logs +In addition, a Kyuubi deployment for production usually relies on some other external systems. +For example, both Kyuubi servers and engines will use [Apache Zookeeper](https://zookeeper.apache.org/) for service discovery. +The instructions for external system loggings will not be included in this article. + +## 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. + +### Configuring Server Logging + +#### Basic Configurations + +You can configure it by adding a `log4j.properties` file in the `$KYUUBI_HOME/conf` directory. +One way to start is to make a copy of the existing `log4j.properties.template` located there. + +For example, + +```shell +# cd $KYUUBI_HOME +cp conf/log4j.properties.template conf/log4j.properties Review comment: Nah, it's an example for practicing -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
