diff --git a/agent/catalog_endpoint.go b/agent/catalog_endpoint.go index cc28a6f6ad63..b4f0ee9b4f25 100644 --- a/agent/catalog_endpoint.go +++ b/agent/catalog_endpoint.go @@ -77,7 +77,7 @@ func (s *HTTPServer) CatalogDatacenters(resp http.ResponseWriter, req *http.Requ parseCacheControl(resp, req, &args.QueryOptions) var out []string - if args.QueryOptions.UseCache { + if s.agent.config.HTTPUseCache && args.QueryOptions.UseCache { raw, m, err := s.agent.cache.Get(cachetype.CatalogDatacentersName, &args) if err != nil { metrics.IncrCounterWithLabels([]string{"client", "rpc", "error", "catalog_datacenters"}, 1, @@ -155,7 +155,7 @@ func (s *HTTPServer) CatalogServices(resp http.ResponseWriter, req *http.Request var out structs.IndexedServices defer setMeta(resp, &out.QueryMeta) - if args.QueryOptions.UseCache { + if s.agent.config.HTTPUseCache && args.QueryOptions.UseCache { raw, m, err := s.agent.cache.Get(cachetype.CatalogListServicesName, &args) if err != nil { metrics.IncrCounterWithLabels([]string{"client", "rpc", "error", "catalog_services"}, 1, @@ -240,7 +240,7 @@ func (s *HTTPServer) catalogServiceNodes(resp http.ResponseWriter, req *http.Req var out structs.IndexedServiceNodes defer setMeta(resp, &out.QueryMeta) - if args.QueryOptions.UseCache { + if s.agent.config.HTTPUseCache && args.QueryOptions.UseCache { raw, m, err := s.agent.cache.Get(cachetype.CatalogServicesName, &args) if err != nil { metrics.IncrCounterWithLabels([]string{"client", "rpc", "error", "catalog_service_nodes"}, 1, diff --git a/agent/config/builder.go b/agent/config/builder.go index 7227ea18ae03..c43b649f3109 100644 --- a/agent/config/builder.go +++ b/agent/config/builder.go @@ -762,6 +762,7 @@ func (b *Builder) Build() (rt RuntimeConfig, err error) { HTTPBlockEndpoints: c.HTTPConfig.BlockEndpoints, HTTPResponseHeaders: c.HTTPConfig.ResponseHeaders, AllowWriteHTTPFrom: b.cidrsVal("allow_write_http_from", c.HTTPConfig.AllowWriteHTTPFrom), + HTTPUseCache: b.boolValWithDefault(c.HTTPConfig.UseCache, true), // Telemetry Telemetry: lib.TelemetryConfig{ diff --git a/agent/config/config.go b/agent/config/config.go index 166d2d5086c1..d02808c7a892 100644 --- a/agent/config/config.go +++ b/agent/config/config.go @@ -599,6 +599,7 @@ type HTTPConfig struct { BlockEndpoints []string `json:"block_endpoints,omitempty" hcl:"block_endpoints" mapstructure:"block_endpoints"` AllowWriteHTTPFrom []string `json:"allow_write_http_from,omitempty" hcl:"allow_write_http_from" mapstructure:"allow_write_http_from"` ResponseHeaders map[string]string `json:"response_headers,omitempty" hcl:"response_headers" mapstructure:"response_headers"` + UseCache *bool `json:"use_cache,omitempty" hcl:"use_cache" mapstructure:"use_cache"` } type Performance struct { diff --git a/agent/config/runtime.go b/agent/config/runtime.go index 80996c1b5943..9bc179bd9c31 100644 --- a/agent/config/runtime.go +++ b/agent/config/runtime.go @@ -349,6 +349,12 @@ type RuntimeConfig struct { // hcl: dns_config { cache_max_age = "duration" } DNSCacheMaxAge time.Duration + // HTTPUseCache whether or not to use cache for http queries. Defaults + // to true. + // + // hcl: http_config { use_cache = (true|false) } + HTTPUseCache bool + // HTTPBlockEndpoints is a list of endpoint prefixes to block in the // HTTP API. Any requests to these will get a 403 response. // diff --git a/agent/config/runtime_test.go b/agent/config/runtime_test.go index b9488f20de39..1ca6c5984609 100644 --- a/agent/config/runtime_test.go +++ b/agent/config/runtime_test.go @@ -1989,6 +1989,54 @@ func TestConfigFlagsAndEdgecases(t *testing.T) { `}, err: "Serf Advertise WAN address 10.0.0.1:1000 already configured for RPC Advertise", }, + { + desc: "http use_cache defaults to true", + args: []string{ + `-data-dir=` + dataDir, + }, + json: []string{`{ + "http_config": {} + }`}, + hcl: []string{` + http_config = {} + `}, + patch: func(rt *RuntimeConfig) { + rt.DataDir = dataDir + rt.HTTPUseCache = true + }, + }, + { + desc: "http use_cache is enabled when true", + args: []string{ + `-data-dir=` + dataDir, + }, + json: []string{`{ + "http_config": { "use_cache": true } + }`}, + hcl: []string{` + http_config = { use_cache = true } + `}, + patch: func(rt *RuntimeConfig) { + rt.DataDir = dataDir + rt.HTTPUseCache = true + }, + }, + { + desc: "http use_cache is disabled when false", + args: []string{ + `-data-dir=` + dataDir, + }, + json: []string{`{ + "http_config": { "use_cache": false } + }`}, + hcl: []string{` + http_config = { use_cache = false } + `}, + patch: func(rt *RuntimeConfig) { + rt.DataDir = dataDir + rt.HTTPUseCache = false + }, + }, { desc: "sidecar_service can't have ID", args: []string{ @@ -3721,7 +3769,8 @@ func TestFullConfig(t *testing.T) { "response_headers": { "M6TKa9NP": "xjuxjOzQ", "JRCrHZed": "rl0mTx81" - } + }, + "use_cache": false }, "key_file": "IEkkwgIA", "leave_on_terminate": true, @@ -4324,6 +4373,7 @@ func TestFullConfig(t *testing.T) { "M6TKa9NP" = "xjuxjOzQ" "JRCrHZed" = "rl0mTx81" } + use_cache = false } key_file = "IEkkwgIA" leave_on_terminate = true @@ -5018,6 +5068,7 @@ func TestFullConfig(t *testing.T) { HTTPMaxConnsPerClient: 9283, HTTPSHandshakeTimeout: 2391 * time.Millisecond, HTTPSPort: 15127, + HTTPUseCache: false, KeyFile: "IEkkwgIA", KVMaxValueSize: 1234567800000000, LeaveDrainTime: 8265 * time.Second, @@ -5873,6 +5924,7 @@ func TestSanitize(t *testing.T) { "HTTPMaxConnsPerClient": 0, "HTTPPort": 0, "HTTPResponseHeaders": {}, + "HTTPUseCache": false, "HTTPSAddrs": [], "HTTPSHandshakeTimeout": "0s", "HTTPSPort": 0, diff --git a/agent/discovery_chain_endpoint.go b/agent/discovery_chain_endpoint.go index 7e3bd31b71bf..e3cea1eea040 100644 --- a/agent/discovery_chain_endpoint.go +++ b/agent/discovery_chain_endpoint.go @@ -56,7 +56,7 @@ func (s *HTTPServer) DiscoveryChainRead(resp http.ResponseWriter, req *http.Requ var out structs.DiscoveryChainResponse defer setMeta(resp, &out.QueryMeta) - if args.QueryOptions.UseCache { + if s.agent.config.HTTPUseCache && args.QueryOptions.UseCache { raw, m, err := s.agent.cache.Get(cachetype.CompiledDiscoveryChainName, &args) if err != nil { return nil, err diff --git a/agent/health_endpoint.go b/agent/health_endpoint.go index 8626df821e5a..fe8b761d3126 100644 --- a/agent/health_endpoint.go +++ b/agent/health_endpoint.go @@ -186,7 +186,7 @@ func (s *HTTPServer) healthServiceNodes(resp http.ResponseWriter, req *http.Requ var out structs.IndexedCheckServiceNodes defer setMeta(resp, &out.QueryMeta) - if args.QueryOptions.UseCache { + if s.agent.config.HTTPUseCache && args.QueryOptions.UseCache { raw, m, err := s.agent.cache.Get(cachetype.HealthServicesName, &args) if err != nil { return nil, err diff --git a/agent/prepared_query_endpoint.go b/agent/prepared_query_endpoint.go index 8bccb5b9362f..ca195479f614 100644 --- a/agent/prepared_query_endpoint.go +++ b/agent/prepared_query_endpoint.go @@ -121,7 +121,7 @@ func (s *HTTPServer) preparedQueryExecute(id string, resp http.ResponseWriter, r var reply structs.PreparedQueryExecuteResponse defer setMeta(resp, &reply.QueryMeta) - if args.QueryOptions.UseCache { + if s.agent.config.HTTPUseCache && args.QueryOptions.UseCache { raw, m, err := s.agent.cache.Get(cachetype.PreparedQueryName, &args) if err != nil { // Don't return error if StaleIfError is set and we are within it and had