diff --git a/bin/load-kyuubi-env.sh b/bin/load-kyuubi-env.sh index caa7730fc..9f45bad3f 100755 --- a/bin/load-kyuubi-env.sh +++ b/bin/load-kyuubi-env.sh @@ -24,11 +24,11 @@ export KYUUBI_CONF_DIR="${KYUUBI_CONF_DIR:-"${KYUUBI_HOME}"/conf}" KYUUBI_ENV_SH="${KYUUBI_CONF_DIR}"/kyuubi-env.sh if [[ -f ${KYUUBI_ENV_SH} ]]; then set -a - echo "Using kyuubi.sh environment file ${KYUUBI_ENV_SH} to initialize..." + echo "Using kyuubi environment file ${KYUUBI_ENV_SH} to initialize..." . "${KYUUBI_ENV_SH}" set +a else - echo "Warn: Not find kyuubi.sh environment file ${KYUUBI_ENV_SH}, using default ones..." + echo "Warn: Not find kyuubi environment file ${KYUUBI_ENV_SH}, using default ones..." fi export KYUUBI_LOG_DIR="${KYUUBI_LOG_DIR:-"${KYUUBI_HOME}/logs"}" diff --git a/docs/deployment/settings.md b/docs/deployment/settings.md index 6a13d8f56..7c421082a 100644 --- a/docs/deployment/settings.md +++ b/docs/deployment/settings.md @@ -115,13 +115,6 @@ kyuubi\.delegation
\.token\.gc\.interval|
PT168H
|
unused yet
|
1.0.0
kyuubi\.delegation
\.token\.renew\.interval|
PT168H
|
unused yet
|
1.0.0
-### Engine - -Key | Default | Meaning | Since ---- | --- | --- | --- -kyuubi\.engine\.check
\.interval|
PT10M
|
The check interval for engine timeout
|
1.0.0
-kyuubi\.engine\.idle
\.timeout|
PT30M
|
engine timeout, it will be closed when it's not accessed for this duration
|
1.0.0
- ### Frontend Key | Default | Meaning | Since @@ -169,6 +162,8 @@ kyuubi\.operation\.idle
\.timeout|
PT5M
|
The check interval for session timeout.
|
1.0.0
+kyuubi\.session\.engine
\.check\.interval|
PT10M
|
The check interval for engine timeout
|
1.0.0
+kyuubi\.session\.engine
\.idle\.timeout|
PT30M
|
engine timeout, the engine will self-terminate when it's not accessed for this duration
|
1.0.0
kyuubi\.session\.engine
\.initialize\.timeout|
PT1M
|
Timeout for starting the background engine, e.g. SparkSQLEngine.
|
1.0.0
kyuubi\.session\.engine
\.login\.timeout|
PT15S
|
The timeout(ms) of creating the connection to remote sql query engine
|
1.0.0
kyuubi\.session\.engine
\.spark\.main\.resource|
<undefined>
|
The package used to create Spark SQL engine remote application. If it is undefined, Kyuubi will use the default
|
1.0.0
diff --git a/docs/quick_start/quick_start.md b/docs/quick_start/quick_start.md index a8a19eca0..a044a66c7 100644 --- a/docs/quick_start/quick_start.md +++ b/docs/quick_start/quick_start.md @@ -43,7 +43,7 @@ kyuubi-1.0.0-SNAPSHOT-bin-spark-3.0.1 ├── LICENSE ├── RELEASE ├── bin -│   └── kyuubi.sh +│   └── kyuubi ├── conf │   ├── kyuubi-defaults.conf │   ├── kyuubi-env.sh @@ -61,7 +61,7 @@ From top to bottom are: - LICENSE: the [APACHE LICENSE, VERSION 2.0](https://www.apache.org/licenses/LICENSE-2.0) we claim to obey. - RELEASE: the build information of this package -- bin: the entry of the Kyuubi server w/ `kyuubi.sh` as the startup script. +- bin: the entry of the Kyuubi server w/ `kyuubi` as the startup script. - conf: all the defaults used by Kyuubi Server itself or creating session with Spark applications. - externals - engines: contains all kinds of SQL engines that we support, e.g. Apache Spark, Apache Flink(coming soon). @@ -105,7 +105,7 @@ The `JAVA_HOME` in `$KYUUBI_HOME/conf/kyuubi-env.sh` will take precedence of oth ```bash -bin/kyuubi.sh start +bin/kyuubi start ``` During the server starts, it will print all essential environment variables on the screen, you may check whether they are expected. diff --git a/docs/tools/building.md b/docs/tools/building.md index d6c4babb4..78894387f 100644 --- a/docs/tools/building.md +++ b/docs/tools/building.md @@ -19,7 +19,7 @@ This results in the creation of all sub-modules of Kyuubi project w/o running an If you want to test it manually, you can start Kyuubi directly from the Kyuubi project root by running ```bash -bin/kyuubi.sh start +bin/kyuubi start ``` ## Building Submodules Individually diff --git a/docs/tools/debugging.md b/docs/tools/debugging.md index 7a243ac1e..5fef551bb 100644 --- a/docs/tools/debugging.md +++ b/docs/tools/debugging.md @@ -15,7 +15,7 @@ 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.sh start +bin/kyuubi start ``` In the IDE, you set the corresponding parameters(host&port) in debug configurations, for example, diff --git a/kyuubi-common/src/main/scala/org/apache/kyuubi/config/KyuubiConf.scala b/kyuubi-common/src/main/scala/org/apache/kyuubi/config/KyuubiConf.scala index d1072e3f6..930d3fdb0 100644 --- a/kyuubi-common/src/main/scala/org/apache/kyuubi/config/KyuubiConf.scala +++ b/kyuubi-common/src/main/scala/org/apache/kyuubi/config/KyuubiConf.scala @@ -365,15 +365,15 @@ object KyuubiConf { .checkValue(_ > Duration.ofSeconds(3).toMillis, "Minimum 3 seconds") .createWithDefault(Duration.ofHours(6).toMillis) - val ENGINE_CHECK_INTERVAL: ConfigEntry[Long] = buildConf("engine.check.interval") + val ENGINE_CHECK_INTERVAL: ConfigEntry[Long] = buildConf("session.engine.check.interval") .doc("The check interval for engine timeout") .version("1.0.0") .timeConf .checkValue(_ > Duration.ofSeconds(3).toMillis, "Minimum 3 seconds") .createWithDefault(Duration.ofMinutes(10).toMillis) - val ENGINE_IDLE_TIMEOUT: ConfigEntry[Long] = buildConf("engine.idle.timeout") - .doc("engine timeout, it will be closed when it's not accessed for this duration") + val ENGINE_IDLE_TIMEOUT: ConfigEntry[Long] = buildConf("session.engine.idle.timeout") + .doc("engine timeout, the engine will self-terminate when it's not accessed for this duration") .version("1.0.0") .timeConf .createWithDefault(Duration.ofMinutes(30L).toMillis) diff --git a/kyuubi-main/src/main/scala/org/apache/kyuubi/session/KyuubiSessionImpl.scala b/kyuubi-main/src/main/scala/org/apache/kyuubi/session/KyuubiSessionImpl.scala index e6887ced4..fabd60992 100644 --- a/kyuubi-main/src/main/scala/org/apache/kyuubi/session/KyuubiSessionImpl.scala +++ b/kyuubi-main/src/main/scala/org/apache/kyuubi/session/KyuubiSessionImpl.scala @@ -99,7 +99,8 @@ class KyuubiSessionImpl( } if (started + timeout <= System.currentTimeMillis()) { process.destroyForcibly() - throw KyuubiSQLException(s"Timed out($timeout ms) to launched Spark with $builder") + throw KyuubiSQLException(s"Timed out($timeout ms) to launched Spark with $builder", + builder.getError) } sh = getServerHost }