Feat/file based filter provider#1167
Open
nicholasxuu wants to merge 3 commits into
Open
Conversation
Move IP/UID allow+deny lists from startup-only env vars into an
independently mounted YAML file (typically a Kubernetes ConfigMap)
so the high-churn filter rules can be updated without restarting
ratelimit pods.
New env var FILTER_CONFIG_PATH (default empty):
- empty -> existing WHITELIST_IP_NET / BLACKLIST_IP_NET /
WHITELIST_UID / BLACKLIST_UID env-var behavior is
preserved exactly (fully backward compatible)
- non-empty -> filters load from the YAML at that path; fsnotify
watches the file's parent directory (K8s ConfigMap
symlink swap requires dir-level watch) and reloads
atomically on change
Reload semantics:
- successful reload -> atomic.Pointer swap; new rules apply to
all subsequent requests with no lock
- yaml/cidr error -> keep previous filter, log + counter
- file deleted -> keep previous filter (prevents a transient
ConfigMap disappearance from flipping the
gate to deny-all)
- initial load fails -> startup panic (matches the existing CIDR-
env-var error contract)
Hot-path cleanup:
- shouldRateLimitWorker no longer calls settings.NewSettings() per
request; ForceFlag, OnlyLogOnLimit and the filter provider are
snapshotted at NewService() construction and read directly. At
20-30k QPS this avoids one envconfig reflection + one filter
reconstruction per request.
Lifecycle:
- Runner stores the filter.Provider and Stop()s it on shutdown so
the fsnotify watcher fd + watch goroutine are released cleanly
(no-op for the static env-var fallback).
Files:
- src/filter/loader.go - YAML decode, CIDR validation
- src/filter/provider.go - Provider interface, static + file impls
- src/settings/settings.go - new FILTER_CONFIG_PATH field
- src/service/ratelimit.go - inject Provider, remove per-request
NewSettings()
- src/service_cmd/runner/runner.go - wire Provider, Stop chain
- test/filter/* - 37 assertions, ECP/BVA + pairwise table
in file headers, -race clean
- test/service/ratelimit_test.go - 4 NewService call sites updated
Deploy: mount the filter ConfigMap as a directory (NOT subPath -
subPath mounts do not receive inotify events) and point
FILTER_CONFIG_PATH at the file inside it.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.