Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

perf(template): use more reasonable default value for Nginx tuning #11515

Merged
merged 2 commits into from
Sep 7, 2023
Merged

perf(template): use more reasonable default value for Nginx tuning #11515

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8cabfc2
perf(template): use more reasonable default value for Nginx tuning
dndx Sep 6, 2023
e0357e9
add changelog
dndx Sep 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CHANGELOG/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@
"bugfix",
"dependency",
"deprecation",
"breaking_change"
"breaking_change",
"performance"
Comment on lines +19 to +20
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also update: https://github.com/Kong/kong-ee/blob/master/CHANGELOG/changelog-md-template.lua?

]
},
"scope": {
Expand Down
7 changes: 7 additions & 0 deletions CHANGELOG/unreleased/kong/11515.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
message: Bumped the default value of `upstream_keepalive_pool_size` to `512` and `upstream_keepalive_max_requests` to `1000`
type: performance
scope: Configuration
prs:
- 11515
jiras:
- "FTI-4868"
50 changes: 30 additions & 20 deletions kong.conf.default
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -966,26 +966,26 @@
# `text/html`, `application/json`, and
# `application/xml`.

#upstream_keepalive_pool_size = 60 # Sets the default size of the upstream
# keepalive connection pools.
# Upstream keepalive connection pools
# are segmented by the `dst ip/dst
# port/SNI` attributes of a connection.
# A value of `0` will disable upstream
# keepalive connections by default, forcing
# each upstream request to open a new
# connection.

#upstream_keepalive_max_requests = 100 # Sets the default maximum number of
# requests than can be proxied upstream
# through one keepalive connection.
# After the maximum number of requests
# is reached, the connection will be
# closed.
# A value of `0` will disable this
# behavior, and a keepalive connection
# can be used to proxy an indefinite
# number of requests.
#upstream_keepalive_pool_size = 512 # Sets the default size of the upstream
# keepalive connection pools.
# Upstream keepalive connection pools
# are segmented by the `dst ip/dst
# port/SNI` attributes of a connection.
# A value of `0` will disable upstream
# keepalive connections by default, forcing
# each upstream request to open a new
# connection.

#upstream_keepalive_max_requests = 1000 # Sets the default maximum number of
# requests than can be proxied upstream
# through one keepalive connection.
# After the maximum number of requests
# is reached, the connection will be
# closed.
# A value of `0` will disable this
# behavior, and a keepalive connection
# can be used to proxy an indefinite
# number of requests.

#upstream_keepalive_idle_timeout = 60 # Sets the default timeout (in seconds)
# for which an upstream keepalive
Expand Down Expand Up @@ -1143,6 +1143,16 @@
# It is recommended to set it to at least (number of regex paths * 2)
# to avoid high CPU usages.

#nginx_http_keepalive_requests = 1000 # Sets the maximum number of client requests that can be served through one
# keep-alive connection. After the maximum number of requests are made,
# the connection is closed.
# Closing connections periodically is necessary to free per-connection
# memory allocations. Therefore, using too high maximum number of requests
# could result in excessive memory usage and not recommended.
# See: https://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_requests



#------------------------------------------------------------------------------
# DATASTORE
#------------------------------------------------------------------------------
Expand Down
9 changes: 5 additions & 4 deletions kong/templates/kong_defaults.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ status_ssl_cert_key = NONE
headers = server_tokens, latency_tokens
trusted_ips = NONE
error_default_type = text/plain
upstream_keepalive_pool_size = 60
upstream_keepalive_max_requests = 100
upstream_keepalive_pool_size = 512
upstream_keepalive_max_requests = 1000
upstream_keepalive_idle_timeout = 60
allow_debug_header = off

Expand All @@ -90,6 +90,9 @@ nginx_http_ssl_prefer_server_ciphers = NONE
nginx_http_ssl_dhparam = NONE
nginx_http_ssl_session_tickets = NONE
nginx_http_ssl_session_timeout = NONE
nginx_http_lua_regex_match_limit = 100000
nginx_http_lua_regex_cache_max_entries = 8192
nginx_http_keepalive_requests = 1000
nginx_stream_ssl_protocols = NONE
nginx_stream_ssl_prefer_server_ciphers = NONE
nginx_stream_ssl_dhparam = NONE
Expand All @@ -99,8 +102,6 @@ nginx_proxy_real_ip_header = X-Real-IP
nginx_proxy_real_ip_recursive = off
nginx_admin_client_max_body_size = 10m
nginx_admin_client_body_buffer_size = 10m
nginx_http_lua_regex_match_limit = 100000
nginx_http_lua_regex_cache_max_entries = 8192

client_body_buffer_size = 8k
real_ip_header = X-Real-IP
Expand Down
2 changes: 1 addition & 1 deletion spec/01-unit/04-prefix_handler_spec.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1385,7 +1385,7 @@ describe("NGINX conf compiler", function()
nil, true)
assert.matches("daemon on;", contents, nil, true)
assert.matches("listen 0.0.0.0:9000;", contents, nil, true)
assert.not_matches("keepalive", contents, nil, true)
assert.not_matches("keepalive%s+%d+", contents)
end)
end)
end)
Expand Down
Loading