forked from helidon-io/helidon
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
4.x tuning guide update (helidon-io#8140)
* Update performance tuning guide * Update description of tcp-no-delay
- Loading branch information
Showing
5 changed files
with
96 additions
and
65 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
/////////////////////////////////////////////////////////////////////////////// | ||
|
||
Copyright (c) 2020, 2023 Oracle and/or its affiliates. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
|
||
/////////////////////////////////////////////////////////////////////////////// | ||
ifndef::rootdir[:rootdir: {docdir}/../..] | ||
:guidesdir: {rootdir}/{flavor-lc}/guides | ||
== WebServer Tuning | ||
Helidon WebServer is in large part self tuning. It uses default values that will satisfy most use cases, | ||
and with the adoption of Java virtual threads there is no longer a need to tune pools of platform threads. | ||
Still, there might be cases where you wish to change configuration options from their default values. | ||
For details on the following options please see: | ||
* xref:../../se/webserver.adoc#_configuration_options[WebServer Configuration] | ||
* xref:../../config/io_helidon_webserver_ConnectionConfig.adoc[WebServer Connection Configuration] | ||
* xref:../../config/io_helidon_common_socket_SocketOptions.adoc[WebServer Socket Configuration] | ||
== Summary of Tuning Options | ||
The following `application.yaml` snippet shows some configuration options that can be used to | ||
tune your application. It is intended to show configuration options in context. Please make sure | ||
you understand these options before using them. See the documentation referenced above. | ||
[source, yaml] | ||
.application.yaml snippet | ||
---- | ||
server: | ||
# These are used to prevent unbounded resource consumption of the server | ||
idle-connection-period: PT2M # Check idle connections every 2 minutes | ||
idle-connection-timeout: PT5M # Close connections that have been idle for 5 minutes | ||
max-concurrent-requests: NNNN # Maximum number of concurrent requests. -1 is unlimited. | ||
max-tcp-connections: NNNN # Max number of concurrent tcp connections. -1 is unlimited. | ||
max-in-memory-entity: NNNNNN # Entities smaller than this are buffered in memory vs streamed (bytes) | ||
max-payload-size: NNNNNNN # Reject requests with payload sizes greater than this. -1 is unlimited (bytes) | ||
# Depends on the workload and kernel version | ||
backlog: NNNN | ||
receive-buffer-size: NNNNN | ||
write-buffer-size: NNNNN | ||
write-queue-length: NN # 0 means direct write | ||
connection-options: | ||
# 0 means indefinite (and less clutter on socket impl) | ||
read-timeout: PT0S | ||
connect-timeout: PT0S | ||
# Default (false: Nagle's algorithm enabled) is best for most cases. But for some OS and | ||
# workloads enabling TCP_NODELAY (disable Nagle's algorithm) can improve performance. | ||
tcp-no-delay: true|false | ||
# The default is TCP autotuning which is best for most cases. | ||
socket-send-buffer-size: NNNNN | ||
socket-receive-buffer-size: NNNNN | ||
# Protocol validation. | ||
# Careful with this! Can be dangerous if you turn these off. | ||
protocols: | ||
"http_1_1": | ||
validate-request-headers: true|false | ||
validate-response-headers: true|false | ||
validate-path: true|false | ||
recv-log: true|false | ||
send-log: true|false | ||
---- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters