Skip to content

Commit

Permalink
[KYUUBI #6058] Make Jetty server stop timeout configurable
Browse files Browse the repository at this point in the history 
# 🔍 Description
## Issue References 🔗

This pull request aims to make the Jetty server stop timeout configurable.

The RESTful frontend protocol has been enabled by default since 1.8.0, while a side-effect is observed, the process shutdown is always blocked by the Jetty server until reaches the default 30s timeout.

## Describe Your Solution 🔧

Two configurations are introduced in this PR
```
kyuubi.frontend.trino.jetty.stopTimeout=5s
kyuubi.frontend.rest.jetty.stopTimeout=5s
```
while the 5s is chosen as the default value according to https://git.eclipse.org/c/jetty/org.eclipse.jetty.project.git/tree/jetty-server/src/main/config/etc/jetty.xml?h=jetty-9.3.x#n124

## Types of changes 🔖

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

## Test Plan 🧪

1. perform `bin/kyuubi run`
2. press `ctrl + c` to shutdown the Kyuubi process

#### Behavior Without This Pull Request ⚰️

takes ~30s to complete the shutdown progress.

#### Behavior With This Pull Request 🎉

takes ~5s to complete the shutdown progress.

---

# 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 #6058 from pan3793/jetty-timeout.

Closes #6058

47d15f9 [Cheng Pan] fix
cbac2b1 [Cheng Pan] Make Jetty server stop timeout configurable

Authored-by: Cheng Pan <[email protected]>
Signed-off-by: Cheng Pan <[email protected]>
  • Loading branch information
@pan3793
pan3793 committed Feb 16, 2024
1 parent 81d1a1d commit 4390cc6
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 4 deletions.
2 changes: 2 additions & 0 deletions docs/configuration/settings.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,7 @@ You can configure the Kyuubi properties in `$KYUUBI_HOME/conf/kyuubi-defaults.co
| kyuubi.frontend.proxy.http.client.ip.header | X-Real-IP | The HTTP header to record the real client IP address. If your server is behind a load balancer or other proxy, the server will see this load balancer or proxy IP address as the client IP address, to get around this common issue, most load balancers or proxies offer the ability to record the real remote IP address in an HTTP header that will be added to the request for other devices to use. Note that, because the header value can be specified to any IP address, so it will not be used for authentication. | string | 1.6.0 |
| kyuubi.frontend.rest.bind.host | &lt;undefined&gt; | Hostname or IP of the machine on which to run the REST frontend service. | string | 1.4.0 |
| kyuubi.frontend.rest.bind.port | 10099 | Port of the machine on which to run the REST frontend service. | int | 1.4.0 |
| kyuubi.frontend.rest.jetty.stopTimeout | PT5S | Stop timeout for Jetty server used by the RESTful frontend service. | duration | 1.8.1 |
| kyuubi.frontend.rest.max.worker.threads | 999 | Maximum number of threads in the frontend worker thread pool for the rest frontend service | int | 1.6.2 |
| kyuubi.frontend.ssl.keystore.algorithm | &lt;undefined&gt; | SSL certificate keystore algorithm. | string | 1.7.0 |
| kyuubi.frontend.ssl.keystore.password | &lt;undefined&gt; | SSL certificate keystore password. | string | 1.7.0 |
Expand Down Expand Up @@ -284,6 +285,7 @@ You can configure the Kyuubi properties in `$KYUUBI_HOME/conf/kyuubi-defaults.co
| kyuubi.frontend.thrift.worker.keepalive.time | PT1M | Keep-alive time (in milliseconds) for an idle worker thread | duration | 1.4.0 |
| kyuubi.frontend.trino.bind.host | &lt;undefined&gt; | Hostname or IP of the machine on which to run the TRINO frontend service. | string | 1.7.0 |
| kyuubi.frontend.trino.bind.port | 10999 | Port of the machine on which to run the TRINO frontend service. | int | 1.7.0 |
| kyuubi.frontend.trino.jetty.stopTimeout | PT5S | Stop timeout for Jetty server used by the Trino frontend service. | duration | 1.8.1 |
| kyuubi.frontend.trino.max.worker.threads | 999 | Maximum number of threads in the frontend worker thread pool for the Trino frontend service | int | 1.7.0 |
| kyuubi.frontend.worker.keepalive.time | PT1M | (deprecated) Keep-alive time (in milliseconds) for an idle worker thread | duration | 1.0.0 |

Expand Down
14 changes: 14 additions & 0 deletions kyuubi-common/src/main/scala/org/apache/kyuubi/config/KyuubiConf.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -571,6 +571,13 @@ object KyuubiConf {
.version("1.6.2")
.fallbackConf(FRONTEND_MAX_WORKER_THREADS)

val FRONTEND_REST_JETTY_STOP_TIMEOUT: ConfigEntry[Long] =
buildConf("kyuubi.frontend.rest.jetty.stopTimeout")
.doc("Stop timeout for Jetty server used by the RESTful frontend service.")
.version("1.8.1")
.timeConf
.createWithDefaultString("PT5S")

val FRONTEND_WORKER_KEEPALIVE_TIME: ConfigEntry[Long] =
buildConf("kyuubi.frontend.worker.keepalive.time")
.doc("(deprecated) Keep-alive time (in milliseconds) for an idle worker thread")
Expand Down Expand Up @@ -1124,6 +1131,13 @@ object KyuubiConf {
.version("1.7.0")
.fallbackConf(FRONTEND_MAX_WORKER_THREADS)

val FRONTEND_TRINO_JETTY_STOP_TIMEOUT: ConfigEntry[Long] =
buildConf("kyuubi.frontend.trino.jetty.stopTimeout")
.doc("Stop timeout for Jetty server used by the Trino frontend service.")
.version("1.8.1")
.timeConf
.createWithDefaultString("PT5S")

val KUBERNETES_CONTEXT: OptionalConfigEntry[String] =
buildConf("kyuubi.kubernetes.context")
.doc("The desired context from your kubernetes config file used to configure the K8s " +
Expand Down
3 changes: 2 additions & 1 deletion kyuubi-server/src/main/scala/org/apache/kyuubi/server/KyuubiRestFrontendService.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,8 @@ class KyuubiRestFrontendService(override val serverable: Serverable)
getName,
host,
port,
conf.get(FRONTEND_REST_MAX_WORKER_THREADS))
conf.get(FRONTEND_REST_MAX_WORKER_THREADS),
conf.get(FRONTEND_REST_JETTY_STOP_TIMEOUT))
super.initialize(conf)
}

Expand Down
5 changes: 3 additions & 2 deletions kyuubi-server/src/main/scala/org/apache/kyuubi/server/KyuubiTrinoFrontendService.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import java.util.concurrent.atomic.AtomicBoolean

import org.apache.kyuubi.{KyuubiException, Utils}
import org.apache.kyuubi.config.KyuubiConf
import org.apache.kyuubi.config.KyuubiConf.{FRONTEND_ADVERTISED_HOST, FRONTEND_TRINO_BIND_HOST, FRONTEND_TRINO_BIND_PORT, FRONTEND_TRINO_MAX_WORKER_THREADS}
import org.apache.kyuubi.config.KyuubiConf.{FRONTEND_ADVERTISED_HOST, FRONTEND_TRINO_BIND_HOST, FRONTEND_TRINO_BIND_PORT, FRONTEND_TRINO_JETTY_STOP_TIMEOUT, FRONTEND_TRINO_MAX_WORKER_THREADS}
import org.apache.kyuubi.server.trino.api.v1.ApiRootResource
import org.apache.kyuubi.server.ui.JettyServer
import org.apache.kyuubi.service.{AbstractFrontendService, Serverable, Service}
Expand Down Expand Up @@ -54,7 +54,8 @@ class KyuubiTrinoFrontendService(override val serverable: Serverable)
getName,
host,
port,
conf.get(FRONTEND_TRINO_MAX_WORKER_THREADS))
conf.get(FRONTEND_TRINO_MAX_WORKER_THREADS),
conf.get(FRONTEND_TRINO_JETTY_STOP_TIMEOUT))
super.initialize(conf)
}

Expand Down
8 changes: 7 additions & 1 deletion kyuubi-server/src/main/scala/org/apache/kyuubi/server/ui/JettyServer.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,11 +73,17 @@ private[kyuubi] case class JettyServer(

object JettyServer {

def apply(name: String, host: String, port: Int, poolSize: Int): JettyServer = {
def apply(
name: String,
host: String,
port: Int,
poolSize: Int,
stopTimeout: Long): JettyServer = {
val pool = new QueuedThreadPool(poolSize)
pool.setName(name)
pool.setDaemon(true)
val server = new Server(pool)
server.setStopTimeout(stopTimeout)

val errorHandler = new ErrorHandler()
errorHandler.setShowStacks(true)
Expand Down

0 comments on commit 4390cc6

Please sign in to comment.