Remove the deprecated fifocache.size and querier.ingester-metadata-streaming settings - #7791
Conversation
4d1e4c8 to
5a2456e
Compare
…reaming settings Unlike the flag-only removals, both of these have a YAML config option and one of them changes behaviour, so they are split out here. -<prefix>.fifocache.size was deprecated in 1.1.0, five years and twenty-one minors ago. A cache configured only through it now starts with no capacity, because NewFifoCache no longer copies it into MaxSizeItems. -querier.ingester-metadata-streaming defaulted to true and its help text has promised since 1.18.0 that the feature would be always on. The querier now always uses the streaming metadata RPCs, so the non-streaming branches in distributor_queryable.go and the three non-streaming methods on the local Distributor interface are gone. The tests that parameterised over streaming on/off collapse accordingly. Also removes the hidden ingester_streaming YAML field, which had no reader at all - it was left behind when -querier.ingester-streaming was deprecated in 1.17.0. Because Cortex decodes config with UnmarshalStrict, that field was still silently accepted until now. Generated config docs and the JSON schema are regenerated. Signed-off-by: Charlie Le <charlie_le@apple.com>
5a2456e to
9c8eb5b
Compare
|
We need to delete it in |
…size field The example query-frontend configs still set `fifocache.size`, which this branch removes from FifoCacheConfig. Since Cortex decodes config with yaml.UnmarshalStrict, both examples would now fail to load. Replace it with `max_size_items: 1024` rather than dropping it, so the example still describes a bounded cache instead of one that starts with no capacity and logs a warning. Signed-off-by: Charlie Le <charlie_le@apple.com>
|
Good catch, thanks — fixed in 316d263. Both examples would have failed to load outright after this change, since Cortex decodes config with I replaced the key rather than deleting it outright: fifocache:
max_size_items: 1024 # was: size: 1024
validity: 24hDeleting I also grepped the tree for any other config example still using Verified by unmarshalling Unrelated pre-existing bug I noticed while in there, not touched in this PR: |
Groundwork for v1.22.0. Refs #5922.
Important
Stacked on #7790. Please merge that first; this branch contains its commit, so the
diff here shows both until it lands. Review the second commit only.
Unlike #7790, both settings here have a YAML config option and one of them changes
behaviour, so they are split out.
-<prefix>.fifocache.sizeDeprecated in 1.1.0 (2020) — twenty-one minors and five years ago.
NewFifoCachenolonger copies it into
MaxSizeItems, so a cache configured only throughsizenow startswith no capacity (and already logs "neither max-size-bytes nor max-size-items is set").
-querier.ingester-metadata-streamingDeprecated in 1.18.0, defaulted to
true, and its help text has promised since thenthat the feature "will be always on after v1.18". The querier now always uses the streaming
metadata RPCs, so this removes:
distributor_queryable.go(Selecton the/seriespath,LabelValues,LabelNames,labelNamesWithMatchers);Distributorinterface(
MetricsForLabelMatchers,LabelValuesForLabelName,LabelNames). The realdistributor keeps them; this only loosens what
pkg/querierrequires, andpkg/apinever called them through the interface.
Also: a dead hidden YAML field
querier.ingester_streaming(doc:"hidden",bool) had no reader anywhere — just thefield declaration. It was left behind when
-querier.ingester-streamingwas deprecated in1.17.0. Because Cortex decodes config with
yaml.UnmarshalStrict, that key was still beingsilently accepted until now.
I put it here rather than in #7790 so that PR stays honestly flag-only. Note this means the
plan's "flag-only" classification of
-querier.ingester-streamingwas slightly off.Generated docs
docs/blocks-storage/querier.md,docs/configuration/config-file-reference.mdandschemas/cortex-config-schema.jsonare regenerated (make doc).Verification
go build ./...,go vet ./...(no new findings),make doc, and./pkg/querier/... ./pkg/chunk/cache/... ./pkg/cortex/... ./pkg/api/...all green.