Skip to content

Remove the deprecated fifocache.size and querier.ingester-metadata-streaming settings - #7791

Open
CharlieTLe wants to merge 2 commits into
cortexproject:masterfrom
CharlieTLe:release-1.22-pr-d2-remove-fifocache-metadata-streaming
Open

Remove the deprecated fifocache.size and querier.ingester-metadata-streaming settings#7791
CharlieTLe wants to merge 2 commits into
cortexproject:masterfrom
CharlieTLe:release-1.22-pr-d2-remove-fifocache-metadata-streaming

Conversation

@CharlieTLe

Copy link
Copy Markdown
Member

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.size

Deprecated in 1.1.0 (2020) — twenty-one minors and five years ago. NewFifoCache no
longer copies it into MaxSizeItems, so a cache configured only through size now starts
with no capacity (and already logs "neither max-size-bytes nor max-size-items is set").

-querier.ingester-metadata-streaming

Deprecated in 1.18.0, defaulted to true, and its help text has promised since then
that the feature "will be always on after v1.18". The querier now always uses the streaming
metadata RPCs, so this removes:

  • the non-streaming branches in distributor_queryable.go (Select on the /series path,
    LabelValues, LabelNames, labelNamesWithMatchers);
  • the three now-unreachable non-streaming methods from the local Distributor interface
    (MetricsForLabelMatchers, LabelValuesForLabelName, LabelNames). The real
    distributor keeps them; this only loosens what pkg/querier requires, and pkg/api
    never called them through the interface.
  • the tests that parameterised over streaming on/off, which collapse to a single case.

Also: a dead hidden YAML field

querier.ingester_streaming (doc:"hidden", bool) had no reader anywhere — just the
field declaration. It was left behind when -querier.ingester-streaming was deprecated in
1.17.0. Because Cortex decodes config with yaml.UnmarshalStrict, that key was still being
silently 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-streaming was slightly off.

Generated docs

docs/blocks-storage/querier.md, docs/configuration/config-file-reference.md and
schemas/cortex-config-schema.json are 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.

@dosubot dosubot Bot added go Pull requests that update Go code type/breaking type/chore Something that needs to be done; not a bug or a feature labels Aug 20, 2026
All eight have been past the two-minor deprecation window in v1-guarantees.md for at
least three minors, and every one is flag-only with no YAML config option and no effect
on behaviour, so removing them cannot change how a running cluster behaves. The only
impact is that a command line still passing one now fails at startup.

Split out from the deprecation removals that do touch YAML config or behaviour, so an
objection to those does not hold these up.

docs/blocks-storage/migrate-from-chunks-to-blocks.md stops telling readers to set
-querier.ingester-streaming. That guide still references other flags removed years ago
(-querier.second-store-engine, -querier.use-second-store-before-time); worth a separate
look at whether it should stay at all.

Signed-off-by: Charlie Le <charlie_le@apple.com>
…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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

go Pull requests that update Go code size/XL type/breaking type/chore Something that needs to be done; not a bug or a feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant