Changelog
0.40.0 - 2026-08-18
Breaking
- 💥 A bad configuration value raises
SettingsValidationError, whichever pattern or component you built. The ten per-module subclasses are removed:CacheSettingsValidationError,CoordinationSettingsValidationError,HealthSettingsValidationError,IdempotencySettingsValidationError,LogSettingsValidationError,MetricsSettingsValidationError,OutboxSettingsValidationError,ResilienceSettingsValidationError,TaskSettingsValidationError, andTraceSettingsValidationError. Catch the base error, which every one of them already subclassed. No caller ever reacted differently by module, and the message names the exact variable. (#750) - 💥
Fallback,Shield, andTTLCacheraiseSettingsValidationErrorfor a bad value instead of lettingpydantic.ValidationErrorthrough. Both areValueError, so anexcept ValueErrorkeeps working. (#750) - 💥 A rejected instance name, table name, or key prefix raises
SettingsValidationErrorinstead of a bareValueError, so oneexceptcovers identity and configuration alike. It still subclassesValueError. (#755) - 💥
cached(),TrustedProxies, andExternalConfigraiseSettingsValidationErrorfor a bad value instead of a bareValueErrororTypeError.cached(ttl=-1)already did, whilelock=,early=, andstale_ttl=did not, so one call had two contracts. (#760) - 💥
Grelmicro(environment=...)refuses a value outside the four tiers instead of storing it. It was accepted in silence, and the backend check then ran as if no tier were declared. The environment variable already warned, so the two doors disagreed. (#760) - 💥
Match.exception()andMatch.exception_cause()raiseValueErrorinstead ofTypeErroron an argument that is not an exception class, and on no argument at all. The same goes for awhen=that is not aMatch, an exception class, a tuple, or a callable. pydantic converts onlyValueError, so the oldTypeErrorescaped every documentedexceptwhen the value came from a variable. Anexcept TypeErroraround a directMatch.exception(...)call stops matching. (#750) - 💥
RedisProviderConfigErrorandPostgresProviderConfigErrorare removed. A provider raisesSettingsValidationError, like every other class. They were the last two per-module subclasses, left behind when the other ten went. (#750) - 💥 An error no longer repeats any part of the value it rejected, including an unknown timezone name, which used to be quoted. The message names a close match instead, as
did you mean 'Europe/Zurich'. (#760)
Fixed
- 🔒
Fallback,Shield, andTTLCacheechoed the rejected value into the error. Pydantic attaches the input to every error it raises, soGREL_FALLBACK_{NAME}_WHENreached the traceback verbatim, andGREL_SHIELD_{NAME}_MAX_RATEfailed with a bareValueErrorfromfloat()carrying the same string. 0.39.0 said every configuration path raisedSettingsValidationError. These three did not. (#750) - 🔒 A validator that names the value it rejected leaked it through the wrapper, which strips only pydantic's own copy of the input. The
when=andtimeout_errorsentries onRetry,Fallback, andShieldno longer report any part of the rejected entry. (#750) - 🐛 A
when=ortimeout_errorsentry that resolved to something other than an exception class raisedTypeError, which escapedexcept SettingsValidationErrorandexcept ValueErroralike, because pydantic converts onlyValueErrorandAssertionErrorinto a validation error.GREL_RETRY_{NAME}_WHEN=os.getcwdhit it. (#750) - 🐛 One bad key in a mounted ConfigMap stopped every other instance from reloading.
Match.exceptionraisedTypeError, which pydantic does not convert, so it escaped the reload loop and aborted the whole resync cycle. An emptyGREL_RETRY_{NAME}_WHENwas enough to trigger it. The loop now skips any value a validator refuses, whatever it raises. (#760) - 🐛 A malformed dict-valued variable such as
GREL_METRICS_HEADERSraisedpydantic_settings.SettingsErrorat app open, notSettingsValidationError. pydantic-settings decodes a complex field before validation runs, so the error never reached the wrapper. Affects theheadersandresource_attributesfields onMetricsandTrace. (#760) - 🔒
SettingsValidationErrornow scrubs the rejected value out of messages built elsewhere. Pydantic writes the input into some of its own text, soGREL_RETRY_{NAME}_BACKOFFechoed an unknown algorithm tag andGREL_CIRCUITBREAKER_{NAME}_IGNORE_EXCEPTIONSechoed the module half of an import path. (#760) - 🔒
RandomBackoffreported both delays it rejected, reachable throughGREL_RETRY_{NAME}_BACKOFF, andUnknownEnvironmentWarningreported theGREL_ENVIRONMENTvalue on both the warning and the logging channel. (#760) - 🐛 An unknown timezone abbreviation was offered a zone on the wrong continent.
PSTandJSTboth suggestedMST,CESTsuggestedEST. A short name that carries no region now gets no suggestion, and a city on its own such asZurichreachesEurope/Zurich, which it could not before. (#750) - 🔒 The scrub covers a custom error code, which is a message someone wrote rather than one pydantic built. It listed pydantic's own types, so a
PydanticCustomErrorraised by a third-party config class was skipped. (#750) - 🐛
PostgresOutboxAdapterraised a bareValueErrorfor a rejected table name while every other adapter raisedSettingsValidationError. (#755) - 🐛
cleanup_intervalraised a bareValueErrorand echoed the value it rejected, in the same constructor whosetable_nameraisedSettingsValidationError. Affects the Postgres and SQLite cache and circuit breaker adapters. (#760) - 🐛 A bad
GREL_SHIELD_MAX_RATEreportedGREL_SHIELD_{NAME}_MAX_RATE, a variable that is not set, sending the operator to the wrong one. The error names the variable it read. (#760) - 🔒 A
reconfigure()that refused a value wrote its message to the log on the reload path, where the message may name the value. Only the error class is logged, which the handler beside it already did. (#760) - 🐛
Trace(instrument=...)validated the directive only when an exporter was active, so a bad one opened cleanly in development and first raised on the deploy that set an endpoint. (#760)
Added
- 👷
just release <version>runs everything ahead of the tag: it cuts the changelog, runs the full preflight, and prints thegh release createcommand rather than running it. Creating the tag stays a conscious act, because it cannot be undone. CONTRIBUTING documents the sequence, which was previously discoverable only by triggering the failures. (#757) - ✅ The public API snapshot records default values, including what a
default_factoryreturns and the return annotation, so a changed default or return type fails CI. (#764) - ✅ Three contract sweeps enforce what the architecture docs publish, discovered by walking the package rather than by a hand-written list.
tests/test_backend_contracts.pycovers thebindcontract over every backend adapter,tests/test_config_contracts.pycovers R3, R4 and the reload rules over everyReconfigurable, andtests/test_construction_contracts.pycovers the declarative door over every class withfrom_config. Each refuses to pass on an empty scan, so an adapter or pattern added later is covered without anyone remembering. (#755) - 📝 An Errors reference page.
SettingsValidationErroris now the one configuration error, and it had no documented home. (#750) - ✅ The public API snapshot covers
grelmicro.outboxandgrelmicro.types. Both were documented in the API reference while their exports went unguarded, so a rename could have shipped unnoticed. A test now reads the reference pages, so documenting a module guards it. (#750)
0.39.0 - 2026-08-16
Breaking
- 💥 Every configuration path that goes through
resolve_configraisesSettingsValidationErrorfor a bad value. The patterns used to let the rawpydantic.ValidationErrorthrough, which carriesinput_valueand so echoed a rejected environment value into the traceback. CatchSettingsValidationError, orValueError, which both it and the pydantic error already are. (Fallback,Shield, andTTLCacheresolve their own configuration and were missed here, fixed in the next release.) - 💥
CircuitBreaker,RateLimiter, and theShieldfactories readGREL_CIRCUITBREAKER_*,GREL_RATELIMITER_*, andGREL_SHIELD_*at construction whenGREL_ENV_LOADis on, like every other pattern. Variables that were silently ignored now apply, and a named instance refuses at startup a variable belonging to a different algorithm than the code runs. Before upgrading a deployment withGREL_ENV_LOADset, runenv | grep -E "GREL_(RATELIMITER|CIRCUITBREAKER|SHIELD)_"in the container and remove or fix what it prints. The environment still never picks the algorithm. - 💥
CircuitBreakerno longer takes a positional config. Pass a pre-built config tofrom_config, which did exactly the same thing.CircuitBreaker("payments")still works, because consecutive-count is a sensible default. - 💥
RateLimiterloses its bare constructor. Build it withtoken_bucket,sliding_window, orfrom_config. There is no default algorithm to fall back on, so the constructor now raisesTypeErrornaming those three. - 💥
Timeout,Retry,Fallback,Bulkhead,Log,Metrics,Trace,Shield, andOutboxno longer takeconfig=. Pass a pre-built config tofrom_config, which did exactly the same thing. One door instead of two. - 💥
grelmicro.clientipmoved togrelmicro.security. ImportTrustedProxies,ClientAddress,ClientAddressReason,ClientAddressMiddleware, andresolve_client_addressfrom there. The logger is renamed togrelmicro.security.clientip, so a filter or a level set on the old name stops matching.
Added
- ✨
grelmicro.securityholds the checks a service runs on an inbound request. Client IP resolution is the first one, and the module states the line grelmicro keeps: it validates what arrives, it never issues credentials. - ✨
micro.install(app)wires a Litestar app. It opens the components on startup, closes them after shutdown, and binds the app around each request so patterns resolve with nobackend=. Call it afterLitestar(...), which builds its middleware stack at construction. - ✨ New
fastapi,starlette, andlitestarextras, sopip install "grelmicro[litestar]"brings the framework along. - 📝 A Frameworks page lists every framework
micro.install(app)supports and what it wires for each. - 📝 Plugins states what grelmicro promises a third-party adapter: how an unsupported algorithm fails, that result tuples grow by name, that integration signatures are frozen, and that
ClockBackendis complete. Adding a member to a protocol breaks every implementer, so these are settled before 1.0. - ✨
Outbox.from_configandTTLCache.from_configcomplete the declarative path. Every primitive that has a config class now accepts one the same way. - ✨
Bulkhead.from_configacceptsuses=to scope providers and components, which the declarative path could not do before. - 📝 Configuration internals states the environment contract as one invariant plus nine rules, with a Settled table recording the assumption behind each closed decision. Written down because this surface changed nineteen times across twelve releases, every time because the contract lived nowhere.
- 📝 Publish/subscribe is a stated non-goal. The outbox consumer page shows the handler publishing through FastStream, and explains why the durable half and the transport half are separate.
Fixed
- 🐛
SettingsValidationErrorraisedIndexErrorinstead of rendering when the failure came from a model-level validator, which has no field location.Lock(retry_interval=0.0001)hit it. - 🐛 The gate-off report told the operator to remove a kind-wide variable that names another algorithm's field. That variable is a legitimate broadcast tuning the instances it fits, so the advice would have deleted working configuration. Only an instance address carries that message now.
- 🐛
MemoryCircuitBreakerAdapter.bindran any algorithm as consecutive-count instead of refusing the ones it does not implement. The three other adapters already refused. - 🐛 The
Shieldfactories ignored the environment while the bare constructor read it, and neither reported a variable set with the gate off.Shield.slow("x")now resolves values from the environment with the preset pinned by code. - 🐛 A
GREL_{KIND}_{FIELD}variable set whileGREL_ENV_LOADwas off went unreported on a named instance. Only the instance address was checked, so the kind-wide variable that would have applied was dropped in silence. Every component was affected. - 🐛
reconfigurerefused the config class its own docs told you to build. An instance constructed through the environment holds a settings subclass, and the runtime-type check rejected the plain config. Every pattern was affected, not just the two gaining the environment path here. - 🐛
docs/config.mdsaidIdempotencysets itsttlin code only. It readsGREL_IDEMPOTENCY_TTLlike every other named pattern. - 🐛 The rate limiter backends rejected an unsupported algorithm kind with
AssertionError, while the circuit breaker backends raisedNotImplementedError. All of them now raiseNotImplementedErrornaming the kind. Every adapter also read the provider client before checking the kind, so an unsupported kind needed a live connection to fail.
0.38.1 - 2026-08-15
Added
- ✨
grelmicro.describeexposes the report modelsGrelmicro.describe()returns, so a caller can annotate a report without reaching into a private module.import grelmicrostill does not pay for them. (#734) - ✨
micro.health,micro.metrics,micro.outbox,micro.ratelimiter, andmicro.circuitbreakerare typed properties. Every first-party kind now keeps its type through lookup instead of resolving asAny. (#734) - ✨ Export the names public signatures already required:
LockConfigandTaskLockConfig(needed byfrom_config),Task(accepted byTasks(tasks=...)andTaskRouter.add_task), and the fourLog*Typeenums (accepted byconfigure). (#734) - ✨
Metrics.provider,Metrics.prometheus_registry, andTrace.providerreturn their OpenTelemetry and Prometheus types instead ofAny. (#734)
Fixed
- 🐛
HealthChecksnever registered for live reload, soExternalConfigcould not retune it from a mounted ConfigMap. It inherited the reconfiguration machinery like every other component but was the only one that did not track itself. (#734) - 🐛
TTLCache.get_or_setandIdempotency.runawaited only coroutines, so a factory returning any other awaitable, such as aFuture, had that awaitable stored as the cached value or the idempotent response. (#734) - 🐛
TrustedProxiesacceptedmax_entries=0, which slices asentries[-0:]and returns the whole list, so the cap silently allowed everything it was meant to bound. Zero and negative values now raise, andmax_hops=0stays valid. (#734) - 🐛 The singleton guard only inspected the incoming component, so a plain component of a singleton kind could register after the singleton. Either side declaring the kind is now enough. (#734)
- 🐛
CallLog.count(name=None)matched calls that never passedname, because an absent key read asNone. (#734) - 🐛
ExternalConfig(reload_interval=0)polled without pause. The interval must now be positive. (#734) - 🐛
@idempotentaccepted a synchronous function that then failed at runtime, and erased the decorated return type. It now requires a coroutine function and preserves the type. (#734) - 🐛 The
CircuitBreaker.consecutive_countdocstring claimed the bare constructor reads environment variables. No circuit breaker path does. (#734)
0.38.0 - 2026-08-15
Breaking
- 💥 The bare
GREL_{PATTERN}_prefix is now the default for every instance of a pattern, not just the default instance.GREL_LOCK_LEASE_DURATION=60used to configureLock("default")alone. It now sets the lease for everyLockthat does not declare its ownGREL_LOCK_{NAME}_LEASE_DURATION. A twelve-lock service tunes one variable instead of twelve. An app that relied on the bare variable reaching only the default instance must move that value toGREL_LOCK_DEFAULT_..., or accept the wider reach. (#733)
Added
- ✨
micro.describe()returns a report of what the app is wired with: every component, its backend, the provider it borrows, and the checks that passed. Credential-like values are masked.python -m grelmicro check app:microrenders it and exits non-zero on a failing check, so CI can gate on the wiring. (#733) - ✨ A provider report names the kinds it declines, not only the ones it serves.
uses=[redis]leaving the outbox unwired was silently swallowed as aNotImplementedError, and is now the first thing the report shows. (#733) - ✨
micro.install(app)resolves the framework through a newgrelmicro.integrationsentry-point group instead of sniffing attributes. A third-party package can now ship an integration, and aFastAPIsubclass declared in your own package resolves correctly because the lookup walks the class's MRO. (#733) - ✨
micro.fake()swaps every backed component onto an in-process store for a block, so a test runs the real code paths against real primitives with no Redis and no Postgres. A fixture can now open the app you actually ship and fake only its backends. (#733) - ✨
micro.get(Cache)keeps the component type. Pass the class to resolve typed, the kind string to resolve a third-party component asAny.micro.get("cache")andmicro.<kind>are unchanged. (#733) - ✨ Every startup diagnostic carries a stable code, such as
backend-scope. The code trails the message, travels as adiagnosticfield on the log record, and links to a section in the new Diagnostics reference. Each warning also gets its own category (BackendScopeWarning,EnvLoadOffWarning, ...) underGrelmicroConfigWarning, so one diagnostic is silenced by category without matching message text and without silencing the rest. (#733)
Fixed
- 🐛 A bare backend matching two protocols resolved by the order of two
ifstatements.runtime_checkablecompares member names only, so everyCircuitBreakerBackendalso matchedRateLimiterBackend, and swapping the checks would have silently registered every breaker as a rate limiter. The most specific protocol now wins, and a backend matching two unrelated protocols raisesAmbiguousBackendError. (#733) - 🐛 A
TypeErrorraised inside a zero-argument__init__was reported as "needs constructor arguments", suggesting a fix that could not work. The arity check now reads the signature before calling, so the real error propagates untouched. (#733)
0.37.4 - 2026-08-14
Fixed
- 🐛 Drop the generic parameter from the
asyncpg.Connectionannotations in the Postgres outbox adapter.asyncpg.Connectionis not generic, sotyping.get_type_hintsonPostgresOutboxAdapterraisedTypeError: type 'Connection' is not subscriptable. Only deferred annotation evaluation kept it from raising at import. (#731)
Docs
- 📝 Let the demo publish a port other than 8000 with
DEMO_PORT.just demo-smokenow picks a free port on its own, andjust demorefuses to start when the port is taken. A local port-forward on 8000 used to answer the probes in the demo's place, because it binds the loopback address while the container runtime binds the wildcard, so both start and neither reports a conflict.
0.37.3 - 2026-08-14
Added
- ✨ Build the cache serializer from the type parameter.
TTLCache[User](ttl=300)serializes withPydanticSerializer(User), so the model is named once instead of twice.TTLCache()andTTLCache[bytes]()still store raw bytes, and so does a type parameter Pydantic cannot adapt. (#684) - ✨ Accept a type wherever a serializer is accepted.
micro.cache.ttl(ttl=300, serializer=User)andIdempotency("http", serializer=Response)build thePydanticSerializer, which is the way in for a factory that has no type parameter to read. (#684)
Changed
- ✨
Idempotency[Response]stores responses withPydanticSerializer(Response)and replays the model itself. It used to store JSON, which cannot even encode a Pydantic model, so the typed form raised on the first response it was given.Idempotency("http")without a type parameter still stores JSON. (#684)
Docs
- 📝 Return a typed value in every example. The README, the guides, the snippets, and the demo app returned
dict, which read as untyped scripting rather than a type-safe library. Each one now returns a Pydantic model, a plainstr, or anint, whichever is shortest for the point it makes. (#679)
0.37.2 - 2026-08-13
Changed
- 📝 Split the six longest guide pages so each one answers a single question. Cache, Idempotency, Coordination, Outbox, Logging, and Providers are now sections with an index page and one page per topic. The top-level URLs are unchanged. (#681)
- 📝 Move Redis connection settings off the cache page and onto Redis and Valkey. A pattern page says which backends work and links out. (#681)
- 📝 Move the logging benchmark table to Benchmarks, next to every other measurement. (#681)
Fixed
- 📝 Fail the docs build on a link whose anchor no longer exists.
mkdocs build --strictcaught a missing file but let a moved heading through. (#681) - 📝 Render the ten snippets that no page included, and delete five that nothing needed. A test now fails on a snippet no page renders. (#681)
0.37.1 - 2026-08-13
Added
- ✨ Add
ValkeyConfig, which accepts Valkey's own URL schemes.ValkeyProviderreadsvalkey://in the constructor and inVALKEY_URL, butfrom_configtook aRedisConfig, which refuses those schemes, so the one path that could not name the server was the config object.from_configstill takes aRedisConfig. (#718)
Fixed
- 🐛 Validate a URL passed to a provider exactly as one read from the environment.
RedisProvider("anything://host")handed the string to redis-py and failed with itsValueError, whileREDIS_URLwas checked against the provider's own URL type and raisedRedisProviderConfigError. Both paths now validate against one type, so they accept the same URLs and fail the same way, andPostgresProviderdoes too. A URL that a client library used to accept and the URL type refuses, such as a host-less authority, now raises at construction. (#718) - 🐛 Carry the Sentinel password through
ValkeyProvider.from_config. It was dropped, so a Valkey Sentinel built from a config connected to the Sentinel servers unauthenticated while the same config onRedisProviderauthenticated. (#718)
0.37.0 - 2026-08-11
Breaking
- 💥 Settle on Component as the one word for app-level wiring.
RateLimiterRegistrybecomesRateLimiterComponentandCircuitBreakerRegistrybecomesCircuitBreakerComponent. Neither ever registered anything: each wraps one backend, so the name borrowed a contract it did not honor. Updateuses=[...]and imports. (#682) - 💥
health_router(registry=...)is nowhealth_router(component=...), matchingmetrics_router(component=...). (#682)
Added
- ✨ Refuse to start when a backend cannot keep the promise its component makes. Declare the tier with
GREL_ENVIRONMENTorGrelmicro(environment=...), and inproductionorstagingaCoordinationorOutboxbound to a memory or SQLite backend raisesBackendScopeErrorbefore the first connection opens. A lock that excludes nothing the moment a second replica starts used to say nothing at all. (#683) - ✨ Add
scopeto every adapter andrequires=to every component that holds a backend. A backend provides a scope (process,hostorcluster), a component requires one, andCoordination(memory, requires="process")declares a single-process deployment instead of muting a check.RateLimiterComponent(redis, requires="cluster")reads the other way and fails the day someone points it at memory. (#683) - ✨ Report the same finding as a warning on two channels when no tier is declared, and stay silent in
developmentandtest. A value naming no tier, such aspreprod, warns and reads as undeclared, so a fleet with its own tier names keeps booting andprodutionis loud instead of silent. (#683) - ✨ Add
micro.check_backends(), which answers for production from a process that declares something else, so a test catches the wiring before a pod does. It raisesBackendScopeErrornaming every binding that does not hold. (#683) - ✨ Set the OpenTelemetry
deployment.environment.nameresource attribute from the declared tier, so one variable gates the check and names the environment in every trace. (#683) - ✨ Read Valkey's own URL schemes wherever a Redis scheme works.
valkey://,valkeys://,valkey+sentinel://andvalkey+cluster://are accepted byValkeyProviderin the constructor and inVALKEY_URLalike, so a deployment can name the server it runs. The URL keeps the scheme you wrote, so logs and errors name that server too.RedisProviderkeeps theredisschemes only. (#716)
Fixed
- 🐛 Register the read-write lock adapters under an entry-point group, like every other component kind. Without one,
readwritelockshort names resolved to nothing and a third-party adapter had nowhere to register. (#714) - 🐛 Add
MemoryProvider.outbox(). The memory outbox adapter ships and the capability matrix lists it, but the provider had no factory for it, soOutbox(MemoryProvider())raised while every other kind resolved. The SQL staging settings (table,auto_migrate,notify) are accepted and ignored, since messages live in a dict. (#714) - 🐛 Wrap a bare read-write lock or schedule backend into its Component.
uses=[RedisReadWriteLockAdapter()]registered no Component at all, so the backend was lifecycled, resolved by nothing, and the pattern failed on first use. Every coordination backend now wraps into the slot it belongs to. (#712) - 🐛 Wire the read-write lock from a bare Provider.
Grelmicro(uses=[redis])registered aCoordinationholding the lock, election and schedule backends and left the read-write lock unset, soReadWriteLockfailed on first use with a message telling you to pass the provider you had already passed. The default Component now wires every coordination backend, and one list drives the wiring, the Provider discovery and the backend scope check, so the next backend added reaches all three. (#710) - 🐛 Adopt a Provider that only a read-write lock backend borrows.
Grelmicrowalks aCoordinationto find the Providers its backends borrow, and the read-write lock was missing from that walk, soCoordination(rwlock=...)with a Provider left out ofuses=started clean and then raisedOutOfContextErroron first use. Pool sharing and open-ordering missed it the same way. (#707) - 🐛 Cover uvicorn's takeover on every logging backend.
stdlib,structlog, andloguruall hand uvicorn's own loggers the matching formatter, so one process emits one format whichever backend runs the app, and each is now tested. (#705) - 🐛 Read a record as a request only when it is one.
UvicornAccessFormattersplit any record carrying five or more positional arguments, so an application record reaching it through a shared handler was rendered as a request line and lost its message. It now splits a record that carries uvicorn's access message, or that comes from uvicorn's access logger, and formats anything else whole. (#705) - 🐛 Keep a log record readable after uvicorn's access formatter has seen it.
UvicornAccessFormattersplit the request fields by rewritingmsgandargson the record itself, so any record carrying five or more positional arguments reached every later reader as"%s %s %s": a second handler on the same logger, a queue listener, or a test readingcaplog. The split now runs on a copy. (#705)
Docs
- 📝 Say that a bare Provider registers every kind it serves except
outbox, which carries handlers and a relay and is built where those are declared. Four docstrings and the wiring guide claimed every kind. (#710) - 📝 Open every feature example on a real backend. First Steps, Cache, Idempotency, and Coordination all started on the memory provider with a note that it runs as-is, so the memory backend read as the normal choice. It is not: a distributed lock on memory gives no mutual exclusion the moment a second replica starts. Each page now starts on Redis and names the extra to install. First Steps adds the one command that runs it. (#680)
- 📝 Keep memory where it belongs and say why it is there. It stays on the testing page, in the backend tabs, in the provider reference, and in the landing example that is about a process-local rate limiter. The cache backend tabs led with Memory and now lead with Redis. (#680)
- 📝 Show the shortest correct wiring.
Grelmicro(uses=[redis])registers a Component for every kind the Provider serves, and a bare backend is wrapped for you, so the landing page, the providers guide, and the resilience snippets no longer name a Component to do what the Provider already does. The Component classes now appear only where they are needed: a second named instance andmicro.override(...). (#682) - 📝 Drop "Registry" from the mental model. First Steps offered "Component or Registry" as one bullet with two names, and the word lingered in the health, rate limiter, and architecture pages. (#682)
- 📝 Fix the
Componentprotocol docstring. It illustrated the protocol with aTasksclass carryingkind = "task", butTasksis a plain async context manager and no such kind exists.Grelmicro.getlisted that kind too. (#682) - 📝 Rewrite the roadmap as direction instead of a feature list. It was a list of named features under Next and Later, which is what the issue tracker already is, so it went stale the day anything shipped: it still offered the FastAPI
Idempotency-Keyintegration, the FastStream integration, and the transactional outbox as future work, all three of which ship. It now describes seven directions, names a few concretes under each as illustration, and points at the tracker once for the queue. Nothing is duplicated, so nothing falls out of sync. (#647) - 📝 Stop framing the roadmap around a 1.0 that is not on the calendar. It opened with "post-1.0 items" while the project runs on
0.x, and split into Next and Later, which read as release buckets without being any. Direction has no buckets, so both are gone. (#647) - 📝 Correct the rate limit header standard. The docs cited RFC 9211, which defines
Cache-Statusand has nothing to do with rate limits. The IETF fields are an Internet-Draft that now definesRateLimitandRateLimit-Policywithq,r, andtparameters, not theRateLimit-Limit/-Remaining/-Resetnames the Rate Limiter table showed. The table matches the draft and shows a real response. (#647) - 📝 Match the README module table to what ships. Resilience listed two patterns out of seven, Cache and Coordination did not name Valkey, Cache named an adapter class instead of its backends, and Client IP was missing. The "why" line now names idempotency and metrics too. (#647)
- 📝 Keep the first README example to one idea. It ended by naming a container and a registry in the section meant to prove how little grelmicro asks for. That sentence is now a link to the example that introduces them. (#647)
- 📝 Stop Shield contradicting the roadmap. Hedged requests were called "not on the roadmap" while the roadmap listed them, fleet-wide retry budgets and deadline propagation read as never rather than planned, and one line said "async-only in 1.0" on a project that ships
0.x. (#647) - 📝 Say once, in the documentation conventions, that the roadmap holds direction and the issue tracker holds the queue. It is not in the per-pull-request checklist, because a page you touch when direction changes is not a page you check on every change. (#647)
- 📝 Make the idempotency quick start actually run. It built a
Grelmicroapp and never installed it, so the handler raisedOutOfContextErroron the first request while the page said it runs as-is. It callsmicro.install(app)now. (#647) - 📝 Stop claiming
RateLimitResultcarries everything an IETF rate limit header needs. It carries the per-request values.RateLimit-Policydescribes the policy, so its window comes from the config you built the limiter with, and the Rate Limiter page now says where to read it. (#647) - 📝 Fix the stale links and lists a reader trips over: the capability matrix pointed at a closed roadmap issue, said Memory adapters take no Provider when
MemoryProviderships, and listed three Providers out of five. The architecture index omitted three of its own pages, the ConfigMap page omitted YAML and TOML, the task page never mentioned cron in its own summary, and the idempotency quick start still opened withCache(MemoryCacheAdapter()). (#647)
0.36.0 - 2026-08-09
Breaking
- 💥 Reject a timezone abbreviation that names no zone.
GREL_LOG_TIMEZONE=CESTused to validate and then fail at startup whenzoneinfocould not load it. Names such asCEST,PST,PDT,EDT,BST, andJSTare DST variants, not zones, and pinning one would freeze the offset year-round. Use the zone:Europe/Zurich, notCEST. Real zone names that look like abbreviations, such asCET,EET,GMT,EST,MST, andHST, keep working. (#645) - 💥 Remove
LogTimeZoneType. UseTimeZoneNamefromgrelmicro.types, which every component that takes a timezone now shares. (#645) - 💥 Starting
Taskstwice raisesTaskStartOperationErrorinstead ofTaskAddOperationError, whose message advised callingadd_taskearlier and did not describe the mistake. (#645) - 💥 A negative
Tasks(shutdown_timeout=...)raisesTaskSettingsValidationErrorinstead of a plainValueError, matching every other component. It still subclassesValueError. (#645)
Added
- ✨ Configure the task timezone once with
Tasks(timezone=...), instead of repeating it on every cron task. ATaskRoutertakes the timezone of theTasksthat includes it, in whatever order the wiring happens, andTaskRouter(timezone=...)gives one group of tasks a different clock. Nearest declaration wins: the task, then its router, then theTasks. A cron task now reports itstimezonefor introspection. (#645) - ✨ Add
GREL_TIMEZONE, one variable saying what wall clock the service runs on.TasksandLogboth read it, and a component variable still wins, soGREL_LOG_TIMEZONE=UTCkeeps logs on UTC under a service that schedules on local time. grelmicro ignores the POSIXTZvariable on purpose, sinceTZfalls back to UTC without complaint on a value it cannot parse. (#645) - ✨ Add
TasksConfigandTasks.from_config(...), so tasks configure like every other component.timezoneandshutdown_timeoutresolve fromGREL_TASK_*.Taskssupports live reconfiguration ofshutdown_timeout.timezoneis startup-only, and an attempt to change it from a mounted ConfigMap is reported rather than applied. (#645) - ✨ Log timestamps carry their UTC offset in the
TEXTandPRETTYformats, rendered asZfor UTC. Without it, a non-UTC log timezone made the repeated hour after a daylight saving transition read as though time ran backwards.JSONandLOGFMTalready carried the offset. (#645) - ✨ Add
ReadWriteLock, a distributed lock that lets every reader in at once and keeps writers alone.lock.readandlock.writeare two views of one lock, each withacquire,acquire_nowait,extend,release, and afrom_threadadapter. It is writer-preferring: a writer that finds readers in the way records an intent, so readers arriving after it wait and writers never starve. Every holder has its own lease, so a reader that died is reaped by the next acquire instead of blocking a writer until a shared expiry fires.ReadGuardandWriteGuardare distinct types, so a function that writes can demand the write guard in its signature, and reading a token from a spent guard raisesLockNotOwnedErrorinstead of handing back a stale one.WriteGuard.poisonedsays the previous writer's lease expired without a release, andawait guard.downgrade()turns a write lease into a read lease with no gap for another writer. Upgrading raisesLockUpgradeErrorrather than shipping a deadlock. Redis, Valkey, PostgreSQL, SQLite, Kubernetes, and Memory all ship an adapter and pass one shared conformance suite. (#686)
Fixed
- 🐛 Import
grelmicro.logon an image with no timezone database.pydantic-extra-typesread the whole timezone database while defining its type, so on a distroless or scratch image the import raisedImportErrorbefore any timezone was configured, and an app that never touched a timezone could not start. grelmicro now validates timezone names itself, and the defaultUTCneeds no timezone database at all. Any other name reports what to install. This also drops thepydantic-extra-typesdependency. (#645) - 🐛 Fire a cron task once when the clocks go back. A wall time the clock passes twice resolved to the second pass, which sits above the durable last-fire state, so a
30 2 * * *task claimed the fire again and ran a second time. An ambiguous time now always resolves to its first occurrence. (#645) - 🐛 Stop a cron task spinning through the repeated hour when the clocks go back. Inside that hour the next matching minute resolves to an instant already past, so the loop woke immediately and read the schedule backend again, for up to an hour on every worker. It now waits for the next minute instead. (#645)
0.35.2 - 2026-08-06
Fixed
- 🐛 Log the ignored-variable report, so it survives a JSON log stream. A
GREL_*variable set withoutGREL_ENV_LOADwas reported throughwarningsonly, which writes plain text to stderr, so in a pod the one line explaining whyGREL_LOG_LEVEL=DEBUGdid nothing was the one line the log collector could not parse. The report now also goes to thegrelmicrologger, which the default backend renders like every other record, with the name in avariablefield an alert can match. A component resolves its config before logging exists, so a report made then waits and goes out as soon as logging is configured.Logrestores the reporting state on exit along with the handlers it replaced, so a second lifecycle formats its own reports. TheGrelmicroConfigWarningchannel is unchanged. (#676)
Docs
- 📝 Add a Deployment guide, which says
GREL_ENV_LOAD=1out loud and puts it in the image rather than the manifest, where one copy always forgets it. Covers the log format and the probe noise, the probe endpoints, the shutdown window againstTasks(shutdown_timeout=...), and a Deployment manifest that applies as it stands. (#676) - 📝 Scope the resolution order to the
GREL_*namespace, in Configuration. Step 2 read as thoughGREL_ENV_LOADgated every environment variable, which no Provider has ever obeyed:RedisProvider()readsREDIS_URLwith no flag, since that name belongs to the deployment rather than to grelmicro, and a missing one fails at construction naming the variable it wanted instead of falling back to a default. Providers says the same where a reader of the env-driven recipe will see it. (#676)
0.35.1 - 2026-08-06
Upgrading
Uvicorn's own log lines change format. configure() now applies your format to uvicorn's loggers, so lines that used to look like this:
INFO: 127.0.0.1:54321 - "POST /orders HTTP/1.1" 200 OK
now match everything else your app emits, with a timestamp, a level field, and structured request fields. That is the point, but a pipeline parsing uvicorn's plain format needs updating, or the old behaviour back:
configure(uvicorn_enabled=False)
A misconfigured GREL_* variable now warns. Setting one without GREL_ENV_LOAD used to pass silently and now raises GrelmicroConfigWarning. A suite running -W error, or pytest with filterwarnings = error, will fail on it.
Fix the configuration, which is the point of the warning:
GREL_ENV_LOAD=1 # read GREL_* variables
or pass the value directly, which never needs the flag:
configure(format="PRETTY")
To keep the warning visible without failing a build, filter the category rather than the message:
filterwarnings = ["error", "ignore::grelmicro.GrelmicroConfigWarning"]
Features
- ✨ Configure the Sentinel password from the environment with
<prefix>SENTINEL_PASSWORD. Sentinel servers commonly run with their ownrequirepass, and the Bitnami Redis chart enables it by default, but nothing read that password so the Sentinel connections went unauthenticated while the data connections worked. OnlyRedisProvider.sentinel(...)carried it, and that factory takes host and port pairs rather than a URL, so an authenticated Sentinel could not be expressed as a URL at all. It applies only when set, never inferred from the data password, becauseAUTHagainst a server withoutrequirepassfails and would break every unauthenticated deployment. Set alongside a non-Sentinel scheme it warns rather than passing silently. Also available assentinel_password=on the constructor and onRedisConfig. (#661) - ✨ Make uvicorn's own logs match the application format, with no log config file. Uvicorn installs its own handlers and turns propagation off, so its lines never reached the handler
configure()sets up and one process emitted two formats, the uvicorn half carrying no timestamp, no level field and no trace context.configure()now reformats them. Its handlers are kept and only the formatter is replaced, so the stderr/stdout split survives and access lines keep their structured fields. Passuvicorn_enabled=False, or setGREL_LOG_UVICORN_ENABLED=false, when uvicorn's logging is configured elsewhere such as with--log-config. (#666) - ✨ Quiet health probe access logs with
ProbeFilter. Attach it to the access logger the same way asDuplicateFilterandRateLimitFilter. Kubernetes polls/livez,/readyzand/healthzevery few seconds forever, and the access log reported each one, so a healthy pod logged almost nothing else. Suppressing them took alogging.Filterthat reflected on the shape of uvicorn's access record. Only responses below400are dropped, so a readiness check that starts refusing traffic still appears. Paths match by suffix, sohealth_router(prefix=...)needs no configuration, andpaths=covers other polled endpoints. (#667)
Fixed
- 🐛 Keep the log line when a field cannot be serialized. An
extra={"url": httpx.URL(...)}raisedTypeErrorout of the formatter, so one unusual value destroyed the record and every field beside it. A value JSON has no representation for is now written as itsrepr, on both the stdlib and orjson paths. Elsewhere serialization still raises, because a cache value that cannot round-trip is a real error. (#666) - 🐛 Set
record.messagewhen formatting, aslogging.Formatterdoes. These formatters build their own mapping instead of calling up, so anything readingrecord.messageafterwards saw an attribute that was never set, including pytest'scaplogand any handler that formats a record twice. (#666) - 🐛 Open a Provider before the Component that borrows it, whatever order they are listed in. A Provider left out of
uses=was already discovered and inserted ahead of its Component, but one listed after it only got a warning and then failed on startup withOutOfContextError, so listing a Provider was worse than omitting it. Both cases are now reordered the same way:uses=says what the app is made of, and grelmicro opens it in dependency order.Grelmicro(strict=True)still raisesLifecycleOrderError, for callers who want the list they wrote to be the list that runs. (#665) - 🐛 Say so when a
GREL_*variable is set but not applied. Environment-driven configuration is opt-in behindGREL_ENV_LOAD, so a documented variable such asGREL_LOG_FORMATwas read by nobody and the default applied with nothing reported. It now raisesGrelmicroConfigWarningonce, naming the variable and the flag. It is its own category so it can be filtered precisely, without silencing everyUserWarningand without matching on message text, the way pytest shipsPytestConfigWarning. Only the exact names a config declares are matched, never the prefix, because Kubernetes injects{SVCNAME}_SERVICE_HOSTfor every Service and a prefix sweep would warn on every pod start. An explicitenv_load=Falseis a decision and stays silent. (#662)
Docs
- 📝 Teach how a value is resolved, in Configuration. Keyword arguments, environment behind
GREL_ENV_LOAD, and a file throughExternalConfig, with a local development recipe that does not need exported variables. Says plainly thatExternalConfigreconfigures live components and notLog, so log format in local development comes fromconfigure(...)or a loaded.env. (#662) - 📝 Say why orjson is not selected just because it is installed. The two serializers disagree on some payloads:
NaNandInfinitybecomenull, and a non-string dict key raises instead of being coerced. Auto-selecting on importability would let an unrelated dependency change what logs say, or turn a working log call into an exception. The choice stays explicit, and the reasoning is now written down. (#667) - 📝 Put the opt-in warning above every environment variable table, written once and included, so a reader who lands on a module page from a search engine sees it without following a link. The logging page also no longer claims every knob is an environment variable without saying when they are read. (#662)
0.35.0 - 2026-08-05
Upgrading
/healthz stopped sending null fields. A check that passed no longer carries error, and a check with no details no longer carries details.
-{"status": "ok", "critical": true, "error": null}
+{"status": "ok", "critical": true}
A consumer that reads error unconditionally needs to treat it as absent:
error = check.get("error") # None when the check passed
if error is not None:
alert(name, error)
A failing check still carries error, and status and critical are still on every entry, so a dashboard reading those needs no change.
A HealthChecks no longer removes your backends. Listing any Component used to switch provider auto-registration off entirely, so an app that added health checks lost its cache and locks with no warning. If you listed components explicitly only to work around that, the short form works now:
-micro = Grelmicro(uses=[
- Coordination(redis), Cache(redis), RateLimiterRegistry(redis),
- CircuitBreakerRegistry(redis), tasks, health,
-])
+micro = Grelmicro(uses=[redis, tasks, health])
Explicit components still win for their own kind, so mixed wiring keeps working untouched. Two or more providers still fill no defaults, so HealthChecks(auto_health=True) across several providers is unchanged.
Redis credentials split across two variables now work. REDIS_PASSWORD next to a REDIS_URL was read and then dropped, so the client connected unauthenticated. If you worked around that by building the provider from explicit settings, the plain form is enough again:
-provider = RedisProvider.sentinel(
- sentinels=[("host", 26379)], service_name="mymaster", password=settings.password
-)
+provider = RedisProvider()
REDIS_URL=redis+sentinel://a:26379,b:26379/mymaster/0
REDIS_PASSWORD=...
That URL is the second half: redis+sentinel:// and redis+cluster:// are now accepted from the environment and from RedisConfig, including the multi-host form, so the topology no longer has to be hard-coded to be expressible.
One combination newly raises instead of passing silently: a URL that already carries credentials and a separate REDIS_PASSWORD. Keep the password in one place. The same applies to VALKEY_*.
Breaking
- 💥 Back off per kind instead of disabling every provider default. Listing any Component used to turn provider auto-registration off entirely, so adding a
HealthCheckssilently removed the cache and the locks and the firstLock("cart")raised, naming the lock rather than the health registry that caused it. A Component now claims its own kind and the Provider fills the rest, which reads as one sentence: explicit wins, the Provider fills the rest. A Component of a kind no Provider serves (HealthChecks,Log,Trace) claims nothing and suppresses nothing. Two or more Providers still fill no defaults, since neither can be the default for a kind they both serve, soHealthChecks(auto_health=True)across several Providers is unchanged. (#655) - 💥 Leave
erroranddetailsout of a/healthzcheck that has neither. A passing check sent"error": nullon every poll, and with details enabled it sent"details": nulltoo, so the highest-frequency response in the service spent bytes reporting that nothing happened. A passing check is now{"status": "ok", "critical": true}, and a failing one still carries itserror. The OpenAPI schema types both fields as a plain string and object instead of promising a nullable value that never arrives. Read an absenterroras a pass. A consumer that required the key needs updating. (#649)
Features
- ✨ Skip a
Noneentry inGrelmicro(uses=[...])andBulkhead(uses=[...]). A component registered only for one backend now stays a plain expression,uses=[Log(), redis if backend == "redis" else None], instead of a star-unpacked conditional or a helper function.micro.use(None)still raises, because a single call can be guarded withif. (#646) - ✨ Export
Usable, the type of everythinguses=accepts. Building the list in a variable did not type-check, becauseComponentwas the only exported name and aProvideris not aComponent. Annotate itlist[Usable]and append either. (#646)
Fixed
- 🔒 Apply
REDIS_PASSWORDto aREDIS_URLthat carries no credentials. The password was read, validated and then dropped, so the client connected unauthenticated and the first command failed withNOAUTH, pointing at Redis rather than at the configuration. Host in a ConfigMap and password in a Secret is the shape the config docs recommend, and it was the one shape that did not work. A URL that already carries credentials plus a separate password now raises instead of silently preferring one, since the two can disagree. (#653) - 🐛 Accept
redis+sentinel://andredis+cluster://fromREDIS_URL,RedisConfig, andVALKEY_URL. The environment andfrom_configpaths validated against a stricter type than the constructor, so the topology that most needs environment configuration was the one that could not be expressed there. Multi-host authorities such asredis+sentinel://a:26379,b:26379/mymaster/0validate too. All three paths now share one URL type, so they cannot drift apart again. (#654) - 🐛 Restore the component registry when an
override(...)component fails to open. The registry was mutated one component at a time before the restore was armed, so a mock that raised on__aenter__stayed installed for the rest of theasync with micro:block. The next lookup resolved the broken mock instead of the real component, with nothing reporting it, which in a session-scoped fixture leaked into every later test. (#651) - 🐛 Instantiate a bare class passed to
Bulkhead(uses=[...]). The parameter documented the same shape asGrelmicro(uses=[...]), which accepts a class with no parens, but the bulkhead entered the class object itself and failed on startup. (#646) - 🐛 Reject
micro.use(None)with a message naming the fix. It appendedNoneto the item list and failed later inside the app lifecycle, pointing at nothing. (#646)
Docs
- 📝 Show how to register a component conditionally, in Wiring an App. Covers the inline
Noneentry, theUsable-annotated list, and how a Provider registers differently throughusethan insideuses=. (#646) - 📝 Add a Providers recipe for taking the managed connection and nothing else. Application state that is not a cache, a lock, or a rate limiter is still yours to read and write through
provider.client, with the lifecycle already handled. (#646) - 📝 Document the
/healthzreport body, with a passing and a failing check side by side. (#649) - 📝 Keep adapter classes out of the examples a first-time reader meets. The guide opened with
MemoryLeaderElectionAdapter()andCache(MemoryCacheAdapter())before the reader had any reason to know what an adapter is. Every quick start now names a provider once,uses=[MemoryProvider()]oruses=[redis], and the pattern follows with no wiring in sight. Adapter references in the snippets went from 56 to 8, and the 8 that remain are Kubernetes and the outbox memory backend, where choosing a backend is the subject. Nothing about the API changed, so no code needs updating. (#644)
0.34.3 - 2026-08-05
Security
- 🔒 Point client address identity checks at
forwardedinstead ofdegraded.degradedis False forUNTRUSTED_PEER, so one mistyped CIDR inTrustedProxiesleft every request carrying the proxy's own address, and the guard the docs recommended admitted it. The private network gate in the health docs then showed details to everyone, which is the bypassdegradedwas added to close.forwardedis True forRESOLVEDalone, so it refuses that request. The docstrings and the reason table now say which outcomes mean the peer is the caller and which mean the address is one of your own proxies. If nothing fronts your app,forwardedis never True and there is nothing to gate on, so read which check to use before copying the new guard into a direct deployment. (#636)
Features
- ✨ Log an untrusted peer that sends a non-empty
X-Forwarded-ForwhileTrustedProxiesis not empty. That combination is either a caller sending the header directly or a proxy of yours missing from the trusted set, and the misconfiguration had no other symptom. Thegrelmicro.clientiplogger gets one line per peer, for at most eight peers, so a busy proxy cannot flood it and a caller probing the header cannot take the line your own proxy needs. (#636) - ✨ Cache an async generator with
@cached. Iterating the decorated producer streams its items and stores the assembled list once it finishes, andcollect()reads that same entry whole, so a streaming endpoint and a buffered one share one producer, one key and one execution. Only a completed sequence is stored, so a reader that stops early and a producer that raises part way both leave the key untouched rather than publishing a truncated result. (#501)
Fixed
- 🐛 Report a truncated forwarded chain as
TOO_MANY_ENTRIES. The reason existed but was never returned. A header longer thanmax_entrieswhose read window held only trusted proxies came back asCHAIN_EXHAUSTED, which claims every entry was seen. (#636) - 🐛 Stop
@cachedhanging on a generator function. An async generator is not a coroutine function, so it took the sync wrapper, which blocks its own thread waiting on the cache loop. Decorating one wedged the event loop on the first call, with no error. Async generators are now supported, and a sync generator raises at decoration time, since it yields its items once and a cached one would replay as empty. (#501)
0.34.2 - 2026-08-02
Security
- 🔒 Refuse an idempotency key that cannot separate one caller from another. A
key_makerreading a value that was not set yet foldedNoneinto the key, so every caller shared one entry and could replay each other's stored response, while the request still answered200. A key that is partly missing does not fail, it merges, and the widening was invisible.IdempotencyMiddlewarenow raisesIdempotencyKeyMakerErrorwhen the key is empty, drops the client's key, or carries an unresolvedNone. - 🔒 Stop the multi-tenant
key_makerexample reading an unauthenticated header. It took the tenant fromX-Tenant, which the client sets, so a caller could name the tenant whose entry they read. It now folds in an authenticated identity, uses a separator an identity cannot contain, and raises rather than building a partial key. The docs also say plainly that a client address is not a tenant identity, because carrier-grade NAT puts many subscribers behind one.
Docs
- 📝 Say that a
key_makerreading the scope needs its source middleware outsideIdempotencyMiddleware.ClientAddressMiddlewareadded the wrong way round leavesclient_addressunset when the key is built, so the key folds inNone, every caller shares one entry, and the request still answers200. A key that looks like it separates callers and does not is worse than nokey_makerat all. - 📝 Warn that a mounted sub-application does not fail loudly. A mount is an ordinary call in the same task, so the host's request scope is still bound inside it. A sub-application that forgot
installtherefore resolves against the host's components rather than raising, and two applications that look isolated share one store with nothing reporting it.check_ambient_bindingcatches it, per app.
Internal
- 👷 Run the Python matrix in the release preflight.
just release-checktested only the primary Python, so 0.34.0 passed every check it ran and still failed its release on 3.14, which burned the version. The newjust test-matrixruns the unit and integration tiers on every other Python in the matrix, and reads that list out of the workflow so the preflight cannot drift away from what CI runs.
0.34.1 - 2026-08-02
Internal
- ✅ Stop the release matrix failing on tests that were racing their own lease. Two runs of the 0.34.0 release failed on Python 3.14, each on a different test. A leader election test tripped a 5s per-test timeout, and a lock test asserting
extend()keeps its fencing token got a fresh one instead, because the 10 ms lease had already lapsed andextendre-acquired. Neither was a product bug: 3.14 runs the modules about twice as slow as 3.12, on a runner already oversubscribed by-n auto. The affected tests now use the generous-lease fixture the file already had for this, and the timeout that only guards against hangs is generous enough to survive the matrix.
0.34.0 - 2026-08-02
Tagged but never published. The release run failed on the Python 3.14 matrix before the publish step, so this version does not exist on PyPI. Everything below ships in 0.34.1.
Breaking
- 💥 Refuse
@cachedon a method unless it names its key. The default key is therepr()of every argument, and on a method that includesself, which was wrong in both directions: two instances whoserepr()matched shared one entry, so a call on one returned the other's value, and an instance using the defaultrepr()carried a memory address, so its key changed on every restart. Neither said anything. Decorating a method withoutkey=orkey_maker=now raisesTypeErrorat decoration time. Pass a key naming what identifies the entry, such askey="repo:{user_id}". (#600)
Fixed
- 🐛 Keep the grelmicro request scope outside every other middleware.
IdempotencyMiddlewarehad to be added beforemicro.install(app), and the wrong order raised nothing at setup, so the first failure arrived in production from a client that actually sentIdempotency-Key.installnow places the binding middleware outermost when the stack is built, so either order works, and reads the placement back on startup so a stack that still ends up wrong raisesAmbientBindingErrorat boot. (#599) - 🐛 Start more than one worker against a fresh Postgres.
CREATE TABLE IF NOT EXISTSchecks and creates in two steps, so two workers starting together both passed the check and one crashed on the row type the table creates. Every Postgres adapter now installs its schema under an advisory lock, as the outbox already did. (#595) - 🐛 Give each worker of a pre-fork server its own coordination identity.
gunicorn --preloadbuilds the application once and forks, so every child inherited the identity generated in the parent. Two workers presented the same lock token, and every child read the leader record holder as itself, so all of them led at once. A child now appends its own random suffix.uvicorn --workers Nspawns instead of forking and is unaffected. (#595) - 🐛 Report a task fire that never ran.
grelmicro.task.runsonly counted fires that reached the body, so a schedule backend or a lock that stopped answering left no metric at all and looked exactly like a task with nothing due. A fire now always lands on the counter:coordination_errorwhen coordination failed,missedwhen no worker ran it, andskippedwhen a peer handled it. The bare total counts more than it did, so read the migration note if a chart treats it as the run rate. (#605) - 🐛 Warn when a cron fire is dropped for coming back too late. Past
misfire_grace_secondsthe fire was skipped with no log and no metric, so a task that never replayed said nothing at all. (#605) - 🐛 Record a fire that never reached the body on
last_fire. An introspection endpoint reading it during a coordination outage reported the previous successful fire and looked healthy. (#605)
Internal
- 👷 Add
justrecipes for the release path.just release-check <version>runs what the Release workflow runs, before the tag exists, so a failure costs nothing rather than burning an immutable tag.just verify-release <version>downloads a published wheel and sdist and verifies build provenance for each, which turns the SLSA Build Level 2 badge into something anyone can check.just release-notes <version>prints the changelog section the GitHub Release body should hold. (#584) - ✅ Pin both sides of the span exception check, so the coverage gate stops failing at random. Only one side had a test of its own. The other was covered whenever some unrelated test happened to raise inside a non-recording span, which depends on the order
pytest-randomlypicks, so a run could report_span.pyat 96% and fail--fail-under=100on a pull request that changed nothing near it. - 🧪 Verify the Patterns across real process boundaries. A new multiprocess tier races worker processes against Redis, so cross-process exclusion, single leadership, and the per-worker memory adapters are asserted rather than read off the code. The demo smoke stack now runs two uvicorn workers and checks the rate limit holds across both. (#595)
Docs
- 📝 Name the hazard
env_load=Falseguards against. Env reads fill every field the caller did not pass, so a config half taken from aSettingsobject silently gets the rest from the environment. ASettingsdefault that differs from the environment is dropped without a word. (#606) - 📝 Treat outbox retention as a decision the caller makes. A payload sits in the database until its row is deleted, so a single-use secret is at rest for as long as the row lives. The default deletes a delivered row, which is the safe end, but a default is not a guarantee. Pin
keep_deliveredrather than inherit it, and note that dead rows are never purged automatically. (#607) - 📝 Say that a stored idempotent response sits at rest for
ttl. The same audit: the middleware stores the whole response, sottlis a retention window and not only a replay window. (#607) - 📝 Correct the pre-fork guidance for coordination. It told the reader to pass an explicit
workeridentity, which every child inherits just the same, so the advice turned a likely collision into a certain one. (#595) - 📝 Say that
Bulkhead.max_concurrentandShield.max_rateare per worker process. Both read as a deployment-wide ceiling, so four workers quietly gave the dependency four times the configured number. (#595)
0.33.0 - 2026-07-31
Features
- ✨ Add
ClientAddress.degraded, which marks a result whose address is the connecting peer rather than the caller. Anything treating the address as an identity must refuse when it is set. (#609) - ✨ Add
grelmicro.clientip, which resolves the real client address behind a reverse proxy.X-Forwarded-Foris append-only, so its leftmost entry is attacker-controlled. The resolver reads the header only when the connecting peer is a trusted proxy, walks right to left, and returns the first entry no trusted proxy wrote. The trusted set is required and there is no wildcard. (#609)
Security
- 🔒 Refuse to show health details when the client address is a fallback. Resolving alone was not enough: a forged chain that could not be believed still returned the proxy's own private address, so the
is_privatecheck admitted everyone again.ClientAddress.degradedmarks every such case. (#609) - 🔒 Stop the health-detail example from showing details to everyone behind a proxy. It gated on
request.client.hostbeing private, which is the proxy's own address for every external caller, sois_privatewas true for all of them. It now resolves the client. The rate limiter example keyed on the same value, giving every caller one shared bucket. (#609)
Internal
- 👷 Enforce the coverage total on the pull request that changes code, not in the next nightly. The slow and integration tiers now run on a code-touching pull request or push, on the primary Python only, so the combined 100% total is measurable there. The Python matrix and the demo tier stay on the nightly, dispatch, and release paths. About two minutes per pull request. (#602)
- 👷 Stop a Codecov upload from failing CI. The test-results action crashed on a transient network error, which fails the step whatever
fail_ci_if_errorsays, so a green test run with a passing coverage gate was reported as a failure. Uploads are telemetry and now cannot gate a build. (#602)
Docs
- 📝 Write down the pre-1.0 deprecation policy. A rename before 1.0 is a clean cut, with the reasoning recorded so the question does not get re-litigated per rename. (#613)
- 📝 Add a migration page, one note per minor from 0.30 onward, listing only what an upgrade requires. It leads with a symptom table, so an adopter several versions behind can match the error they see instead of reconstructing the path from every release's notes. (#608)
0.32.9 - 2026-07-30
Fixed
- 🐛 Report a failed background cache refresh. The task's exception was discarded, so a permanently failing recompute silently degraded every hot key back to a cold miss. It now logs a warning naming the key and records
grelmicro.cache.early_refresheswithoutcomeanderror.type. (#605) - 🐛 Hold a strong reference to a background cache refresh task. The event loop keeps only weak references, so the task could be collected before finishing and would then report nothing at all. (#605)
- 🐛 Report a failed
Shieldcache write. It was logged at debug with no counter, so the copy the shield serves when the primary fails could stop being written and nothing said so until the incident it exists for. (#605) - 🐛 Rate-limit the
Shieldcache warning to once a minute per shield, and report a failing cache read as well as a write. A cache write rides along with every successful call, so an unreachable store would otherwise log once per request. The counter still records every failure. (#605) - 🐛 Remove the Postgres outbox termination listener before releasing the connection. asyncpg calls it on any close, so a clean shutdown warned about a lost listener, and a shared pool could warn again when it later recycled that connection. (#605)
- 🐛 Back off when an outbox backend's
wait_notifyfails instantly. The relay returned with no delay and spun its claim query, one warning and one query per iteration. (#605) - 🐛 Report a lost Postgres outbox listener connection. Delivery silently fell back to polling, bounded by
poll_interval, until the process restarted. (#605) - 🐛 Report a crashed outbox relay or purge loop when it crashes.
asyncio.waitnever re-raises, so a crash stopped delivery for the life of the process, and reporting it only at shutdown would have arrived long after it mattered. Relay wait errors moved from debug to warning. (#605)
Docs
- 📝 State the background-failure contract: work with no caller to raise into always becomes observable through a counter, a warning, or a health degradation, never a silent suppression. (#605)
0.32.8 - 2026-07-30
Internal
- 👷 Enforce the 100% coverage claim in CI. Every tier reset coverage instead of accumulating, so CI only ever measured the unit tier and no
fail-undergate ran there at all. The claim was checked only by a local hook that pre-commit.ci skips. The slow and integration tiers now append, and the full path fails under 100%. (#602) - 👷 Make Codecov's project status advisory. It compared a pull request's unit-only coverage against a base built from the full tier, so it reported a regression that was a tier mismatch rather than a real one. (#602)
0.32.7 - 2026-07-30
Features
- ✨ Add
refresh()to a@cachedfunction. It recomputes for the given arguments, overwrites the stored entry, and returns the new value, so an endpoint honouringCache-Control: no-cachekeeps the decorator's key handling and tag invalidation. Concurrent refreshes each recompute rather than folding, and an error propagates instead of serving stale. (#500) - ✨ Add
IdempotencyMiddleware. A request carrying anIdempotency-Keyheader runs once, and a retry replays the stored response without reaching the handler. Pure ASGI, so it works on FastAPI, Starlette, and Litestar alike. (#503) - ✨ Bound the single-flight wait with
wait_timeout=on anIdempotencyblock and onrun(). A duplicate that waits longer than that raisesIdempotencyWaitTimeoutError, which subclassesTimeoutError, instead of holding the caller indefinitely. (#503) - ✨ Add
document_idempotency(app), which describes the installedIdempotencyMiddlewarein the OpenAPI schema. A middleware is invisible to the generated schema, so a client built from it never learns the header exists. (#503)
Fixed
- 🐛 Accept a SQLAlchemy-style Postgres URL.
PostgresProvidertookpostgresql+asyncpg://without complaint and then failed at connect time, so every adopter stripped the driver suffix by hand. The suffix is now dropped when the URL is resolved, from a keyword, the environment, or a config, whatever the scheme's case. (#596) - 🐛 Type the helpers a
@cachedfunction exposes.cached()returned a plainCallable, socache_info()andcache_clear()were documented but invisible to type checkers, and calling them failed a downstreamtyormypyrun. It now returnsCachedFunction. (#500) - 🐛 Release the single-flight lock correctly when an
Idempotencyblock is cancelled while acquiring it. The lock was bound to the block before it was held, so the cleanup path tried to release a lock the block did not own and raisedLockNotOwnedErrorover the original error. (#503) - 🐛 Release the in-process idempotency lock even when the distributed release is cancelled mid-flight. A cancellation there left the key locked for the life of the process. (#503)
Internal
- 🚨 Satisfy the stricter type narrowing in
ty0.0.62. Two existing call sites lost a type parameter throughisinstance, which failed the lint gate on the dependency bump rather than in any user-visible way. (#598)
Docs
- 📝 Document how to report a bug: where to file, what a report needs, and what happens after you file it. (#592)
- 📝 Add GitHub issue forms for bug reports and feature requests, so a report arrives with the version, the backend, and a runnable reproduction. (#592)
- 📝 Add the OpenSSF Best Practices badge, now passing at 100%. (#592)
0.32.6 - 2026-07-29
Fixed
- 🐛 Take the state lifetime off the in-memory circuit breaker's admission path. Every call recomputed the lifetime and read the clock, which made
try_acquire2.4x slower from 0.32.2 on. Entries now carry an absolute deadline, and a closed circuit admits from one dictionary lookup. (#582)
Docs
- 📝 Lead the README with one sentence that says what grelmicro is, and add the SLSA Build Level 2 badge. (#581)
0.32.5 - 2026-07-28
Security
- 🔒 Attest build provenance for every release. Each published artifact now carries a provenance attestation signed on GitHub infrastructure separate from the build job, and the release verifies it before publishing, so a missing or invalid attestation fails the release. (#575)
Docs
- 📝 Move the documentation site to grelmicro.grel.info. The old GitHub Pages address redirects, so existing links keep working. (#577)
- 📝 Add a root
CHANGELOG.mdpointing to the published changelog, so tools that look for one at the repository root find it. (#576)
0.32.4 - 2026-07-28
Docs
- 📝 Document the recommended
CircuitBreakerlifecycle. Build one per name at module level. The circuit lives in the backend keyed by name, butlast_error, the call totals, and the cached state are per instance, so a per-request breaker reports empty metrics and logs a transition that never happened. (#497) - 📝 Correct the cross-replica story for cron tasks. The task page said at-most-once always needs a
TaskLockorLeaderElection, which is true foreveryand false forcron. Cron claims each fire against the schedule backend, so a wiredCoordinationcomponent is all it needs. (#502) - 📝 Warn against gating a cron body on leadership. Winning the claim advances the durable state before the body runs, so an early return consumes the fire without doing the work. (#502)
- 📝 Document what the
autotrace exporter selects. It resolves to OTLP HTTP or to the no-op and never to gRPC, whatever the endpoint URL or the installed exporter packages. (#498)
0.32.3 - 2026-07-28
Fixed
- 🐛 Bound the cache cleanup sweep. It deleted every expired row in one statement, so a large backlog held one long delete against the table. Each pass now takes at most 1000 rows and the interval is jittered, so replicas do not sweep in lockstep. (#496)
- 🐛 Log cache cleanup failures instead of swallowing them. A failing sweep was silently suppressed, so a cache that stopped reclaiming disk gave no signal. (#496)
0.32.2 - 2026-07-28
Features
- ✨ Add
CircuitBreaker.keyed(key)to give each tenant, endpoint, or model its own circuit, with independent counters, state, and cool-down. (#496) - ✨ Circuit breakers now reclaim their stored state instead of keeping it forever, so a dynamic key set no longer grows the backend without bound. Redis expires the key, Postgres and SQLite sweep hourly via
cleanup_interval=. (#496)
Upgrading
Circuit-breaker rows written before this release carry no activity timestamp, so an already-open circuit on Postgres or SQLite reads as expired the first time the new code touches it and starts again from CLOSED. This happens once, on the first call after the upgrade. Circuits held open by isolate() are unaffected.
0.32.1 - 2026-07-28
Re-cut of 0.32.0, which never reached PyPI. A flaky test failed the release run, so publishing was skipped. The 0.32.0 tag is immutable, so the same contents ship here. See 0.32.0 for the changes.
Internal
- ✅ Stop
test_lock_acquire_nowait_would_blockracing its own lease. The test asserts that a second worker is blocked, but held the lock on a 10 ms lease, so a loaded runner could let the lease lapse before the second worker tried. It then acquired cleanly andWouldBlocknever fired, which failed the 0.32.0 release on Python 3.14. Contention tests now use a lease that outlives scheduling jitter, matching the from-thread twin.
0.32.0 - 2026-07-28
Breaking
- 💥 Credential-carrying URL fields are now
SecretUrl:urlonPostgresConfigandRedisConfig, andendpointonTraceConfigandMetricsConfig. Eachheadersvalue onTraceConfigandMetricsConfigis now aSecretStr. Passing a plain string still works, but reading the value back needs.get_secret_value(). (#550) - 💥
SQLiteLockAdapterandSQLiteScheduleAdapternow takeprovider=instead ofpath=, like every other SQLite adapter. ReplaceSQLiteLockAdapter("app.db")withSQLiteLockAdapter(provider=SQLiteProvider("app.db")), or pass the provider toCoordination(sqlite)and let it build both. A missing path now raisesSettingsValidationErrorinstead ofCoordinationSettingsValidationError. (#546)
Features
- ✨ Add
grelmicro.types.SecretUrl, a URL that never shows its credentials. It displays the URL with the userinfo password and credential-like query values replaced by***, so the scheme, host, and path stay readable in logs. Parametrize it with any pydantic URL type to keep that type's validation:SecretUrl[RedisDsn],SecretUrl[PostgresDsn], or a bareSecretUrlfor any URL. (#550)
Fixed
- 🐛 Capture the running event loop in
PostgresLockAdapterandPostgresScheduleAdapter. Both protocols require a_loopattribute, but neither adapter set it, soLock.from_threadandTaskLock.from_threadraisedAttributeErroragainst a Postgres backend instead of working. Every other backend already captured it. (#541) - 🐛 Share one SQLite connection across every component on the same file.
SQLiteLockAdapterandSQLiteScheduleAdapteropened their own connection, so an app pairing a lock with a cache held two. They now borrow the provider's connection and shared lock, soGrelmicrocan dedupe them onto one provider like every other adapter. (#546) - 🐛 Adopt the provider behind a
Coordinationschedule backend. Provider discovery walked the lock and election backends only, so a schedule-onlyCoordinationleft its provider unopened and duplicate providers undeduped. (#546)
Security
- 🔒 Mask credentials embedded in connection URLs.
urlonPostgresConfigandRedisConfig, andendpointandheadersonTraceConfigandMetricsConfig, appeared in full inrepr(),model_dump(), andmodel_dump_json(). Nothing changes on the wire. (#550) - 🔒 Stop echoing rejected values from
PostgresConfig,RedisConfig,TraceConfig, andMetricsConfig. A mistyped URL carried its password into theValidationErrortext. (#550)
Internal
- ✅ Add
tests/test_adapter_contracts.py, which asserts every first-party adapter initializes_loopand captures the running loop on__aenter__. AProtocolattribute annotation declares the requirement but never creates it, so both type checkers pass an adapter that omits it. (#541) - 👷 Clear 16 modules from the mypy override ladder, leaving 3. The
uses=resolver, the optional-import rebinding, and thefunctools.wrapsreturns now type-check under both checkers. (#541) - 🔥 Drop a stale
# type: ignoreingrelmicro/metrics/_component.py. grelmicro suppresses with# ty: ignoreonly. (#541) - ⬆️ Bump
ruffto 0.16. Markdown formatting is now stable, so the formatter skips*.mdand leaves the README and docs examples written as they read best. The newCPY001rule stays off: the MIT licence lives inLICENSE, not in a per-file header. (#557) - 👷 Pin the
ty-checkpre-commit hook toTY_MAX_PARALLELISM=1, matching CI. ty resolves inference cycles in whichever order threads reach them, so a local run could flag a diagnostic that CI did not. (#551) - 📝 List each Provider once in the SQLite and bulkhead examples. A Component that borrows a Provider already adopts its lifecycle, so the bare Provider beside it was redundant. The Redis and Postgres examples were already written this way. (#559)
0.31.0 - 2026-07-27
Breaking
- 💥 Default
Metrics()to theautoexporter. It exports over OTLP HTTP when an endpoint is configured and otherwise auto-disables into a true no-op, so an unconfiguredMetrics()no longer falls back tolocalhost:4318. Register it unconditionally: an auto-disabledMetricsinstalls no provider and never conflicts with a second app. (#508) - 💥 Credential fields are now
SecretStr:basic_auth_passwordonTraceConfigandMetricsConfig, andpasswordonPostgresConfigandRedisConfig. Passing a plain string still works, but reading the value back needs.get_secret_value(). (#549)
Features
- ✨ Add
basic_auth=(username, password)toMetrics, matchingTrace. grelmicro builds theAuthorization: Basicheader and attaches it to the OTLP exporter directly, bypassing the fragileOTEL_EXPORTER_OTLP_HEADERSencoding. From the environment, setGREL_METRICS_BASIC_AUTH_USERNAMEandGREL_METRICS_BASIC_AUTH_PASSWORD. (#507)
Fixed
- 🏷️ Preserve the wrapped function's signature through the resilience decorators. Applying
Retry,Shield,Bulkhead,Timeout,CircuitBreaker, orFallbackno longer erases the parameter and return types, so calls to a decorated function stay type-checked. (#545) - 🐛 Declare
_looponLockBackend,ScheduleBackend,CacheBackend, andCircuitBreakerBackend. The attribute was already required in prose, so a third-party adapter that omitted it type-checked and then raisedAttributeErroron the firstfrom_threadcall. (#540) - 🐛 Raise a clear error when
Lock.from_threadorTaskLock.from_threadruns before the backend is opened, matching the cache and circuit-breaker behavior. (#540) - 🐛 Point the circuit-breaker worker-thread error at
async with micro:instead ofgrelmicro.lifespan(), which is not a public API. (#540) - 🐛 Raise a clear error when installing the FastStream ambient middleware on an app with no broker, instead of an
AttributeError. (#540)
Security
- 🔒 Mask credentials in config objects.
basic_auth_passwordonTraceConfigandMetricsConfig, andpasswordonPostgresConfigandRedisConfig, were plainstrand so appeared inrepr(),model_dump(), andmodel_dump_json(). All four are nowSecretStr. Nothing changes on the wire. (#549)
Internal
- 🐛 Set
strictdirectly onLogTimeZoneTypeinstead of using@timezone_name_settings. The decorator's return type references the class it decorates, sotyresolved the subclass differently between parallel runs and failed about 9 runs in 10. Runtime behavior is unchanged. (#549) - 📝 Document the
_loopcapture contract in the third-party adapter guide. The protocols require it, but the guide did not mention it, so a new adapter could follow the docs and still fail on the firstfrom_threadcall. (#549) - ✅ Widen the circuit-breaker cool-down margins in the SQLite, Postgres, and Redis backend tests. The rejection assert now uses a 60s cool-down so a stalled runner cannot let the window elapse between two adjacent calls, and the elapse asserts wait 5x the cool-down instead of racing a 0.05s gap. (#548)
- 👷 Enable the Pydantic mypy plugin and shrink the mypy override ladder from 29 modules to 19. Ten modules now type-check under both checkers. (#547)
- ♻️ Declare
arbitrary_types_allowedin the_BaseShieldConfigclass kwargs instead of a secondmodel_configassignment. Pydantic merged both, so the settings are unchanged. (#547) - 🔥 Drop the inert mypy
# type: ignorecomments. grelmicro type-checks with ty, which never read them, andty checkstays clean without them. (#539) - ✅ Add
tests/typechecking/, a suite ofassert_typeclaims on the public API, checked by both ty and mypy. grelmicro shipspy.typed, so these annotations are part of the contract. (#544) - 👷 Run mypy in CI alongside ty. The 30 modules that do not pass yet are listed in
[[tool.mypy.overrides]]and tracked in #541. (#544) - 🔥 Delete
grelmicro/metrics/_otel.py, which nothing imported. (#544) - ♻️ Return
OTel | Nonefrom the private trace resolver so the handles narrow together, rather than a tuple of independently optional fields. (#540)
0.30.1 - 2026-07-18
Fixed
- 🐛 Use
inspect.iscoroutinefunctionin@cached, so grelmicro runs clean on Python 3.14, whereasyncio.iscoroutinefunctionis deprecated. (#532)
0.30.0 - 2026-07-18
Breaking
- 💥 Replace the idempotency
Operation.responseattribute with anOperation.result()method typed as the stored type, so the replay branch returns it without a cast. It is valid only on a replay: calling it on a first execution raises the newIdempotencyStateError. (#504)
Fixed
- 🏷️ Preserve the decorated function's type through
@health.check, so awaiting an async check directly type-checks without# type: ignore. (#499)
Internal
- ♻️ Use the standard library
uuid.uuid7()on Python 3.14+, so outbox ids stay monotonic within a millisecond. The vendored generator stays as the fallback for 3.12 and 3.13. (#522) - ✅ Treat warnings as errors in the test suite and close the FastAPI health test client cleanly. (#526)
- ⬆️ Adopt
httpx2in the test suite so Starlette'sTestClientstops warning about httpx v1. (#527)
0.29.5 - 2026-07-18
Security
- 🔒 Add a security policy with private vulnerability reporting. (#523)
Docs
- 📝 Add a Contributing section to the README linking issues and the contributing guide. (#523)
- 📝 Add an
llms.txtdocumentation index for LLM-friendly discovery. (#524)
Internal
- 👷 Pin the demo Docker image by digest and track it with Dependabot. (#523)
0.29.4 - 2026-07-18
Internal
- ⬆️ Bump the Python dependency group (including
redis8.0.1,pytest,ruff, andty0.0.58), the GitHub Actions, and the pre-commit hooks. (#514, #510, #488) - 🚨 Adapt to
ty0.0.58: type theComponentprotocol'snameas a read-only property and trim stalety: ignoredirectives.
Docs
- 📝 List the transactional outbox among the modules in the README intro.
0.29.3 - 2026-07-18
Features
- ✨ Read the Postgres database name from
POSTGRES_DATABASEtoo, not onlyPOSTGRES_DB, so the longer spelling works from the environment.DBstill wins when both are set. (#518)
0.29.2 - 2026-07-18
Features
- ✨ Let the outbox auto-purge delivered rows.
keep_deliverednow accepts atimedelta: the relay keeps delivered rows for that window and purges them in the background, so retention needs no scheduled job.Truestill keeps them for good andFalsestill deletes on delivery. - ✨ Add
Outbox.current()to resolve the app-registered outbox, so a producer canpublishwithout holding the instance or a config-bound singleton. (#517) - ✨ Add
PostgresOutboxAdapter.create_table_sql()anddrop_table_sql(), the exact DDLauto_migrateruns, so Alembic and other migration tools own the outbox schema withauto_migrate=False.
Docs
- 📝 List the outbox in the README module table and align the outbox guide with the other module docs.
0.29.1 - 2026-07-18
Features
- ✨ Add
command_timeouttoPostgresProvider(kwarg orPOSTGRES_COMMAND_TIMEOUT) so a query against a frozen or unreachable Postgres raisesTimeoutErrorin bounded time instead of hanging until the OS TCP timeout. - ✨ Add the
outboxmodule: a PostgreSQL transactional outbox that runs any async handler exactly after your transaction commits, at least once.publishstages a message in your own asyncpg, SQLAlchemy, or SQLModel transaction, and a relay delivers it withFOR UPDATE SKIP LOCKED,NOTIFYwakeups, a visibility lease, retries with backoff, and dead-lettering. Trace context and delivery metrics ride the trace and metrics components, andpurgetrims delivered and dead rows. Backend-first, so SQLite and MySQL can follow.
0.28.2 - 2026-07-05
Fixed
- 🐛 Make idempotency storage atomic. The fingerprint guard is now written before the response and outlives it, so a failed guard write can never leave a response that a different payload could replay. (#494)
- 🐛 Guard the process-global active-app registry with a lock so two apps starting concurrently cannot both enter and clobber each other's
Log/Trace/Metricsstate. The second raisesMultipleActiveAppsError. (#494) - 🐛 Roll back an opened
Grelmicroapp when a later FastStream startup hook fails, so a failed startup no longer leaves the app open and registered. (#494) - 🐛 Export
SQLiteCircuitBreakerAdapterfromgrelmicro.resilience, matching the other circuit breaker adapters. (#494)
Security
- 🔒 Make the
TaskLocktoken nonce unpredictable (a process-local counter joined with random bytes) so an untrusted in-process caller cannot forge another handle's ownership token. (#494)
Docs
- 📝 Point every ambient-miss
OutOfContextErroratmicro.install(app), and switch the README and first-steps examples to the one-callmicro.install(app)form. (#494) - 📝 Add a first-use mental model, an operator defaults reference, an API conventions page, an adapter import policy, and decision tables for rate limiter methods and task entry points. (#494)
- 📝 Warn that
/healthzalways returns each check'serrorstring, and that cache keys and tags derived from untrusted input must stay bounded. (#494)
0.28.1 - 2026-07-05
Features
- ✨ Make
Tracea true no-op when the exporter auto-disables. With the defaultautoexporter and no endpoint,Traceinstalls no tracer provider, leaves the global untouched, runs no auto-instrumentation, and no longer counts against the single-active-app guard, soTrace()is safe to register unconditionally in dev, test, and CI. An explicitexporter=nonestill installs the provider. (#487)
Fixed
- 🐛 Block a second app that installs
Metricswhile one is active, matchingLogandTrace.Metricsowns the process-global meter provider, so two overlapping apps would clobber it.
Docs
- 📝 Refresh stale docs: the optional-extras table, the capability matrix, the module lists, the
@cachedlockdefault, and theDuplicateFilterttlfield.
0.28.0 - 2026-06-28
Breaking
- 💥 Rename the recurring-task decorator from
@task.interval(seconds=...)to@task.every(seconds=...), pairing it with@task.cron(...)as a verb-form family. Theseconds=keyword is unchanged. Update your call sites. - 💥 Move the framework integration modules into
grelmicro.integrations.grelmicro.fastapibecomesgrelmicro.integrations.fastapi, soGrelmicroMiddlewareis nowfrom grelmicro.integrations.fastapi import GrelmicroMiddleware, and the new FastStream wiring lives atgrelmicro.integrations.faststream. - 💥 Move the FastAPI health router from
grelmicro.health.fastapitogrelmicro.integrations.fastapi, so all FastAPI integration code (middleware, install, health router) lives undergrelmicro.integrations. Updatefrom grelmicro.health.fastapi import health_routertofrom grelmicro.integrations.fastapi import health_router. - 💥 Collapse the four
@task.everylock passthroughs into one typedlock=TaskLock(...). Thelease_duration,min_hold_duration,backend, andworkerparameters are removed. Pass aTaskLockinstead, like@task.every(seconds=60, lock=TaskLock(lease_duration=300)). The lock keeps its default"default"name and is re-stamped to the task name, so you never repeat it. The lock's settings are authoritative.leader=andsync=stay separate, self-documenting parameters. - 💥
HealthChecksnow namespaces its env vars per instance: the default instance keepsGREL_HEALTH_*, but a named instance readsGREL_HEALTH_{NAME_UPPER}_*(matchingLock,CircuitBreaker, and the other named components). Update env vars for any namedHealthChecks. - 💥 The log filters now namespace env vars per instance.
GREL_DUPLICATE_FILTER_*becomesGREL_DUPLICATEFILTER_*andGREL_RATE_LIMIT_FILTER_*becomesGREL_RATELIMITFILTER_*, with a newenv_name=kwarg for a named instance (GREL_DUPLICATEFILTER_{NAME}_*).DuplicateFilter.key_modealso gainslogger,level, andglobalso both filters share one vocabulary. Update env vars andenv_prefix=overrides. - 💥 Replace the six manual circuit-breaker control methods with two operator verbs.
isolate()forces the breaker open until reset,reset()returns it to normal automatic operation startingCLOSED. Replacetransition_to_forced_open()withisolate()andrestart()withreset(). The remainingtransition_to_closed,transition_to_open,transition_to_half_open, andtransition_to_forced_closedare removed. - 💥
CircuitBreakerMetricsandErrorDetailsare now frozen slotted dataclasses instead of Pydantic models. Attribute access is unchanged, but they no longer offer.model_dump()or Pydantic validation. This matchesCircuitBreakerSnapshotandCacheInfo(read-models are dataclasses, Pydantic is reserved for serialization boundaries). - 💥
@cachednow folds concurrent misses of the same key in-process by default (lock="local"instead oflock=False). This removes a silent thundering-herd footgun at no I/O cost. Passlock=Falseto restore the old behavior where every concurrent miss recomputes. - 💥 Move the backend protocols out of the public
abcsubmodules into private_protocolmodules (clock,config,coordination,task), matchingcacheandresilience.VirtualClocklikewise moves toclock/_virtual.py. The protocols stay exported from each package, so import them from the package (from grelmicro.coordination import LockBackend) instead ofgrelmicro.coordination.abc. - 💥
reconfigure()now raisesCoordinationSettingsValidationError(aSettingsValidationError, still aValueErrorsubclass) instead of a bareValueErrorwhen a new config would change the immutableworker. CatchSettingsValidationErrororGrelmicroErrorto handle it. - 💥 Rename the
ExternalConfigintervalparameter toreload_interval, tying the knob to thereload()verb it controls. UpdateExternalConfig(interval=...)toreload_interval=. - 💥 Rename the log dedup
ttl_secondsfield tottl, matching the bare-noun duration convention used everywhere else (the cachettl, lock durations). UpdateDuplicateFilter(ttl_seconds=...)andDuplicateFilterConfigtottl=. - 💥 Rename the
Tracecomponent symbols to theTracestem so they match the component name.TracingConfig,TracingError,TracingExporterType,TracingProcessorType,TracingSamplerType, andTracingSettingsValidationErrorbecomeTraceConfig,TraceError,TraceExporterType,TraceProcessorType,TraceSamplerType, andTraceSettingsValidationError. Update imports. - 💥 Rename the
Logcomponent symbols to theLogstem so they match the component name.LoggingConfig,LoggingError,LoggingBackendType,LoggingFormatType,LoggingLevelType,LoggingSerializerType,LoggingTimeZoneType, andLoggingSettingsValidationErrorbecomeLogConfig,LogError,LogBackendType,LogFormatType,LogLevelType,LogSerializerType,LogTimeZoneType, andLogSettingsValidationError. Update imports. - 💥 Rename the
TaskLocklease boundaries to lease-anchored names, matchingLockConfigand the KubernetesLeaseDuration.max_lock_secondsbecomeslease_durationandmin_lock_secondsbecomesmin_hold_duration. This covers theTaskLockConfigfields and theTaskLockconstructor. UpdateTaskLock(max_lock_seconds=..., min_lock_seconds=...)tolease_duration=..., min_hold_duration=...and the env varsGREL_TASKLOCK_{NAME_UPPER}_MAX_LOCK_SECONDSand_MIN_LOCK_SECONDSto_LEASE_DURATIONand_MIN_HOLD_DURATION. - 💥 Rename the concrete leader election adapters to the
*Adaptersuffix every other pattern already uses.MemoryLeaderElectionBackend,RedisLeaderElectionBackend,PostgresLeaderElectionBackend, andKubernetesLeaderElectionBackendbecomeMemoryLeaderElectionAdapter,RedisLeaderElectionAdapter,PostgresLeaderElectionAdapter, andKubernetesLeaderElectionAdapter. TheLeaderElectionBackendprotocol keeps its name (protocol stays*Backend, concrete stays*Adapter). Update direct imports and constructions. - 💥 Rename the resilience component wrappers to the singular
*Registryform, matching their singularkindand theCoordinationandCachesiblings.RateLimitersbecomesRateLimiterRegistryandCircuitBreakersbecomesCircuitBreakerRegistry. Updateuses=[...]and imports. - 💥 Drop the redundant
DEFAULTsegment from the default instance env prefix. A default instance (Lock("default"),Retry.exponential("default"), and the like) now reads the bareGREL_{COMPONENT}_{FIELD}instead ofGREL_{COMPONENT}_DEFAULT_{FIELD}. Rename env vars likeGREL_LOCK_DEFAULT_LEASE_DURATIONtoGREL_LOCK_LEASE_DURATION. Named instances are unchanged. The default instance now owns the bareGREL_{COMPONENT}_namespace, so name your other instances to avoid clashing with a field name (aLock("lease")would shareGREL_LOCK_LEASE_DURATIONwith the default instance). - 💥 Raise
OutOfContextErrorwith an actionable message on every ambient backend miss:Lock,TaskLock,LeaderElection,TTLCache,@cached, the cron schedule resolution, andIdempotencynow matchCircuitBreakerandRateLimiter.NoActiveAppErrorstays the low-level error raised byGrelmicro.current()itself. - 💥 Remove the implicit memory fallback on
CircuitBreakerandRateLimiter. Backend resolution is now one rule on every pattern: explicitbackend=wins, else the active app's component, elseOutOfContextError. For a per-process limiter or breaker without an app, passbackend=MemoryRateLimiterAdapter()orbackend=MemoryCircuitBreakerAdapter()(both import fromgrelmicro.resilience). Inside FastAPI handlers, addGrelmicroMiddlewareso ambient resolution works there.RateLimiter.reconfigurenow publishes the config and rebinds the strategy lazily on the next call, matchingCircuitBreaker. - 💥 Add positional argument capture to
grelmicro.testing:Callis nowCall(method, args=..., kwargs=...)andCallLog.countmatches positional arguments too. Update directCall(...)constructions. - 💥 Align the leader election and task lock env var prefixes with their single-token names:
GREL_LEADER_ELECTION_{NAME}_becomesGREL_LEADERELECTION_{NAME}_andGREL_TASK_LOCK_{NAME}_becomesGREL_TASKLOCK_{NAME}_. Update any environment variables set for these components. PR #346. - 💥 Rename the pattern factory methods so each uses the pattern's single-token name:
Provider.breaker()becomescircuitbreaker(),leader_election()becomesleaderelection()on bothProviderandCoordination, andCoordination.task_lock()becomestasklock(). This matches the module names (grelmicro.coordination.leaderelection,grelmicro.coordination.tasklock,grelmicro.resilience.circuitbreaker) and theratelimiter/circuitbreakerkind strings. Updateprovider.circuitbreaker(),micro.coordination.leaderelection(...), andmicro.coordination.tasklock(...)call sites. PR #343, PR #344. - 💥 Make
Log,Trace, andMetricssingletons. Each configures process-global state (the root logger, the OpenTelemetry tracer and meter providers), so registering a second one on the same app now raisesComponentAlreadyRegisteredErrorinstead of silently clobbering the first. PR #343. - 💥 Make the component
namea read-only property everywhere (Coordination,Cache,Log,Trace,Metrics,RateLimiters,CircuitBreakers,HealthChecks,RealClock,VirtualClock), matching the resilience and coordination primitives. Passname=at construction. PR #343.
Features
- ✨ Trace FastStream messages.
micro.install(faststream_app)now wires the broker's OpenTelemetry telemetry middleware against the app's tracer, so consumed and published messages get spans with no per-handler decoration. Selected by the sameTrace(instrument=...)directive under thefaststreamname, and a no-op when the broker's faststream telemetry support is not installed. (#470) - ✨ Trace Valkey commands. grelmicro ships a first-party
ValkeyInstrumentor(valkey-py has no official OpenTelemetry package), registered as a standardopentelemetry_instrumentorentry point soTrace(instrument=...)discovers it like any other library, andValkeyProvideruses it. It reuses the Redis span factories against thevalkey.*classes, so Valkey spans match the Redis ones. (#479) - ✨ Trace any library the app uses, not just grelmicro-managed providers.
Trace(instrument=True)now sweeps every installedopentelemetry-instrumentation-*package and attaches it to the app's tracer, so an app's own SQLAlchemy or asyncpg engine, httpx client, and the like are traced with no grelmicro provider. The set of installed instrumentors defines coverage (no new hard dependency), names follow the OpenTelemetry instrumentor names, and the asyncpg/SQLAlchemy pair is de-duplicated to avoid double spans. (#479) - ✨ Fail fast on a missing ambient binding.
micro.install(app, ambient=False)now warns at startup when ambient-resolving components are registered (it raisesAmbientBindingErrorunderGrelmicro(strict=True)), and the newmicro.check_ambient_binding(app)returns whether the binding middleware is wired so a test can catch a forgottenmicro.install(app)before it 500s on the first request. (#471) - ✨ Auto-disable
Traceuntil an endpoint is configured. The exporter now defaults toTraceExporterType.AUTO, which exports over OTLP HTTP when an endpoint is set (theendpointargument,OTEL_EXPORTER_OTLP_TRACES_ENDPOINT, orOTEL_EXPORTER_OTLP_ENDPOINT) and no-ops otherwise. RegisterTrace()unconditionally and it stays silent in dev, test, and CI instead of falling back tolocalhost:4318. (#476) - ✨ Add first-class HTTP Basic auth to
Trace. Passbasic_auth=(username, password)or setGREL_TRACE_BASIC_AUTH_USERNAMEandGREL_TRACE_BASIC_AUTH_PASSWORD, and theAuthorization: Basicheader is built and attached to the exporter directly, bypassing the fragileOTEL_EXPORTER_OTLP_HEADERSencoding. (#476) - ✨ Add native auto-instrumentation to
Trace.Trace(instrument=...)traces incoming FastAPI requests and Redis and Postgres calls against the app's tracer provider, no per-handler decoration. On by default, a no-op until the newinstrumentationextra is installed. PassFalse, a name or list to select, or a{name: False}map to exclude. Redis attaches per-client, asyncpg is patched process-wide, and Valkey and SQLite stay on@instrument. - ✨ Add
RateLimiter.wait(), a blocking admission verb that waits until tokens are available then consumes them. It polls on the clock seam (soVirtualClockdrives it in tests), waits as long as needed by default, and raisesRateLimitExceededErroronce an optionalmax_waitbudget is exceeded. Acostlarger than the limit raisesValueErrorinstead of waiting forever. - ✨ Add
LeaderElection.lead(func, *, repeat=False), which runs a coroutine only while the worker holds leadership and cancels it the instant leadership is lost, so no stale work outlives the lease. It returns the body's result if it finishes while still leader, orNoneif cancelled. Passrepeat=Trueto re-run after re-acquiring leadership. - ✨ Add
micro.install(app), one call that wires the lifecycle and per-handler ambient binding for Starlette, FastAPI, and FastStream. Passambient=Falseto skip the binding. - ✨ Accept a
timedeltafor the intervalseconds=, like@task.every(seconds=timedelta(minutes=2)). A plain number of seconds still works. - ✨ Add a
key=template to@cachedfor a stable, readable cache key rendered from the arguments, like@cached(key="user:{user_id}"). Passkey_maker=for the fully dynamic case. Passing both raisesTypeError. - ✨ Type
FireInfo.outcomeas the newFireOutcomeStrEnum(SUCCESS,ERROR,SKIPPED). String comparisons likeoutcome == "success"still work. - ✨ Add
Idempotency.run(key, factory), a one-call helper that runs an operation once and replays its response. It takes a sync or async factory and mirrorsTTLCache.get_or_set. - ✨ Every component now raises a typed
*SettingsValidationErrorfor invalid configuration, rooted in the sharedSettingsValidationErrorbase. AddsTraceSettingsValidationError,HealthSettingsValidationError,LogSettingsValidationError, andIdempotencySettingsValidationError. CatchSettingsValidationErrorto handle any of them. - ✨ Cache adapters (
MemoryCacheAdapter,RedisCacheAdapter,PostgresCacheAdapter,SQLiteCacheAdapter) now declare theCacheBackendprotocol explicitly, matching the lock, circuit breaker, and rate limiter adapters. - ✨ Add
Log.from_config,Trace.from_config, andMetrics.from_configto build each component from a pre-built config, matching the declarative path on every other pattern. Theconfig=kwarg still works. - ✨ Add
MemoryProviderso Memory has the same provider-direct surface (memory.lock(),memory.cache(), ...) as Redis, Postgres, and SQLite. - ✨ Add a built-in readiness check per provider. Every connection provider ships a cheap
check()probe (Redis and ValkeyPING, Postgres and SQLiteSELECT 1). Register it withhealth.add_provider(redis)as a criticalprovider:redischeck, or register one for every active provider at once withHealthChecks(auto_health=True).Grelmicro.providerslists the active providers. - ✨ Default the rate limiter
keyto"default"onacquire,acquire_or_raise,allow,peek, andreset, so the single-bucket case isawait limiter.allow(). The limiternamealready namespaces the backend key. - ✨ Add the zero-object
@cached(ttl=30)form for plain memoization: it binds a private process-localTTLCacheat decoration, never resolves the active app, and never shares across replicas. Pass aTTLCachefor shared state. Passing bothcacheandttlraisesTypeError. - ✨ Add the OpenSSF Scorecard workflow and badge.
- ✨ Make
Grelmicro(uses=[...])andmicro.use(...)forgiving: a bare Component class is constructed for you, a bare adapter (class or instance) is wrapped in its matching Component, and a bare Provider with no Components auto-registers one default Component per kind it serves. The explicit form always wins, so any explicit Component turns provider auto-registration off entirely. - ✨ Add
AmbiguousProviderError, raised whenuses=[...]lists two bare Providers with no Components, so the default Component for a shared kind would be ambiguous. Wrap each Provider in the Components it should serve to resolve it. - ✨ Add the Idempotency pattern: a new
grelmicro.idempotencymodule with anIdempotencyprimitive and@idempotentdecorator. A caller-provided key (anIdempotency-Keyheader) executes the operation once, stores the response forttlseconds, and replays it on repeats. Duplicates arriving mid-flight fold into the first execution, across replicas when a Coordination lock backend is configured. A failure stores nothing, so a retry executes fresh. An optionalfingerprint=rejects a reused key with a different payload viaIdempotencyConflictError. Storage rides the cache layer (cache=or the active app'sCachecomponent). - ✨ Add Redis Sentinel and Redis Cluster support:
redis+sentinel://host1:26379,host2:26379/serviceandredis+cluster://host1,host2URL schemes onRedisProvider, plusRedisProvider.sentinel(...)andRedisProvider.cluster(...)factories, so one URL switches topology. On Cluster, the multi-key cache and lock operations require a hash-tagged prefix (prefix="{app}cache"), enforced with a clear error at construction. - ✨ Add Valkey support: a
ValkeyProvideringrelmicro.providers.valkey(extravalkey) serves the full Redis adapter column (Lock, TaskLock, LeaderElection, Schedule, TTLCache, RateLimiter, CircuitBreaker) through thevalkeyclient. - ✨ Add the Externalized Configuration pattern: a new
grelmicro.configmodule with anExternalConfigcomponent that reconfigures live components from a mounted ConfigMap, Secret,.env, JSON, YAML, or TOML file (FileConfigAdapter, nested mappings flatten to env-style keys), polling on an interval with a publicreload()for an immediate pass. Sources are pluggable via theConfigBackendprotocol. Every named pattern built imperatively registers under itsGREL_{PATTERN}_{NAME}_keys, includingCircuitBreaker(GREL_CIRCUITBREAKER_{NAME}_) andRateLimiter(GREL_RATELIMITER_{NAME}_). Instances built from a pre-built config stay static. Validation warnings log field names only, never values. - ✨ Add
GrelmicroMiddlewareingrelmicro.fastapi: a pure ASGI middleware that binds the active app inside request handlers, soLock("cart"),RateLimiter.sliding_window(...), and@cachedresolve ambiently in handlers without explicitbackend=wiring. - ✨ Add a bounded wait to
Lock.acquire(timeout=), raisingTimeoutErrorat the deadline, andLock.extend()to renew the lease of a held lock without releasing it. Both are mirrored on thefrom_threadfacade. - ✨ Add
TaskLock.refresh()so a task body that may outrunmax_lock_secondscan renew its claim, raisingLockNotOwnedErrorwhen the claim was lost. - ✨ Add
retry_jittertoLockandLeaderElection(default 0.1): each retry sleepsretry_interval * uniform(1 - jitter, 1 + jitter), so contending workers spread their attempts instead of retrying in lockstep. - ✨ Add scheduler introspection:
next_fire_timeandlast_fireon interval and cron tasks, withFireInfo(started_at, outcome, duration) exported fromgrelmicro.task. - ✨ Add
Match.explain()returning the human-readable matcher tree, and warn once when a predicate returns a non-bool value. - ✨ Add a shared
AdmissionErrorbase so every gatekeeping rejection is catchable with oneexcept.RateLimitExceededError,BulkheadFullError,CircuitBreakerError, andWouldBlockErrornow inherit it, soexcept AdmissionErrorhandles a rate limiter over budget, a full bulkhead, an open circuit breaker, or a non-blocking lock that would block. It is purely additive: the existing per-primitiveexceptclauses still work. PR #354. - ✨ Add
RateLimiter.allow(key=...)returning aboolfor the common served-or-throttled branch, and makeRateLimitResulttruthy (bool(result)isresult.allowed).if await limiter.acquire(key=...):now reads as the decision whileretry_afterandremainingstay available on the result. PR #354. - ✨ Add serve-stale-on-error to the cache with
stale_ttl=on@cached,get_or_set, andTTLCache.set. Each value keeps a fallback copy forttl + stale_ttlseconds, so a recompute that fails after the TTL serves the last good value instead of raising, up tostale_ttlseconds late. A flaky upstream degrades to slightly stale data instead of an error storm. It composes withlockandearly, an explicit delete or tag invalidation drops the fallback, and each stale serve records thegrelmicro.cache.stale_servesmetric. PR #350. - ✨ Add SQLite cache and circuit breaker backends, completing the SQLite column of the capability matrix (the circuit breaker coordinates single-host multi-process state). PR #349.
- ✨ Add a durable
@tasks.cron(expr, timezone="UTC")decorator that runs a task on a 5-field cron schedule (minute hour day-of-month month day-of-week). The parser is built in, with no external dependency, and supports*, steps, ranges, lists, and the7-as-Sunday alias. It uses standard Vixie day-of-month/day-of-week OR semantics. Each fire is claimed against a durable last-fire state via a newScheduleBackend(Memory, Redis, Postgres, and SQLite), so the task runs at most once across all workers per fire. A fire missed while every worker was down replays once on restart, bounded bymisfire_grace_seconds, and only the most recent missed fire runs. Wire it viaCoordination(provider)orCoordination(schedule=...). PR #348. - ✨ Add a time-based stop to
Retrywithmax_seconds=. Retrying stops as soon as eitherattemptsis reached or the wall-clock budget elapses, whichever comes first (attemptsstill defaults to 3). Available on theRetry.exponential/Retry.constantfactories, the constructor, andRetryConfig(env varGREL_RETRY_{NAME}_MAX_SECONDS). The budget reads the clock seam, soVirtualClockdrives it in tests. PR #347. - ✨ Re-export
FunctionTypeErrorandTaskAddOperationErrorfromgrelmicro.task, so the task errors users catch live next toTaskErrorinstead of only ingrelmicro.task.errors. PR #343. - ✨ Export the catch-all base
GrelmicroErrorand the cross-cuttingDependencyNotFoundError,OutOfContextError, andSettingsValidationErrorfrom the top-levelgrelmicropackage, soexcept GrelmicroErrorcatches any library error from one import. Re-exportWouldBlockErrorandCoordinationBackendErrorfromgrelmicro.coordination(the latter moved intogrelmicro.coordination.errors). PR #343.
Fixed
- 🐛 Name the failing source in the
ExternalConfigreload warning, so a broken config or secrets mount is no longer a generic warning. Each source loads under its own guard, so a config failure no longer hides a working secrets source. Source values are never logged. - 🐛 Raise an actionable
RuntimeErrorfrom a sync@cachedcall when the backend never captured a running loop, instead of an opaqueAttributeError. The message says to open the backend withasync with micro:first. - 🐛 Reconcile cache tags on every Redis
setandset_many, even with no tags. Re-setting a previously tagged key without tags now drops its stale tag membership, so a laterdelete_tagsno longer wrongly removes it. PR #353. - 🐛 Store the cache sidecar entries (the
early=refresh metadata, and the new stale reserve) under a\x1fseparator instead of\x00, so they are valid Postgres text keys.@cached(early=...)previously raised on a Postgres cache backend. PR #350.
Docs
- 📝 Add
docs/architecture/decorators.mddocumenting the bare@decoversus parametrized@deco(...)rule and which decorators wrap sync functions. PR #343.
0.27.0 - 2026-06-07
Breaking
- 💥 Replace
@cached(stampede="local" | "distributed" | None)with@cached(lock=False | True | "local").lock=Truefolds concurrent misses and picks the cross-replica path automatically when the active app has aCoordinationlock backend (in-process otherwise),lock="local"forces the in-process path, and the default is nowlock=False(no protection, opt in explicitly). Migratestampede="local"tolock="local",stampede="distributed"tolock=True, andstampede=Nonetolock=False. Issue #235. - 💥 Move
LeaderElectionout ofgrelmicro.syncinto a newgrelmicro.coordinationpackage. Import it fromgrelmicro.coordination.Sync.leader_election()is removed: register aCoordinationcomponent and callmicro.coordination.leader_election(...). Leader election now runs on a dedicatedLeaderElectionBackend, not the lockSyncBackend, so it can use a different vendor thanLock(Redis forLock, a Kubernetes Lease for leader election). Issue #223. - 💥 Unify
grelmicro.syncintogrelmicro.coordinationand deletegrelmicro.sync. ImportLock,TaskLock,LeaderElection, andCoordinationfromgrelmicro.coordination. TheSynccomponent is gone: use oneCoordinationcomponent, which exposes.lock(...),.task_lock(...), and.leader_election(...), and reach it onmicro.coordination. TheSyncBackendprotocol is nowLockBackend, the*SyncAdapterbackends are now*LockAdapter, and the provider factory.sync()is renamed to.lock(). Issue #223. - 💥 Make the JSON utilities internal. The
grelmicro.jsonmodule is removed. UseJsonSerializerfromgrelmicro.cachefor cache JSON, ororjsondirectly if you need raw fast JSON.
Features
- ✨ Add a
Metricscomponent that installs an OpenTelemetryMeterProviderfor the app's lifetime, with OTLP, Prometheus, console, and none exporters. A@measuredecorator times and counts any function,metrics_router()serves a Prometheus/metricsendpoint, and every built-in component (health, circuit breaker, retry, rate limiter, bulkhead, timeout, cache, tasks) emits its own metrics. All metric calls are no-ops without theopentelemetryextra or an active component. - ✨ Leader election leases carry a Kubernetes-style
LeaderRecord(holder, lease duration, acquire and renew times, leadership transitions, and free-form metadata). Read it fromLeaderElection.record, set the metadata viaLeaderElection(metadata=...). Metadata-storing backends ship for memory, Redis, Postgres, and Kubernetes Lease, resolved throughprovider.leader_election()or passed toCoordination(...)directly. Issue #223. - ✨ Add
grelmicro.testing.record(backend)for protocol-level call assertions. It instruments a backend's public async methods in place and returns aCallLog, so the backend keeps its type and behavior while every call is recorded. Assert withlog.count(method, **kwargs), inspectlog.methods(), or read the rawlog.calls. Works likepytest-mock'smocker.spy. Issue #271. - ✨ Add cache tags,
get_or_set, and batch operations. Tag entries viaset,set_many,get_or_set, or@cached(tags=["users", "user:{user_id}"]), then invalidate a whole group withdelete_tags.get_or_set(key, factory)computes a missing value once under the same stampede protection as@cached(lock=True).get_many,set_many, anddelete_manywork on many keys at once. Tags and batch ops run on Memory, Redis, and Postgres. - 📝 Correct the comparison page and capability matrix to show the Postgres and SQLite cache, rate limiter, and circuit breaker backends as shipped (they were stale-labeled "planned").
- 📝 Add a "what grelmicro is not" line to the README and docs landing for sharper first-read positioning.
- 🔧 Set the PyPI
Development Statusclassifier to4 - Beta. - ✨ Discover Providers and Adapters through entry-point groups. Third-party packages register under
grelmicro.providersandgrelmicro.{kind}.adapters(coordination,cache,ratelimiter,circuitbreaker) and resolve by short name, the same path first-party backends use. Unknown names raiseProviderNotRegisteredErrororAdapterNotRegisteredErrorlisting the installed names. Newdocs/architecture/plugins.mdand anexamples/third-party-adapter/skeleton. Issue #234. - ✨ Add
VirtualClockfor deterministic time in tests. Time-dependent primitives (Retrybackoff,CircuitBreakerhalf-open window,RateLimiterrefill,Shieldadaptive gate) read time through a clock seam (grelmicro.clock.monotonic/sleep). Install aVirtualClock(Grelmicro(uses=[clock, ...])orasync with VirtualClock()) and callclock.advance(seconds)to drive that behavior with no real waiting. With no clock registered, the seam forwards totime.monotonicandasyncio.sleep, so production keeps real time. Issue #272. - ✨ Auto-discover shared Providers in
Grelmicro(uses=[...]). A Provider held by a Component (Coordination(redis),Cache(redis)) no longer has to be listed separately: it is adopted and lifecycled exactly once, opened before the Components that hold it. Listing it explicitly stays valid and keeps control over lifecycle order. Issue #263.
Docs
- 📝 Lead every feature page with the simplest runnable example, then explain, moving deep theory into collapsible sections. Covers the resilience patterns and the cache, coordination, logging, health, tracing, and task guides.
0.26.0 - 2026-06-05
Breaking
- 💥 The
Taskprotocol's__call__now takes astop: asyncio.Event | None = Nonekeyword used for graceful shutdown. CustomTaskimplementations must accept it. The built-inintervaltasks andLeaderElectionare unaffected. Issue #187. - 💥 Replace the
@cached(lock=...)parameter with@cached(stampede="local" | "distributed" | None).lock=Truebecomesstampede="local"(now the default),lock=Falsebecomesstampede=None, and the custom-context-manager form is dropped in favor of the"distributed"cross-replica mode. Issue #235.
Features
- 📝 Add a runnable FastAPI demo under
examples/fastapi-demo/.docker compose up --waitstarts Redis, Postgres, and a FastAPI app that exercises every Pattern (cache, rate limiter, circuit breaker, distributed lock, leader-gated task, health probes), with aDemo SmokeCI job and ajust demoshortcut. Issue #166. - 📝 Add a ConfigMap-watcher example wiring
reconfigure()(docs/configuration/reconfigure-from-configmap.md), with aSIGHUPvariant for non-Kubernetes hosts. Issue #169. - ✨ Accept bare zero-arg classes in
Grelmicro(uses=[...]),micro.use(...), and theSync/Cache/RateLimiters/CircuitBreakersconstructors.uses=[MemorySyncAdapter]andSync(MemorySyncAdapter)now work without the trailing(), in the spirit of FastAPI'sDepends(dep). A class that needs constructor arguments raises a clear error. Issue #263. - ✨ Guard against two overlapping
Grelmicroapps clobbering process-global state. Opening a second app that registersLogorTracewhile another such app is active now raisesMultipleActiveAppsError. Apps without those components overlap freely. PassGrelmicro(allow_multiple=True)to opt out. Newdocs/architecture/multiple-apps.mddocuments the policy. Issue #266. - ✨ Add
Tasks(shutdown_timeout=...)for graceful shutdown. On exit,Taskssignals everyintervaltask to finish its current run and stop, force-cancelling only stragglers that outlast the timeout. The default30.0matches Kubernetes'terminationGracePeriodSeconds, andLeaderElectionreleases leadership on the same signal. Newdocs/architecture/graceful-shutdown.mdcovers signal wiring. Issue #187. - ✨ Add a three-layer cache stampede menu to
@cached.stampede="local"(default) folds concurrent same-key misses to one in-process run,stampede="distributed"coordinates across replicas through theSynccomponent, andearly=(XFetch) refreshes the hottest keys in the background before they expire so no caller blocks. Issue #235. - ✨ Add
LeaderElection.last_confirmation_age()(seconds since the last backend response that confirmed local leadership,Noneuntil first acquisition and after confirmed loss) andLeaderElection.is_leader_confirmed_within(max_age)(stricter variant ofis_leader()that requires a recent backend renewal). Theis_leader()docstring now spells out the advisory uncertainty window during a backend partition. - ✨ Add
Grelmicro(strict=True)to raiseLifecycleOrderErrorinstead of warning when a Component holds a Provider that is missing fromuses=or listed after the dependent Component. The defaultFalsepreserves the lenient warn-only behavior.LifecycleOrderErroris exported fromgrelmicro. - ✨ Add
Shieldresilience pattern: per-attempt timeout, retry-budget-gated retries, CUBIC-style adaptive rate limiter, optional cache and fallback recovery paths. Three profiles (internal,api,slow) cover the common cases. Decorator (@shield,@shield.api(...)), class (Shield.api("name")), and imperative (Shield.api("name").run(fn, ...)) forms supported. Issue #249. - ✨ Add
TTLCacheConfigand expose it viaTTLCache.config. Matches the frozen-config shape used by every other primitive. - ✨ Add
RedisProvider.safe_urlandPostgresProvider.safe_urlreturning the resolved URL with the password replaced by***. The new__repr__on both providers uses the safe form so credentials never leak through logs or tracebacks. - ✨ Add
TracingConfig.shutdown_timeout(default5.0seconds).Trace.__aexit__now runsTracerProvider.shutdown()in a thread with this deadline so a slow or broken exporter no longer hangs application shutdown. - ✨ Add
SQLiteProviderand SQLite rate limiting. UseRateLimiters(SQLiteProvider("app.db"))for file-backed limits on a single host. Each acquire runs a read-modify-write inside aBEGIN IMMEDIATEtransaction. Issue #173. - ✨ Add
PostgresCircuitBreakerAdapterfor fleet-wide circuit breaker state on Postgres, plusPostgresProvider.breaker()soCircuitBreakers(postgres)resolves it. Transitions run in PL/pgSQL functions guarded bypg_advisory_xact_lock. - ✨ Add
Bulkheadresilience pattern to cap concurrent in-flight calls.max_concurrentbounds concurrency,max_waitlets callers queue briefly before aBulkheadFullError(default fails fast), andmax_workersruns blocking work throughbulkhead.to_threadon a dedicated pool. Async context manager and decorator forms. Issue #168. - ✨ Add
Bulkhead(uses=[...])to scope Providers and Components to a bulkhead. Inside the scope, a Pattern resolving its default backend picks up the bulkhead's Component, isolating a business context onto its own pool. Explicitbackend=still wins. Issue #168.
Fixes
- 🐛 The README and
simple_fastapi_app.pyFastAPI examples now pass an explicitbackend=to patterns used inside request handlers. Request handlers run outside the app's ambientGrelmicro.current()scope, so the previous ambient form raisedNoActiveAppError(locks, cache) or silently fell back to an in-memory backend (rate limiter, circuit breaker) at runtime. BackgroundTaskskeep using ambient resolution. Ambient resolution in handlers is tracked in #328. - 🔒
SettingsValidationErrorno longer echoes the offending input value. Env-loaded credentials (DSNs, tokens) no longer surface in error messages. - 🚨
ComponentNotRegisteredErrorfromGrelmicro.get(kind, name)now lists every registered(kind, name)pair (or states that none are registered). Agents and developers see what is available without inspecting the container. - 🚨
HealthChecks.addinvalid-name errors now include valid examples ('redis','db-primary','weather:circuitbreaker') alongside the regex. - 🐛
Log.__aenter__andLog.__aexit__now serialize on a class-levelthreading.Lockso concurrentGrelmicrolifecycles in the same process cannot interleave the stdlib root-logger snapshot / restore sequence. - 🐛 Unexpected exceptions inside a health check now surface as
"TypeName: message"in theCheckResult.errorfield instead of the generic"Health check failed". Operators reading only the/healthzpayload can identify the failing class without grepping logs. - 🔒
Lock("...")now validates the name against^[A-Za-z0-9][A-Za-z0-9._:/-]*$(max 200 chars). Names with whitespace, control characters, or leading separators are rejected with a message that includes valid examples. Existing namespaced names (users:42,payments/eu,weather.svc) keep working. - ⚡
DuplicateFilternow sweeps entries older thanttl_secondsonce per window, so high-cardinality log floods stop evicting still-active keys by size pressure.
Docs
- 📝 Lead
README.mdanddocs/index.mdwith a one-route, one-primitive FastAPI example before the full composition demo. - 📝 Annotate
Grelmicro.use,Grelmicro.get,instrument, andCacheBackendprotocol parameters withAnnotated[..., Doc(...)]. - 📝 Align the
CONTRIBUTING.mddiscriminator rule with the code:kind(nottype). - 📝 Document the per-process scope of
Tasksand point atTaskLock/LeaderElectionfor cluster-wide scheduling. - 📝 Add a Kubernetes operational-assumptions section covering RBAC, API server availability, etcd latency, and single-cluster scope to
docs/architecture/kubernetes.md. - 📝 Fix the
sync.md → task.md#tasksinternal anchor somkdocs --strictno longer reports it. - 📝 Add a lifespan-only example (one provider, one component) between the minimal example and the full composition demo in
README.mdanddocs/index.md. - 📝 Drop unsupported claims and idioms from the landing copy ("Stop reinventing the wheel", "battle-tested in production", "TL;DR").
- 📝 Add
Start here/Common recipeslead lines to every page underdocs/reference/. - 📝 Add an explicit
Running testssection toCONTRIBUTING.mdwith the commands for unit-only, integration-only, and the full local gate. - 📝 Add a
What should I pick?decision tree to the top ofdocs/comparison.mdso readers can map their situation to the right tool (one primitive, two or more, task queue, workflow engine, web framework). - 📝 Add a
Your first contributionsection toCONTRIBUTING.mdwith the expected code, test, and docs shape and a pointer to thegood first issuelabel. - 📝 Add
Annotated[..., Doc(...)]to theSyncBackend,RetryStrategy,RateLimiterStrategy,RateLimiterBackend,CircuitBreakerStrategy, andCircuitBreakerBackendprotocol parameters so IDE and LLM tools surface the same hints on backends as on user-facing primitives. - 📝 Group the
grelmicro.resiliencepackage docstring into front doors, components, adapters, and configs so import-site hover help guides agents and humans to the preferred entry point. - 📝 Document that auto-generated task references (
module:qualname) surface in logs, distributed lock keys, and metric labels. Suggest passing an explicitname=for sensitive workflows invalidate_and_generate_referenceand thedocs/task.mdInterval Task section. - 📝 Add a
Why Python 3.12section todocs/installation.mdlisting the language features (PEP 695,asyncio.timeout) that drive the floor, and note that CI runs the matrix on every advertised classifier (3.12, 3.13, 3.14). - 📝 Add a
Platformscolumn to the Optional extras table indocs/installation.mdcalling out thatuvloopis skipped on Windows and PyPy. - 📝 Document
RateLimitResult.remainingas an estimate for continuous-state algorithms (GCRA-based sliding window). Enforcement still uses exact state, so the nextacquiremay be denied even whenremaining > 0. - 📝 Add a FastStream resilience recipe (
docs/snippets/resilience/faststream.py) that uses a fleet-wide per-keyLockand a sliding-windowRateLimiterinside a Redis-broker subscriber. Linked fromdocs/resilience/index.md. - 📝 Formalize the
test_<component>_<scenario>_<expected_outcome>test-name shape inCONTRIBUTING.mdwith three concrete examples. - 📝 Add
docs/benchmarks.mdwith reproducible request-path benchmarks for the rate limiter, circuit breaker, cache, and lock, plus runnable scripts underbenchmarks/. - 📝 Add a
Choosing a backendguide to the sync, cache, rate limiter, and circuit breaker pages. - 📝 Expand
docs/json.mdwith supported types, the orjson fallback, and serializer boundaries. - 📝 Note that the default OTLP HTTP trace exporter expects a running collector in
docs/tracing.md, withCONSOLEandNONEfor local development.
Internal
- 🔒
@instrumentnow filters arguments whose names match common secret keywords (password,token,secret,api_key,authorization,cookie, ... matched case-insensitively) from both span attributes and log context. Pass extra names viaskip=for custom secret-bearing parameters. Unchanged for non-sensitive args. - 🔧 Replace the optional
orjsonredef-as-Any | Nonepattern ingrelmicro/_json.pywith try/except branches that define the dumps/loads functions in scope. The per-call# type: ignore[union-attr]directives are gone, andorjsonkeeps its real type from the stub package in the available branch. - 🚨
Trace.__aenter__now raisesTracingErrorifopentelemetry.trace._TRACER_PROVIDERis missing instead of silently no-op patching. A future OTel that drops the private global surfaces a clear error pointing at the workaround. An inline comment near the patch documents why the private attribute is required. - 🔒
PickleSerializerdocs upgraded to a Danger callout. Pickle is now framed as trusted in-process backends only, and the@cacheddecorator example leads withJsonSerializer. TheTTLCachedocstring lists Pydantic and JSON before Pickle. - 🔧 Comment why
_env_prefix=env_prefixneeds a type-ignore inRedisProviderandPostgresProvider(pydantic-settings runtime kwarg the stubs do not expose). - ⚡ Snapshot hot config fields (
cost,allowed_repetitions,ttl_seconds,cache_size) ontoRateLimitFilterandDuplicateFilterinstances during setup so the per-recordfilter()path reads plain attrs instead of walking the Pydantic config. - 🔧 Drop three unused
ty: ignoredirectives ingrelmicro/_json.py. - ⚡
@cached(lock=True)per-key lock dictionaries now bound their size with LRU eviction (1024 entries). High-cardinality miss-heavy workloads no longer accumulateasyncio.Lock/threading.Lockobjects indefinitely. Held locks are never evicted, so in-flight stampede protection is preserved. - 🔒
PostgresRateLimiterAdapteradvisory locks now usepg_advisory_xact_lock(hashtextextended(key, namespace)). The grelmicro-specific seed gives rate-limiter keys their own 64-bit lock-id space, isolating them from any other advisory lock in the same database and reducing intra-rate-limiter collisions from a 32-bit birthday risk to a 64-bit one. - ✅ Add a
tests/typing/sample (test_cache_generics.py) that usestyping.assert_typeto lock inTTLCache[T],PickleSerializer[T], andPydanticSerializer[T]inference end-to-end. A regression that widens inference back toAnyfailsuv run ty check. - ✅ Add a guard test that every
_LAZYkey ingrelmicro/resilience/__init__.pyis exported in__all__and actually resolves at runtime. - ✅ Add Hypothesis property tests for token-bucket and sliding-window math and for exponential backoff jitter bounds.
- ✅ Enable branch coverage (
--cov-branch). The 100% gate now covers both lines and branches. Defensive guards against impossible state are marked with# pragma: no branch. - 🔧 Document why every
type: ignoreandty: ignoreingrelmicro/_config.pyis required (Pydantic dynamic-subclass boundary). - 🔧 Explain the double-checked
pragma: no coverinReconfigurable.reconfigureso future contributors see the concurrent-caller intent. - 🔧 Add inline attribution cues to
grelmicro/task/_utils.pyandgrelmicro/resilience/_protocol.py/grelmicro/cache/_protocol.pyso readers immediately see where third-party adaptations live and that protocol bodies live in concrete adapters. - 🔧 Fix the
THIRD_PARTY_NOTICES.mdpath togrelmicro/resilience/ratelimiter/redis.py.
0.25.0 - 2026-05-21
Features
- ✨ Add
Timeoutreconfigurable resilience pattern.Timeout("db", seconds=2.0)wrapsasyncio.timeout, usable as an async context manager (async with db_timeout:) or decorator on async functions.TimeoutConfigis a frozen three-paths Pydantic config withseconds: PositiveFloat. Env prefixGREL_TIMEOUT_{NAME_UPPER}_. InheritsReconfigurable[TimeoutConfig]for live deadline swaps. Issue #176. - ✨ Add
Fallbackprimitive with decorator, block, and class forms.@fallback(when=..., default=...)/@fallback(when=..., factory=...)swap a matched exception for a safe value.async with falling_back(when=..., default=...) as result:covers inline blocks.Fallback("name", when=..., default=...)is the named, reconfigurable class form.FallbackConfigis a frozen three-paths Pydantic config withdefault/factorymutually exclusive.when=matches Retry's keyword so theMatchDSL stays universal. Composition order documented in Composing patterns. Issue #199. - ✨ Add
PostgresCacheAdapterfor Postgres-backed cache storage. Register viaGrelmicro(uses=[postgres, Cache(postgres)]). Entries land in a singlegrelmicro_cachetable keyed onkey TEXT PRIMARY KEYwithvalue BYTEAandexpires_at TIMESTAMPTZ.getfilters expired rows withWHERE expires_at > NOW(),setis oneINSERT ... ON CONFLICT DO UPDATE. Schema auto-migrates on first connect, opt out withauto_migrate=False. Optional janitor reclaims storage whencleanup_interval=is set (off by default). Issue #167. - ✨ Add
PostgresRateLimiterAdapterfor fleet-wide rate limiting on Postgres. Register viaGrelmicro(uses=[postgres, RateLimiters(postgres)])andRateLimiter.token_bucket(...)orRateLimiter.sliding_window(...)runs against a singlegrelmicro_rate_limitertable.acquireandpeekeach run one round-trip to a PL/pgSQL function. Concurrent writes for the same key are serialized withpg_advisory_xact_lock. Schema and functions auto-migrate on first connect, opt out withauto_migrate=False. Issue #164.
0.24.0 - 2026-05-18
Features
- ✨ Add
CircuitBreakerStrategyProtocol andCircuitBreakerBackend.bind(name, config) -> Strategy. Mirrors the RateLimiter shape so a second algorithm plugs in without breaking changes.CircuitBreakerConfiggains akind: Literal["consecutive_count"]discriminator. Issue #163. - ✨ Add
RedisCircuitBreakerAdapterfor fleet-wide breaker state. Register viaGrelmicro(uses=[redis, CircuitBreakers(redis)])andCircuitBreaker("name")consults Redis for admission, counters, and transitions. Half-open admission cap is enforced globally via atomic Lua scripts.last_errorandlast_error_timestay per-replica. Issue #163. - ✨ Add
CircuitBreaker.consecutive_count(name, ...)factory classmethod, mirroringRateLimiter.token_bucket(...)andRateLimiter.sliding_window(...). Each algorithm of every Pattern lands as a classmethod on the Pattern class. The algorithm-config module loads lazily on first call. Issue #163. - ✨
grelmicro.resilienceis now a PEP 562 lazy package:from grelmicro.resilience import CircuitBreakerno longer loadsRateLimiter, its algorithm configs, or memory/redis adapters. Same in the other direction. Top-level__getattr__dispatches to the right subpackage on first access. Issue #163.
Breaking
- 💥
CircuitBreaker.transition_to_closed,transition_to_open,transition_to_half_open,transition_to_forced_open,transition_to_forced_closed, andrestartare nowasync def. Addawaitat every call site. Issue #163. - 💥
CircuitBreakerBackendProtocol is now lifecycle +bind(name, config). Custom backends should return aCircuitBreakerStrategyinstance frombind.register(breaker)and the local fast-path are dropped: every backend (includingMemoryCircuitBreakerAdapter) goes through the Strategy. Memory state lives in adapter-owned dicts keyed by breaker name.CircuitBreakerSharedStaterenamed toCircuitBreakerSnapshot. Issue #163. - 💥
CircuitBreakerConfigis now aDiscriminator("kind")-tagged union (matchesRateLimiterConfig). InstantiateConsecutiveCountConfig(...)directly. The algorithm config lives atgrelmicro.resilience.circuitbreaker.consecutive_count. Issue #163. - 💥
FORCED_OPENandFORCED_CLOSEDno longer incrementconsecutive_error_count/consecutive_success_count. Per-replicatotal_error_count/total_success_countstill tick. Dashboards keying off consecutive counts during forced states need updating. Issue #163. - 💥 Resilience layout: each Pattern is now a subpackage with its algorithm configs and adapters as siblings.
grelmicro.resilience.memory→grelmicro.resilience.circuitbreaker.memoryandgrelmicro.resilience.ratelimiter.memory.grelmicro.resilience.redis→grelmicro.resilience.circuitbreaker.redisandgrelmicro.resilience.ratelimiter.redis.grelmicro.resilience.algorithmsis gone: rate-limiter configs live atgrelmicro.resilience.ratelimiter.{token_bucket,sliding_window}, circuit-breaker configs atgrelmicro.resilience.circuitbreaker.consecutive_count. Top-levelfrom grelmicro.resilience import ...shortcuts are unchanged. Issue #163. - 💥 Rename Components:
Breaker→CircuitBreakers,RateLimit→RateLimiters. Plural matches existing Component convention (Tasks,HealthChecks). Mechanical migration: replaceBreaker(...)withCircuitBreakers(...)andRateLimit(...)withRateLimiters(...)at every call site. Issue #163. - 💥
CircuitBreaker.__init__drops the algorithm kwargs path (error_threshold=,success_threshold=,reset_timeout=,half_open_capacity=,log_level=,ignore_exceptions=,env_prefix=,env_load=). Signature is nowCircuitBreaker(name, config=None, *, backend=None), matchingRateLimiter. UseCircuitBreaker.consecutive_count("name", error_threshold=5, ...)for the simple case,CircuitBreaker("name", ConsecutiveCountConfig(...))for the declarative case, or bareCircuitBreaker("name")for defaults. Env loading viaGREL_CIRCUIT_BREAKER_*is gone: build the config frompydantic-settingsif you need that. Issue #163. - ✨
CircuitBreakerandRateLimiterfall back to a process-global implicitMemoryCircuitBreakerAdapter/MemoryRateLimiterAdapterwhen noCircuitBreakers/RateLimitersComponent is registered.CircuitBreaker("payments")andRateLimiter.token_bucket("api", capacity=10, refill_rate=1)work without anyGrelmicro(uses=[...])setup. Fleet-wide opt-in stays explicit (Grelmicro(uses=[redis, CircuitBreakers(redis), RateLimiters(redis)])). Issue #163.
0.23.0 - 2026-05-17
Breaking
- 💥 Rename the discriminator field from
typetokindon every tagged union. AffectsRateLimiterConfig(TokenBucketConfig,SlidingWindowConfig) andRetryBackoffConfig(ExponentialBackoff,ConstantBackoff,LinearBackoff,FibonacciBackoff,RandomBackoff). Serialized YAML and JSON configs must replacetype:withkind:(for exampleGREL_RETRY_FOO_BACKOFF={"kind":"exponential",...}). Frees the Pythontypebuiltin from being shadowed on every config object. Issue #268. - 💥 Rename
GCRAConfigtoSlidingWindowConfigandRateLimiter.gcra(...)toRateLimiter.sliding_window(...). The discriminator value also moves from"gcra"to"sliding_window". Modulegrelmicro.resilience.algorithms.gcrabecomesgrelmicro.resilience.algorithms.sliding_window. Internal strategy classes (_RedisGCRA,_MemoryGCRA) keep their names since they describe the underlying algorithm. Issue #259.
Features
- ✨ Add
LogandTracecomponents. RegisterLog()andTrace()inGrelmicro(uses=[...])to wire observability through the same verb asSync,Cache,RateLimit,Breaker, andTasks.Log()wrapsgrelmicro.log.configure(...)and snapshots stdlib root handlers on enter so sequential apps in tests do not stack handlers.Trace()owns an OTelTracerProvider: builds it fromTracingConfig(env prefixGREL_TRACE_), installs it on enter, shuts it down and restores the prior global provider on exit. OTLP HTTP and gRPC exporters are lazy-imported. Issue #224.
Docs
- 📝 Add Testing page documenting
micro.override(...)and the conftest recipe. Issue #236. - 📝 Add Capability matrix page covering Pattern × Adapter pairs for
1.0.0. Issue #161.
0.22.0 - 2026-05-16
Features
- ✨ Add
Grelmicroapp object andComponentprotocol. The user composes everything attached to the app into one container and opens it withasync with micro:. SingleGrelmicro.use(item)registration verb (anduses=constructor kwarg) acceptsComponentinstances (registered with(kind, name)lookup, exposed onmicro.<kind>), first-party backends (auto-wrapped into their matching Component:RedisCacheAdapter→Cache,RedisSyncAdapter→Sync), and any other async context manager (lifecycled only, caller keeps the reference). Typed accessorsmicro.syncandmicro.cacheprovide IDE completion.Grelmicro.componentsreturns the registered Components in order for/healthz-style introspection. Issue #208, epic #201, unified in #219,Componentrename and.componentsaccessor in #233. - ✨ Add
Synccomponent. Wraps aSyncBackendand exposeslock(...),task_lock(...),leader_election(...)factories. Use it viaGrelmicro(uses=[redis, Sync(redis)])(Provider-direct) orSync(MemorySyncAdapter())(Backend-direct). Reach it onmicro.sync. Issue #210. - ✨ Add
Cachecomponent. Wraps aCacheBackendand exposes attl(...)factory that builds aTTLCachebound to the wrapped backend. Use it viaGrelmicro(uses=[redis, Cache(redis)])(Provider-direct) orCache(MemoryCacheAdapter())(Backend-direct). Reach it onmicro.cache. Issue #212. - ✨ Add Component-direct Provider API.
Sync,Cache,RateLimit, andBreakeraccept aProvideror aBackendinstance. When given a Provider, the Component callsprovider.sync(),provider.cache(),provider.ratelimiter(), orprovider.breaker()to build the matching adapter. AddProviderbase class ingrelmicro.providers._basewith the four factory methods. AddRedisProvider.ratelimiter()returning aRedisRateLimiterAdapter. The Adapter classes stay public as escape hatches for custom Providers, but the recommended user code usesSync(redis)instead ofSync(RedisSyncAdapter(provider=redis)). - ✨ Add
Grelmicro.current()classmethod for ambient lookup. Insideasync with micro:it returns the active app for the current asyncio task. - ✨ Add
Retryprimitive with decorator, block, and class forms. Five backoff algorithms ship:ExponentialBackoff(default, with full jitter),ConstantBackoff,LinearBackoff,FibonacciBackoff, andRandomBackoff.when=is required and accepts aMatch(or shorthand). Live reconfiguration viaReconfigurable[RetryConfig]. Three-paths configuration. Underlying exception is re-raised with a PEP 678 note on exhaustion. Issue #165. - ✨ Add
MatchandOutcometogrelmicro.resilience.Matchis the resilience-wide outcome filter DSL:Match.exception(...),Match.result(...),Match.exception_message(...),Match.exception_cause(...),Match.predicate(...),Match.always(),Match.never()plus theirnot_*twins, composed with the|and&operators.Outcome[T]is the dataclass passed to custom predicates (exception,result,raised). Issue #242. - ✨ Add
grelmicro.providers.redis.RedisProvider. First-class Redis connection holder shared across components:RedisProvider("redis://..."),RedisProvider(host="...", port=...),RedisProvider()(env-driven viaREDIS_*),RedisProvider.from_config(RedisConfig(...)), andRedisProvider.from_client(client, own=False)for bring-your-own clients.Grelmicrodedupes implicit providers by(provider_class, env_prefix), so two adapters with the same prefix share one connection pool. Issue #226. - ✨ Add
grelmicro.providers.postgres.PostgresProvider. First-class Postgres connection holder wrapping anasyncpg.Pool:PostgresProvider("postgresql://..."),PostgresProvider(host=..., database=..., user=..., password=...),PostgresProvider()(env-driven viaPOSTGRES_*),PostgresProvider.from_config(PostgresConfig(...)), andPostgresProvider.from_client(pool, own=False)for bring-your-own pools. Shares the same(provider_class, env_prefix)dedupe asRedisProvider. Issue #255.
Breaking
- 💥 Patterns
RateLimiter,CircuitBreaker, and the FastAPI health router resolve through the activeGrelmicroapp. Add the two new ComponentsRateLimit(wrapsRateLimiterBackend, kind"ratelimiter") andBreaker(wrapsCircuitBreakerBackend, kind"circuitbreaker").Grelmicro.use(...)auto-wraps aRateLimiterBackendorCircuitBreakerBackendinstance into its matching Component.HealthChecksbecomes a Component (kind = "health", defaultname = "default"). Pass it toGrelmicro(uses=[...])and the FastAPIhealth_router()resolves it viaGrelmicro.current(). Delete therate_limiter_backend_registry,circuit_breaker_backend_registry,health_checksregistries plusgrelmicro/_backends.py(BackendRegistry,BackendNotLoadedError,BackendAlreadyRegisteredError). Closes out #201. Issue #261. - 💥 Redis adapters now take
provider=orenv_prefix=, not a positionalurl=.RedisSyncAdapter,RedisCacheAdapter, andRedisRateLimiterAdapterlose theirurl=argument. Passprovider=RedisProvider(...)to share a pool, or rely onenv_prefix=(defaultREDIS_) to build one. Issue #226. - 💥
PostgresSyncAdapternow takesprovider=orenv_prefix=, not a positionalurl=. Passprovider=PostgresProvider(...)to share a pool, or rely onenv_prefix=(defaultPOSTGRES_) to build one. Issue #255. - 💥 Rename
TaskManagertoTasks. Class still extendsTaskRouter, mirroring FastAPI'sAPIRouter←FastAPIshape. Update imports tofrom grelmicro.task import Tasks. Issue #218. - 💥 Rename
HealthRegistrytoHealthChecks(andHealthRegistryConfigtoHealthChecksConfig). Update imports tofrom grelmicro.health import HealthChecks. Issue #201. - 💥 Rename concrete backends to
*Adapter.MemorySyncBackend,RedisSyncBackend,PostgresSyncBackend,SQLiteSyncBackend,KubernetesSyncBackend,MemoryCacheBackend,RedisCacheBackend,MemoryRateLimiterBackend,RedisRateLimiterBackend, andMemoryCircuitBreakerBackendbecome*Adapter. TheSyncBackend,CacheBackend,RateLimiterBackend, andCircuitBreakerBackendProtocols stay as-is. Issue #201. - 💥 Rename nested backoff classes to drop the redundant
Configsuffix.ExponentialBackoffConfig,ConstantBackoffConfig,LinearBackoffConfig,FibonacciBackoffConfig, andRandomBackoffConfigbecomeExponentialBackoff,ConstantBackoff,LinearBackoff,FibonacciBackoff, andRandomBackoff. TheRetryBackoffConfigdiscriminated-union alias and the JSON discriminator (type: "exponential") are unchanged. Issue #239. - 💥 Rename the
Moduleprotocol toComponentto avoid clashing with Python's own "module".ModuleAlreadyRegisteredErrorbecomesComponentAlreadyRegisteredErrorandModuleNotRegisteredErrorbecomesComponentNotRegisteredError. TheSyncandCacheclasses keep their names. No deprecation shim. Issue #233. - 💥 Rename the env-loading flag to align the per-call kwarg and the global env var.
read_env=becomesenv_load=on every component,GREL_CONFIG_FROM_ENVbecomesGREL_ENV_LOAD, and thegrelmicro._config.env_opt_in_enabled()helper becomesenv_load_default(). No deprecation shim. Issue #232. - 💥 Remove the module-level registry and lifespan API.
grelmicro.lifespan()is gone. Theregister/unregister/use/use_backend/use_registryhelpers acrossgrelmicro.{sync,cache,health,resilience}(plus the resilience circuit-breaker variants) are gone. Patterns (Lock,TaskLock,LeaderElection,TTLCache) now resolve their backend viaGrelmicro.current()at every call. Build aGrelmicro(uses=[...])and open it withasync with micro:. Thegrelmicro.sync._backendsandgrelmicro.cache._backendsmodules are removed (sync and cache resolve through the app). The internalrate_limiter_backend_registry,circuit_breaker_backend_registry, andhealth_checksregistries stay private until follow-up issues introduce their Component wrappers. Issue #207. - 💥
Retryoutcome filter is nowwhen=accepting aMatch. The oldon=parameter is gone. TheMatchDSL (Match.exception(...),Match.result(...),Match.exception_message(...),Match.exception_cause(...),Match.always(),Match.never(),Match.predicate(...)) plus theirnot_*twins and the|/&operators cover the common retry-filter surface. Bare-class shorthand is still accepted (when=httpx.HTTPError). Result-based retry lands in the same change:when=Match.result(None)retries until the function stops returningNone. Env var renamedGREL_RETRY_{NAME}_ON→GREL_RETRY_{NAME}_WHEN. Issue #242.
Internal
- ⚡ Defer the
opentelemetryimport ingrelmicro.trace.import grelmicro.traceno longer loadsopentelemetry(was 16 modules). The package is resolved lazily on first call toinstrument,span, oradd_contextand cached. Issue #189.
0.21.0 - 2026-05-06
Breaking
- 💥 Drop Python 3.11. The new floor is
requires-python = ">=3.12". RHEL 9 (App Streampython3.12) and RHEL 10 (default) ship 3.12 and the UBI images are available, so enterprise users are covered. Issue #66. - 💥 Drop AnyIO. grelmicro now targets
asynciodirectly. Issue #183. - 💥
CircuitBreakernow takes a backend (CircuitBreakerBackend). The in-memory backend (MemoryCircuitBreakerBackend) is the default. A future Redis-backed implementation will share state across replicas (issue #188). The async API stays primary, sync code goes throughcb.from_thread. - 💥 The sync adapters on
Lock,TaskLock,TTLCache, andCircuitBreakernow require the backend to be opened (async with backend:orgrelmicro.lifespan()). The backend captures the running loop and the sync adapter dispatches through it. Zero hot-path overhead. - 💥 Resilience registries are now namespaced. The rate limiter registry name moves from
"resilience"to"resilience.ratelimiter"and the circuit breaker registry is"resilience.circuitbreaker".grelmicro.lifespan(exclude=...)now matches by dotted prefix, soexclude={"resilience"}still skips both registries.
Features
- ✨ Add
uvloopto thestandardextra (Linux and macOS). Activate withuvloop.run(main()).
Internal
- ✅ Migrate the test suite from
pytest.mark.anyiotopytest-asynciowithasyncio_mode = "auto". AnyIO is no longer a direct dependency of grelmicro (it may still arrive transitively, for example throughfast-depends). - ♻️ Adopt PEP 695 generic syntax (
class Foo[T]:,def f[T](...),type X = ...) across_backends.py,_config.py,_types.py,health/_types.py,trace/_instrument.py, andtests/task/conftest.py. Two files keep the older form: the recursive aliases in_json.py(ty cannot expand recursive PEP 695 aliases) and the decorator factory incache/cached.py(PEP 695 binds the inner decorator to the outer scope's type parameters, breaking per-decoration-site inference). Issue #65. - 🔨 Bump
tool.ruff.target-versiontopy312and the CI matrix to["3.12","3.13","3.14"].
0.20.0 - 2026-05-03
Live reconfiguration is complete. Every stateful primitive now exposes reconfigure(new_config), so you can hot-reload from a ConfigMap or SIGHUP without restarting the process. See Live reconfiguration for the contract.
Features
- ✨ Add
RateLimiter.reconfigure(new_config). Swap algorithm config without rebuilding the limiter. PR #153. - ✨ Add
reconfigure(new_config)toLock,TaskLock, andLeaderElection. Swap timing fields without restarting. Theworkerfield cannot change. PR #159. - ✨ Add
CircuitBreaker.reconfigure(new_config). Swap thresholds andignore_exceptionswithout restarting. Runtime state andlast_errorare kept.log_levelis applied to the logger. PR #160. - ✨ Add
HealthRegistry.reconfigure(new_config). Swapcache_ttland the defaulttimeoutwithout restarting. Per-check timeouts stay as registered. PR #180.
Docs
- 📝 Reframe README and docs landing as a microservice patterns toolkit. PR #155.
- 📝 Replace "Production-ready" with "Railguarded": 100% pytest coverage, ty-checked, ruff-linted, Pydantic-validated. PR #181.
Internal
- 🔨 Switch build backend to Hatch. PR #155.
- 🎨 Supersample favicon PNGs with Lanczos downscaling for smoother anti-aliasing. PR #156.
0.19.0 - 2026-05-01
Cleans out the long-deprecated APIs (ResilienceException, Synchronization, scheduled(), the token= kwarg) ahead of the 1.0.0 design work, ships a 3.4× speedup on env-driven config construction, and brings the test suite under 20s for contributors.
Breaking
- 💥 The Environmental config path is now opt-in. Set
GREL_CONFIG_FROM_ENV=trueonce at startup to enable env reads across every component, or passread_env=Trueper call. The per-call value (True/False) always wins over the global flag. This stops grelmicro from silently picking up ambient env vars in unit tests or scripts. Issue #142. - 💥 The
read_envkwarg default flips fromTruetoNoneon every component.Nonefollows the global flag.TrueandFalsekeep their meaning as explicit per-call overrides. - 💥 Remove obsolete deprecation shims that were marked for removal in 0.7.0. Replace
ResilienceExceptionwithResilienceError,SynchronizationwithSyncPrimitive, and thescheduled()decorator onTaskRouter/TaskManagerwithinterval(seconds=N, max_lock_seconds=N*5). Thetoken=kwarg onLockAcquireError,LockReleaseError, andLockNotOwnedErroris removed (drop it from your code). Thesync=parameter oninterval()no longer warns when used with non-Lockprimitives.
Internal
- ♻️ Add
grelmicro._config.env_opt_in_enabled()helper that exposes the truthyGREL_CONFIG_FROM_ENVcheck (1,true,yes,on, case-insensitive). Issue #142. - 📝 Document the "no field-mirroring" decision in
docs/architecture/config.mdwith the benchmark numbers frombenchmarks/config_attr_benchmark.py. Closes Issue #113 without code changes: hot-path config reads cost <1% of a real call (~2 ns out of ~250 ns), so we keepself._configas the single source of truth instead of copying frozen fields onto the component. - 🔇 Silence the upstream
testcontainers@wait_container_is_readydeprecation banner via a scopedfilterwarningsentry inpyproject.toml. Replace the unawaitedlambda: sleep(math.inf)mock side-effect intests/sync/test_leaderelection.py::test_leadership_abandon_on_renew_deadline_reachedwith an explicit async helper. The full suite now reports zero warnings. - ⚡ Speed up the test suite from ~73s to ~19s by adding
pytest-xdist(-n autoinaddopts) and shrinking expiration sleeps intests/sync/test_backends.py. Fix--durationsreporting by removing the autousefreeze_timefixture:@freeze_time()decorator stays on the two tests that comparedatetime.now(), the two tests that previously calledfrozen_time.tick(...)switch tomonkeypatch.setattr(circuitbreaker, "monotonic", ...). Issue #125. - ⚡ Cache the dynamic
BaseSettingssubclass built bygrelmicro._config._build_settings_clswith@functools.lru_cache(maxsize=256). The env path ofresolve_confignow reuses the same_<Config>Settingssubclass across calls instead of rebuilding it every time, which makesLock("cart")-style construction ~3.4× faster (232 µs/op → 68 µs/op). The bound is a safety net for long-running processes that might derive prefixes from runtime inputs. Issue #119. - ♻️ Rename the local
parent_configtomerged_configin_build_settings_clsand document why the existing# type: ignorecomments are needed. Issue #127.
0.18.0 - 2026-04-30
M2 milestone closed: backend wiring is now fully explicit. Construction is pure (no global writes), registration is named (<module>.register(backend, "name")), and grelmicro.lifespan(*ad_hoc, exclude=...) walks every registry that has been imported and opens its registered backends in one call. Task-scoped overrides via with <module>.use(...): swap backends per request or per test through contextvars.
Breaking
- 💥 Backend constructors are now pure:
__init__performs no registry writes. Theauto_registerkwarg is removed from every backend and fromHealthRegistry. PR #138. - 💥
BackendRegistry.setis renamedregisterandBackendRegistry.unregisteris added with an identity check.resetremains for test fixtures. PR #138. - 💥
async with backendopens the connection but no longer registers. Callregister(backend)(oruse_backend(backend)) to register, or open everything at once withgrelmicro.lifespan(). PR #139. - 💥
BackendRegistryis now multi-name:register(backend, name="default"),unregister(name, backend=None),get(name="default"). PR #139. - 💥 The sync registry name changed from
"lock"to"sync"(used in error messages andlifespan()exclude keys). The rate limiter registry changed from"rate_limiter"to"resilience". PR #139. - 💥 Overwriting a registered name with a different instance now raises
BackendAlreadyRegisteredError(was: warning + replace). Re-registering the same instance stays a no-op. PR #139.
Features
- ✨ Add
grelmicro.sync.use_backend,grelmicro.cache.use_backend,grelmicro.resilience.use_backend, andgrelmicro.health.use_registryfor explicit, idempotent process-lifetime registration. PR #138. - ✨
grelmicro.lifespan(*ad_hoc, exclude=...)opens every registered backend across every imported module in one call, with reverse-order shutdown. PR #139. - ✨ Per-module helpers
register,unregister,use_backend,useongrelmicro.sync,grelmicro.cache,grelmicro.resilience(anduse_registry,useongrelmicro.health). PR #139. - ✨ Task-scoped overrides via
<module>.use(backend)or<module>.use(default=a, analytics=b). Stacks LIFO viacontextvarsfor per-test and per-request substitution. PR #139. - ✨ Primitives accept
backend=as either a backend instance or a registered name (Lock("audit", backend="analytics")). The registry is consulted on each call so<module>.use(...)overrides apply. PR #139. - ✨ Registries subscribe themselves on import:
lifespan()walks only modules that are actually imported, so unused components have zero RAM cost and zero startup work. PR #139. - ✨ Lookup falls back to the sole registered entry when no
"default"is named, so the single-backend case stays one-call. PR #139.
0.17.0 - 2026-04-29
Breaking
- 💥
CircuitBreakerconfig moves to a frozenCircuitBreakerConfig. Read it viacb.config. PR #132. - 💥 The mutable attributes
cb.error_threshold,cb.success_threshold,cb.reset_timeout,cb.half_open_capacity,cb.ignore_exceptions,cb.log_levelare removed. Construct a newCircuitBreakerto change config. PR #132. - 💥 Rename
grelmicro.loggingtogrelmicro.logandgrelmicro.tracingtogrelmicro.trace. Avoids shadowing stdlibloggingand aligns with the OpenTelemetry /ddtracetrace(singular) convention. Update imports:from grelmicro import log, trace. PR #135. - 💥
configure_logging()is renamedlog.configure(). Uselog.configure_with(config)for the declarative path. Both return the appliedLoggingConfig. PR #135. - 💥
LoggingSettings(theBaseSettingsshadow class) is removed.LoggingConfigis the config class. Env reading happens insidelog.configure(). PR #135. - 💥
LoggingConfigfield names move to lowercase:LOG_BACKEND→backend,LOG_LEVEL→level,LOG_FORMAT→format,LOG_TIMEZONE→timezone,LOG_JSON_SERIALIZER→json_serializer,LOG_CALLER_ENABLED→caller_enabled,LOG_OTEL_ENABLED→otel_enabled. PR #135. - 💥 Env vars move from
LOG_*toGREL_LOG_*to align with the rest of the library. PR #135. - 💥
LoggingSettingsValidationErroris removed.pydantic.ValidationErrorpropagates fromlog.configure()like every other component. PR #135.
Features
- ✨ Add
CircuitBreakerConfigandCircuitBreaker.from_config(name, config). PR #132. - ✨
CircuitBreakerreadsGREL_CIRCUIT_BREAKER_<NAME>_*env vars and acceptsenv_prefix=/read_env=. PR #132. - ✨
ignore_exceptionsaccepts fully-qualified import strings ("builtins.ValueError") so YAML and env loaders can specify exception types. PR #132. - ✨ Env vars for tuple/list fields accept comma-separated values in addition to JSON arrays. PR #132.
- ✨
log.configure(**kwargs)accepts everyLoggingConfigfield as a kwarg, mirroring the three-paths contract used by other components. PR #135. - ✨
log.configure_with(config)is the declarative entry point. Returns the appliedLoggingConfig. PR #135.
Internal
- ♻️ Add
grelmicro/_types.pyfor shared lightweight type aliases (LogLevel). PR #132. - ♻️ Add
grelmicro/_config.py::parse_csv_or_jsonshared utility for env var list parsing. PR #132.
Docs
- 🎨 Switch logo typeface from Funnel Sans to Funnel Display.
0.16.1 - 2026-04-29
Internal
- ✅ "No registry call at construction" tests now patch the registry source instead of the per-module import alias, so a future refactor that bypasses the local alias can no longer silently pass the check. PR #130.
- ⬆️ Bump
tyfrom 0.0.29 to 0.0.30. PR #111. - ⬆️ Pre-commit autoupdate. PR #114.
0.16.0 - 2026-04-29
Breaking
- 💥
LockConfig,TaskLockConfig,LeaderElectionConfig, andRateLimiterConfigno longer carry anamefield. Pass the name positionally:Lock("cart", LockConfig(lease_duration=30)). PR #123. - 💥 Rename
TokenBuckettoTokenBucketConfigandGCRAtoGCRAConfig.RateLimiterConfigbecomes the discriminated union of algorithm configs. PR #123. - 💥
RateLimitertakes the algorithm config positionally:RateLimiter("api", GCRAConfig(limit=100, window=60)). Thealgorithm=,limit=,window=kwargs are removed. PR #123. - 💥
fail_openmoves fromRateLimiter(...)to the algorithm config. PR #123.
Features
- ✨ Add
Component.from_config(name, config)to every primitive (Lock,TaskLock,LeaderElection,RateLimiter,HealthRegistry,RateLimitFilter,DuplicateFilter). PR #123. - ✨ Read environment variables under
GREL_<COMPONENT>_<NAME>_*for every component that supports the environmental path. PR #123. - ✨ Add
RateLimiter.token_bucket(name, ...)andRateLimiter.gcra(name, ...)factory classmethods. PR #123. - ✨ Add
env_prefix=andread_env=kwargs to every component that exposes the environmental path. PR #123. - ✨ Normalise instance names like
payments-eu,cart.v2, orweather/svcinto POSIX env var segments. PR #123.
Changed
- ♻️
Lock,TaskLock,LeaderElection, andRateLimiternow resolve the backend lazily on first use instead of at construction.BackendNotLoadedErrorsurfaces on the firstacquire/peek/resetcall rather than in__init__. Each component exposes a publicbackendproperty. PR #128.
Fixed
- 🐛 Auto-registered backends now identity-check before clearing the registry on
__aexit__, so a replacement instance is left alone. PR #122. - 🐛
Lock.releaseclears local ownership only after the backend confirms the release. PR #122.
0.15.0 - 2026-04-29
Breaking
- 💥 Redesign the
healthmodule:@health.check("name")decorator, binaryok/errorstatus, empty probe bodies, per-check caching. PR #112. - 💥 Endpoint renames:
/health/live→/livez,/health/ready→/readyz. New/healthzreturns the full check JSON. PR #112. - 💥
HealthRegistry.check()renamed torun(). Thecheckname is now the decorator. PR #112. - 💥
HealthCheckerProtocol removed. Use plaindeforasync deffunctions. PR #112. - 💥
HealthReport.components: listbecomesHealthReport.checks: dict[name, ...]. PR #112. - 💥
HealthCheckTimeoutErrorand the three-stateHealthStatusremoved. PR #112.
Docs
- 📝 Restate the versioning policy: pre-1.0
MINORmay break,PATCHnever. Post-1.0 deprecations get twoMINORreleases.
0.14.3 - 2026-04-22
Docs
- 🐛 Fix the wordmark duplicating on PyPI and other renderers that don't understand GitHub's theme-only URL fragments. PR #109.
0.14.2 - 2026-04-22
Docs
- 🐛 Fix the landing-page wordmark disappearing when the docs site is toggled into dark mode. PR #108.
- 📝 Centre the badges row under the tagline. PR #108.
0.14.1 - 2026-04-22
Docs
- 🎨 Ship the grelmicro brand identity: wordmark, favicon, and social-preview card. PR #106.
- 🎨 Refresh the docs theme with the brand palette. PR #106.
- 📝 Rewrite the "Why grelmicro" pillars. PR #106.
- 📝 Split the resilience docs into per-pattern pages.
- 📝 Add an Installation guide with
pip,uv, andpoetrytabs. - 📝 Render PEP 727
Annotated[..., Doc(...)]parameter docs viagriffe-typingdoc. - 📝 Plain-English pass on docs and docstrings for non-native readers.
- 📝 Add a Mermaid state diagram to the Circuit Breaker page.
- 📝 Document every
__all__symbol in the API reference. - 📝 Add a plain-English style guide to
CONTRIBUTING.md.
Internal
- 🐛 De-flake
test_lock_reentrant_from_threadon Python 3.12. Fixes #105. - 🔧 Add keywords to
pyproject.tomlfor PyPI discovery.
0.14.0 - 2026-04-21
Features
- ✨ Add pluggable
RateLimiteralgorithms via thealgorithm=parameter:TokenBucketandGCRA. PR #102. - ✨ Add
MemoryTokenBucket, a standalone synchronous token-bucket primitive. PR #102. - ✨ Add
RateLimitFilter, alogging.Filterwith configurablekey_mode. PR #102. - ✨ Add
DuplicateFilter, alogging.Filterthat caps repeated records per key with optional TTL. PR #94. - ✨
HealthRegistrynow logs every unhealthy path atWARNING(ERRORfor unexpected exceptions). PR #92.
Deprecations
- 🗑️
RateLimiter(name, limit=..., window=...)is deprecated. UseRateLimiter(name, algorithm=GCRA(limit=..., window=...))instead. Will be removed in 0.15.0. PR #102.
Docs
- 📝 Add
CONTRIBUTING.mdwith repo conventions. PR #102. - 📝 Add a "Choosing an algorithm" guide for
TokenBucketvsGCRAin the Rate Limiter docs. PR #102. - 📝 Surface
THIRD_PARTY_NOTICES.mdin the docs site. PR #102.
Security
- 🔒️ Harden CI supply chain: pin all Actions to SHAs, close
run:injection vectors, add zizmor workflow-lint, restrict Dependabot auto-merge to uv patch/minor updates. PRs #95, #100, #101.
Internal
- ⬆️ Bump
pydanticto 2.13.0,opentelemetry-api/opentelemetry-sdkto 1.41.0,pytestto 9.0.3,ruffto 0.15.10,tyto 0.0.29,fastapito 0.135.3,uvicornto 0.44.0. PR #99. - ⬆️ Bump
pydantic-extra-typesfrom 2.11.1 to 2.11.2. PR #89. - ⬆️ Pre-commit
ruffautoupdate (v0.15.9 → v0.15.11). PR #91. - ⬆️ Bump
codecov/codecov-actionto v6. PR #96. - ⬆️ Bump
astral-sh/setup-uvto v8. PR #97. - ⬆️ Bump
dependabot/fetch-metadatato v3. PR #98.
0.13.0 - 2026-04-08
Features
- ✨ Add
RateLimiter.peek(key): check rate limit state without consuming tokens. PR #90. - ✨ Add
RateLimiter.reset(key): delete rate limit state for a key, restoring full quota. PR #90. - ✨ Add
fail_openparameter toRateLimiter: return allowed result on backend errors instead of propagating exceptions. PR #90.
0.12.0 - 2026-04-07
Features
- ✨ Add
healthmodule with health check registry, concurrent checker execution, and FastAPI integration for liveness/readiness probes. PR #84.
Internal
- ⬆️ Bump orjson from 3.11.7 to 3.11.8. PR #72.
- ⬆️ Bump ty from 0.0.26 to 0.0.27. PR #74.
- ⬆️ Update uv-build requirement from
<0.10.0to<0.12.0. PR #75. - 👷 Add build provenance attestations and wheel verification to release pipeline.
- ♻️ Pre-release cleanup: add health/json to overview, fix style inconsistencies, remove stale branches.
0.11.0 - 2026-04-03
Breaking Changes
- 💥 Logging: split
callerinto separatelogger(logger name) andcaller(function:line) fields.calleris now opt-in viaGREL_LOG_CALLER_ENABLED(default:False), following common structured-logging conventions. Uvicorn formatter never includescaller. - 💥 Cache: replace
TTLCacheserializer/deserializercallable pair with a singleserializeraccepting aCacheSerializerprotocol object. UseJsonSerializer(),PydanticSerializer(Model), orPickleSerializer()instead.
Features
- ✨ Add
GREL_LOG_CALLER_ENABLEDsetting to opt in to caller info (function:line) in log records. Disabled by default for cleaner logs and better performance. - ✨ Add
loggerfield (logger name, e.g.,myapp.api) to all log records across all backends and formats. - ✨ Add
grelmicro.jsonmodule with fast JSON serialization usingorjsonwhen available, with automatic fallback to stdlibjson.
0.10.0 - 2026-04-02
Features
- ✨ Add
RateLimiterto theresiliencemodule: Redis-backed sliding-window rate limiting using the GCRA algorithm. IncludesRateLimitResultwith fields mapping to IETF rate limit headers, weighted requests viacostparameter, andRateLimitExceededError.
Removals
- 🗑️ Remove deprecated
UvicornJSONFormatterandUvicornAccessJSONFormatter. UseUvicornFormatterandUvicornAccessFormatterinstead (deprecated since 0.9.1).
CI
- ⚡ Migrate PyPI publishing from API token to OIDC trusted publishing.
0.9.1 - 2026-04-01
Deprecations
- 🗑️
UvicornJSONFormatterandUvicornAccessJSONFormatterare deprecated. UseUvicornFormatterandUvicornAccessFormatterinstead. The new formatters respectGREL_LOG_FORMATinstead of always producing JSON. Old names kept as aliases withDeprecationWarning.
0.9.0 - 2026-04-01
Breaking Changes
- 💥
GREL_LOG_FORMATdefault changed fromJSONtoAUTO. In production (non-TTY), behavior is identical (JSON output). In local dev (TTY), output switches to human-readableTEXTwith colors. SetGREL_LOG_FORMAT=JSONexplicitly to restore the previous default.
Features
- ✨ Add
AUTOlog format (new default): detects TTY and selectsTEXT(terminal) orJSON(piped/CI). - ✨ Add
LOGFMTlog format: key-value pairs following the logfmt convention, 30-40% smaller than JSON. - ✨ Add
PRETTYlog format: multi-line indented output with structured error rendering. - ✨ Enhanced
TEXTformat: now includes extra context fields askey=valuepairs and supports ANSI colors. - ✨ Add
NO_COLOR/FORCE_COLORenvironment variable support following no-color.org standard.
0.8.0 - 2026-04-01
Breaking Changes
- 💥 Backend imports moved to submodules. Use
from grelmicro.sync.redis import RedisSyncBackendinstead offrom grelmicro.sync import RedisSyncBackend. Same for all sync, cache, and logging backends. See Import Strategy.
Features
- ✨ Add Uvicorn JSON formatters (
UvicornJSONFormatter,UvicornAccessJSONFormatter) for structured logging viadictConfig.
0.7.0 - 2026-03-31
Breaking Changes
- 💥 Logging JSON format redesigned to follow industry standards:
loggerrenamed tocallerthreadremovedctxremoved: extra fields are now flat at the top levelexceptionreplaced by structurederrorobject (type,message,stack)
Features
- ✨ Add
tracingmodule with@instrumentdecorator,span()context manager, andadd_context()for unified logging and OTel instrumentation.
Performance
- ⚡ Logging: Up to +23% throughput across all backends.
- ⚡ Use
OrderedDictfor O(1) LRU operations inTTLCache.
Refactors
- ♻️ Extract shared Redis config into
grelmicro/_redis.py. - ♻️ Make
TTLCachegeneric and addDocannotations. - ♻️ Extract context stack into
grelmicro/_context.pyto decouple logging from tracing. - ♻️ Filter private (
_-prefixed) attributes from stdlib JSON log output. - ♻️ Widen
@instrument(skip=...)type fromset[str]toAbstractSet[str].
Removals
- 🗑️
Synchronizationprotocol removed. UseSyncPrimitiveinstead (deprecated since 0.6.0). - 🗑️
ResilienceExceptionremoved. UseResilienceErrorinstead (deprecated since 0.6.0). - 🗑️ The
tokenparameter on lock errors removed (deprecated since 0.6.0). - 🗑️ The
syncparameter oninterval()removed (deprecated since 0.6.0). - 🗑️ The
scheduled()decorator removed (deprecated since 0.6.0).
0.6.0 - 2026-03-30
Deprecations
- 🗑️
Synchronizationprotocol renamed toSyncPrimitive. The old name still works but emits aDeprecationWarning. Will be removed in 0.7.0. - 🗑️
ResilienceExceptionrenamed toResilienceError. The old name still works but emits aDeprecationWarning. Will be removed in 0.7.0. - 🗑️ The
tokenparameter onLockAcquireError,LockReleaseError, andLockNotOwnedErroris deprecated. Tokens are no longer included in error messages for security. Will be removed in 0.7.0. - 🗑️ The
syncparameter oninterval()forTaskLockandLeaderElectionis deprecated. Usemax_lock_secondsandleaderparameters instead. Will be removed in 0.7.0. - 🗑️ The
scheduled()decorator is deprecated. Useinterval()withmax_lock_secondsorleaderinstead. Will be removed in 0.7.0.
Features
- ✨ Add in-memory TTL cache with LRU eviction, per-key stampede protection, and
@cacheddecorator. - ✨ Add
RedisCacheBackendfor distributed cache storage. - ✨ Add cache statistics via
CacheInfo(hits, misses, evictions, stampedes). - ✨ Add Kubernetes sync backend using Lease resources (
pip install grelmicro[kubernetes]). - ✨ Add SQLite sync backend for home lab and local testing (
pip install grelmicro[sqlite]).
Security
- 🔒️ Remove token values from lock error messages to prevent leaking in logs.
- 🔒️ Upgrade
requeststo 2.33.0 (CVE fix in transitive dependency).
Refactors
- ♻️ Unify error hierarchy under
GrelmicroErrorbase class. All module errors (SyncError,ResilienceError,LoggingError,TaskError,CacheError) now share a common base. - ♻️ Use server-side timestamps and native Lease fields in sync backends.
- ♻️ Simplify token generation from UUID-based to string concatenation.
- ♻️ Harden TaskLock token nonce and error handling.
Internal
- ✅ Achieve 100% library code coverage.
- 💚 Fix flaky integration test timeout in CI.
- ⬆️ Bump dependencies and fix ty v0.0.26 type errors.
Docs
- 📝 Add cache module documentation with usage guide and API reference.
- 📝 Add Kubernetes Backend Architecture page.
- 📝 Add SQLite Backend Architecture page.
- 📝 Add backend comparison matrix to Coordination guide.
- 📝 Rewrite README with project vision.
0.5.0 - 2026-03-17
Breaking Changes
- 💥 Add namespace prefix to sync primitive backend keys (
lock:,tasklock:,leader:). See Migration Guide below.
Features
- ✨ Add
TaskLock.from_threadthread-safe adapter. PR #57. - ✨ Add specific lock error classes (
LockAcquireError,LockReleaseError,LockLockedCheckError,LockOwnedCheckError,LockReentrantError). PR #57.
Refactors
- ♻️ Consolidate distributed lock and leader gating into the
interval()decorator viamax_lock_secondsandleaderparameters. PR #54.
Docs
- 📝 Add Coordination Architecture page. PR #57.
Internal
- ⬆️ Bump redis, fastapi, pydantic, and pydantic-settings. PR #55.
- ⬆️ Update pre-commit hooks. PR #50.
Migration Guide
Namespace-Prefixed Backend Keys
Prior versions used the name parameter directly as the backend key. Now each primitive adds a type-specific prefix:
| Primitive | Name | Backend Key |
|---|---|---|
Lock("my-resource") |
my-resource |
lock:my-resource |
TaskLock("cleanup") |
cleanup |
tasklock:cleanup |
LeaderElection("main") |
main |
leader:main |
Existing locks stored in Redis or PostgreSQL will no longer match after upgrading. A running instance on the old version and one on the new version will not see each other's locks.
Upgrade all running instances together so they use the same key format. Old keys expire automatically via their lease duration (Redis PEXPIRE / PostgreSQL expire_at).
0.4.1 - 2026-03-13
Docs
- 📝 Add Task Lock to synchronization primitives guide.
Internal
- ⬆️ Bump actions/checkout to v6 and astral-sh/setup-uv to v7.
0.4.0 - 2026-03-13
Features
- ✨ Add
TaskLockfor distributed task locking with auto-renewal. - ✨ Add
GREL_LOG_TIMEZONEsupport for configurable timezone in logging output. - ✨ Add OpenTelemetry trace context injection into log records.
- ✨ Add
structlogas alternative logging backend. - ✨ Add configurable JSON serializer (
json/orjson) for logging.
Docs
- 📝 Add logging benchmark and performance documentation.
Internal
0.3.2 - 2026-01-27
Internal
- 👷 Migrate from mypy to Astral ty for type checking. PR #45.
- 🔧 Add Python 3.14 support. PR #47.
- 🔧 Switch build system to
uv_build. PR #49. - 💚 Simplify CI and release workflow. PR #24.
0.3.1 - 2025-06-05
Docs
- 📝 Add resilience patterns section and update links in README and index.
Internal
- 💚 Fix release pipeline and GitHub Pages deployment permissions.
0.3.0 - 2025-06-05
Features
- ✨ Add Circuit Breaker resilience pattern. PR #18.
Docs
- 📝 Refactor code examples to use snippets.
Internal
0.2.3 - 2024-12-04
Features
- ✨ Add Redis key prefix support to avoid conflicts in shared instances.
- ✨ Add Redis and PostgreSQL settings management from environment variables.
0.2.2 - 2024-11-28
Features
- ✨ Add PostgreSQL backend configuration from environment variables.
Internal
0.2.1 - 2024-11-26
Internal
- 💚 Set up release workflow with version tagging.
0.2.0 - 2024-11-26
First public release.
Features
- ✨ Add distributed
Lockwith lease-based expiration. - ✨ Add
LeaderElectionfor single-leader task execution. - ✨ Add
IntervalTaskscheduler for periodic tasks with synchronization support. - ✨ Add Redis, PostgreSQL, and in-memory synchronization backends.
- ✨ Add logging module with JSON and TEXT formatting via
GREL_LOG_LEVELandGREL_LOG_FORMATenvironment variables.
Docs
- 📝 Add MkDocs documentation site with Material theme.
Internal
- 👷 Add unified CI workflow with linting, testing, and coverage.