Skip to content

Commit 7fdc655

Browse files
authored
feat(gateway): raise prometheus-metrics and tracing_buffer shared-dict defaults (#310)
1 parent 388079e commit 7fdc655

3 files changed

Lines changed: 16 additions & 15 deletions

File tree

charts/gateway/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ type: application
1616
# Versions are expected to follow Semantic Versioning (https://semver.org/)
1717
# major.minor mirrors the API7 EE release line (3.10.x), patch is this chart's
1818
# own counter on that line and is decoupled from the app patch (see appVersion).
19-
version: 3.10.4
19+
version: 3.10.5
2020

2121
# This is the version number of the application being deployed. This version number should be
2222
# incremented each time you make changes to the application. Versions are not expected to

charts/gateway/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ The command removes all the Kubernetes components associated with the chart and
6161
| api7ee.status_endpoint.ip | string | `"0.0.0.0"` | The IP address and port on which the status endpoint will listen. |
6262
| api7ee.status_endpoint.port | int | `7085` | The port on which the status endpoint will listen. |
6363
| apisix.affinity | object | `{}` | Set affinity for API7 Gateway deploy |
64-
| apisix.customLuaSharedDicts | list | `[]` | Add custom [lua_shared_dict](https://github.com/openresty/lua-nginx-module#toc88) settings, click [here](https://github.com/apache/apisix-helm-chart/blob/master/charts/apisix/values.yaml#L27-L30) to learn the format of a shared dict |
64+
| apisix.customLuaSharedDicts | list | `[{"name":"kubernetes","size":"64m"},{"name":"nacos","size":"64m"},{"name":"consul","size":"64m"}]` | Add custom [lua_shared_dict](https://github.com/openresty/lua-nginx-module#toc88) settings, click [here](https://github.com/apache/apisix-helm-chart/blob/master/charts/apisix/values.yaml#L27-L30) to learn the format of a shared dict |
6565
| apisix.customizedConfig | object | `{}` | If apisix.enableCustomizedConfig is true, full customized config.yaml. Please note that other settings about APISIX config will be ignored |
6666
| apisix.deleteURITailSlash | bool | `false` | Delete the '/' at the end of the URI |
6767
| apisix.dnsConfig | object | `{}` | Custom DNS settings for the APISIX pods |
@@ -75,7 +75,7 @@ The command removes all the Kubernetes components associated with the chart and
7575
| apisix.extraLuaCPath | string | `""` | Extend lua_package_cpath to load third party Lua C libraries |
7676
| apisix.extraLuaPath | string | `""` | Extend lua_package_path to load third party Lua code |
7777
| apisix.hostNetwork | bool | `false` | Use the host's network namespace |
78-
| apisix.http.luaSharedDict | object | `{"access-tokens":"1m","balancer-ewma":"10m","balancer-ewma-last-touched-at":"10m","balancer-ewma-locks":"10m","cas-auth":"10m","discovery":"1m","etcd-cluster-health-check":"10m","internal-status":"10m","introspection":"10m","jwks":"1m","lrucache-lock":"10m","plugin-ai-rate-limiting":"10m","plugin-ai-rate-limiting-reset-header":"10m","plugin-api-breaker":"10m","plugin-graphql-limit-count":"10m","plugin-graphql-limit-count-reset-header":"10m","plugin-limit-conn":"10m","plugin-limit-conn-redis-cluster-slot-lock":"1m","plugin-limit-count":"10m","plugin-limit-count-advanced":"10m","plugin-limit-count-advanced-redis-cluster-slot-lock":"1m","plugin-limit-count-redis-cluster-slot-lock":"1m","plugin-limit-req":"10m","plugin-limit-req-redis-cluster-slot-lock":"1m","status_report":"1m","tars":"1m","tracing_buffer":"10m","upstream-healthcheck":"10m","worker-events":"10m"}` | Shared dict settings for the HTTP subsystem |
78+
| apisix.http.luaSharedDict | object | `{"access-tokens":"1m","api-calls-for-portal":"64m","balancer-ewma":"10m","balancer-ewma-last-touched-at":"10m","balancer-ewma-locks":"10m","cas-auth":"10m","discovery":"1m","etcd-cluster-health-check":"10m","internal-status":"10m","introspection":"10m","jwks":"1m","lrucache-lock":"10m","plugin-ai-rate-limiting":"10m","plugin-ai-rate-limiting-reset-header":"10m","plugin-api-breaker":"10m","plugin-graphql-limit-count":"10m","plugin-graphql-limit-count-reset-header":"10m","plugin-limit-conn":"10m","plugin-limit-conn-redis-cluster-slot-lock":"1m","plugin-limit-count":"10m","plugin-limit-count-advanced":"10m","plugin-limit-count-advanced-redis-cluster-slot-lock":"1m","plugin-limit-count-redis-cluster-slot-lock":"1m","plugin-limit-req":"10m","plugin-limit-req-redis-cluster-slot-lock":"1m","status_report":"1m","tars":"1m","tracing_buffer":"32m","upstream-healthcheck":"10m","worker-events":"10m"}` | Shared dict settings for the HTTP subsystem |
7979
| apisix.httpRouter | string | `"radixtree_host_uri"` | Defines how apisix handles routing: - radixtree_uri: match route by uri(base on radixtree) - radixtree_host_uri: match route by host + uri(base on radixtree) - radixtree_uri_with_parameter: match route by uri with parameters |
8080
| apisix.image.pullPolicy | string | `"Always"` | API7 Gateway image pull policy |
8181
| apisix.image.repository | string | `"api7/api7-ee-3-gateway"` | API7 Gateway image repository |
@@ -87,7 +87,7 @@ The command removes all the Kubernetes components associated with the chart and
8787
| apisix.lru.secret.neg_ttl | int | `60` | TTL in seconds for cached negative (failed lookup) results |
8888
| apisix.lru.secret.ttl | int | `300` | TTL in seconds for cached secret values |
8989
| apisix.maxPostArgsReadableSize | int | `64` | Cap (in MB) on the request body read when matching `post_arg.*` route predicates for JSON and multipart requests. Set to 0 to disable the limit. |
90-
| apisix.meta.luaSharedDict | object | `{"prometheus-metrics":"15m"}` | Shared dict settings for the `meta` context (used by both HTTP and stream subsystems) |
90+
| apisix.meta.luaSharedDict | object | `{"prometheus-metrics":"256m"}` | Shared dict settings for the `meta` context (used by both HTTP and stream subsystems) |
9191
| apisix.nodeSelector | object | `{}` | Node labels for API7 Gateway pod assignment |
9292
| apisix.normalizeURILikeServlet | bool | `false` | The URI normalization in servlet is a little different from the RFC's. See https://github.com/jakartaee/servlet/blob/master/spec/src/main/asciidoc/servlet-spec-body.adoc#352-uri-path-canonicalization, which is used under Tomcat. Turn this option on if you want to be compatible with servlet when matching URI path. |
9393
| apisix.podAnnotations | object | `{}` | Annotations to add to each pod |
@@ -113,7 +113,7 @@ The command removes all the Kubernetes components associated with the chart and
113113
| apisix.securityContext | object | `{}` | Set the securityContext for API7 Gateway container |
114114
| apisix.setIDFromPodUID | bool | `false` | Use Pod metadata.uid as the APISIX id. |
115115
| apisix.showUpstreamStatusInResponseHeader | bool | `false` | When true, the upstream status is always written to the `X-APISIX-Upstream-Status` response header; when false, it is written only for 5xx responses |
116-
| apisix.stream.luaSharedDict | object | `{"config-stream":"5m","etcd-cluster-health-check-stream":"10m","lrucache-lock-stream":"10m","nacos-stream":"20m","plugin-limit-conn-stream":"10m","tars-stream":"1m","worker-events-stream":"10m"}` | Shared dict settings for the stream (L4 proxy) subsystem |
116+
| apisix.stream.luaSharedDict | object | `{"config-stream":"5m","etcd-cluster-health-check-stream":"10m","lrucache-lock-stream":"10m","nacos-stream":"64m","plugin-limit-conn-stream":"10m","tars-stream":"1m","worker-events-stream":"10m"}` | Shared dict settings for the stream (L4 proxy) subsystem |
117117
| apisix.terminationGracePeriodSeconds | int | `30` | termination grace period for API7 Gateway pods |
118118
| apisix.timezone | string | `""` | timezone is the timezone where apisix uses. For example: "UTC" or "Asia/Shanghai" This value will be set on apisix container's environment variable TZ. You may need to set the timezone to be consistent with your local time zone, otherwise the apisix's logs may used to retrieve event maybe in wrong timezone. |
119119
| apisix.tolerations | list | `[]` | List of node taints to tolerate |

charts/gateway/values.yaml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ apisix:
9999
meta:
100100
# -- Shared dict settings for the `meta` context (used by both HTTP and stream subsystems)
101101
luaSharedDict:
102-
prometheus-metrics: 15m
102+
prometheus-metrics: 256m
103103

104104
stream:
105105
# -- Shared dict settings for the stream (L4 proxy) subsystem
@@ -110,7 +110,7 @@ apisix:
110110
worker-events-stream: 10m
111111
tars-stream: 1m
112112
config-stream: 5m
113-
nacos-stream: 20m
113+
nacos-stream: 64m
114114

115115
http:
116116
# -- Shared dict settings for the HTTP subsystem
@@ -134,7 +134,7 @@ apisix:
134134
plugin-limit-count-redis-cluster-slot-lock: 1m
135135
plugin-limit-count-advanced: 10m
136136
plugin-limit-count-advanced-redis-cluster-slot-lock: 1m
137-
tracing_buffer: 10m
137+
tracing_buffer: 32m
138138
plugin-api-breaker: 10m
139139
etcd-cluster-health-check: 10m
140140
discovery: 1m
@@ -144,6 +144,7 @@ apisix:
144144
tars: 1m
145145
cas-auth: 10m
146146
status_report: 1m
147+
api-calls-for-portal: 64m
147148

148149
# -- fine tune the parameters of LRU cache for some features like secret
149150
lru:
@@ -163,15 +164,15 @@ apisix:
163164

164165
# -- Add custom [lua_shared_dict](https://github.com/openresty/lua-nginx-module#toc88) settings,
165166
# click [here](https://github.com/apache/apisix-helm-chart/blob/master/charts/apisix/values.yaml#L27-L30) to learn the format of a shared dict
166-
customLuaSharedDicts: []
167-
# - name: kubernetes
168-
# size: 20m
169-
# - name: nacos
170-
# size: 20m
167+
customLuaSharedDicts:
168+
- name: kubernetes
169+
size: 64m
170+
- name: nacos
171+
size: 64m
172+
- name: consul
173+
size: 64m
171174
# - name: foo
172175
# size: 10k
173-
# - name: bar
174-
# size: 1m
175176

176177
# -- Extend lua_package_path to load third party Lua code
177178
extraLuaPath: ""

0 commit comments

Comments
 (0)