Repository navigation
docs: bring the pages up to date with celeris v1.6.0 - #113
Draft
FumingPower3925 wants to merge 3 commits into
Draft
FumingPower3925 wants to merge 3 commits into
FumingPower3925 wants to merge 3 commits into
Conversation
…own contract, busy poll, drivers) The v1.6.0 changes that landed after the last docs sweep, each checked against celeris main (42f096e0): TCP_DEFER_ACCEPT and DisableDeferAccept, Config.SocketBusyPoll (off by default) and how the drivers follow it, the epoll 25 ms sweep timer, the monotonic timeout clock, the per-engine Shutdown contract by connection state, Connection: close after Shutdown, the stuck-loop wedge bound, and the redis, postgres and memcached driver timeouts and lifecycle fixes. Also corrects three statements the code does not match: the epoll sweep interval (25 ms, not 0.1 s), the HTTP/2 window wait being an absolute WriteTimeout deadline (it is a minimum rate), and PauseAccept/ResumeAccept working on adaptive (they return ErrAcceptControlNotSupported there).
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: true
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. |
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
goceleris-docs | a5ea41d | Commit Preview URL Branch Preview URL |
Nov 04 2026, 01:54 AM |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
…eep, colocation, accept control) and add the HTTP/2 deadlines, static Root and dotfiles, cache SetTimeout
…eFromDir, WriteTimeout example, version markers, cache SetTimeout)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Brings the pages up to date with what landed in celeris for v1.6.0 (celeris
mainat 42f096e0, https://github.com/goceleris/celeris). The site has no release-notes or migration page and its sidebar groups have no slot for one, so the changes go where each topic already lives, marked inline the way the site already does ("Since celeris v1.6.0", "Upgrading to v1.6.0"). No CHANGELOG (the docs repo has none). Celeris PRs and issues below are written asgoceleris/celeris#N; nothing here closes them.Statements come from the celeris godoc (
config.go,server.go,driver/*,internal/mono,internal/engine/iouring/probe.go), the celerisREADME.md("Busy polling (opt-in)") and the merged PR bodies. Numbers are the PRs' own measurements and are worded as such; none are invented.Changes
TCP_DEFER_ACCEPTdefault (about 1 s) andDisableDeferAccept; silent-connection boundReadHeaderTimeout), engines (Epoll), performance (knobs)Config.DisableDeferAccept,Config.ReadHeaderTimeoutgodoc; goceleris/celeris#1193ReadHeaderTimeout: -1; io_uring sweep about 0.8 sConfig.ReadTimeoutgodoc; goceleris/celeris#1197 (before/after table)internal/mono), suspend caveatinternal/monopackage doc; goceleris/celeris#1188 (release note, "Behaviour to know"), #1177Shutdownper-engine contract by connection state (idle, request in progress, begun-but-incomplete head / bare CRLF, head in the kernel, silent)Server.Shutdowngodoc; goceleris/celeris#1208, #1220, #1226, #1243, #1253, #1225Server.Shutdowngodocnilat the deadline does not mean nothing was cutServer.Shutdowngodoc; goceleris/celeris#1225Connection: closeon every HTTP/1 response afterShutdownShutdownends its connection")Server.Shutdowngodoc; goceleris/celeris#1169PauseAcceptlingers about 1.5 s with defer-accept on;DisableDeferAcceptcloses at onceServer.PauseAcceptgodocmax(WriteTimeout/2, 2 s) + WriteTimeoutConfig.WriteTimeoutgodoc; goceleris/celeris#1202Config.SocketBusyPoll(off by default, was 50 µs), validation errorConfig.SocketBusyPollgodoc,internal/resource/config.go(Validate); goceleris/celeris#1227SocketBusyPoll; redisConfig.SocketBusyPoll/WithSocketBusyPoll; postgresConnector.WithSocketBusyPoll; memcached has none; the v1.5 behaviour tableServer.SocketBusyPollgodoc; goceleris/celeris#1233 PR bodyDialTimeoutdriver/redisConfig.DialTimeoutgodoc; goceleris/celeris#1209ErrCrossSlot; MOVED herd shares topology reads (200 to 2-6CLUSTER SLOTS, the PR's fake-cluster measurement)ClusterClient.Subscribe/SSubscribegodoc; goceleris/celeris#1154, #1210, #1211, #1215ClusterClient)SentinelClient.Closecancels and waits;NewSentinelClientdiscovery bounded at (N+1) xDialTimeoutSentinelClient.Close/NewSentinelClientgodoc; goceleris/celeris#1247, #1251, #1252connect_timeoutbounds dial plus startup, 10 s default when absent,=0none, negative rejectedOptions.ConnectTimeoutgodoc; goceleris/celeris#1216, #1223DialTimeout;Config.Timeoutper operation (3 s, negative none)Config.DialTimeout/Config.Timeoutgodoc; goceleris/celeris#1217, #1222probe.go(logPending); goceleris/celeris#1201, #1198ReadTimeoutper request (408 +RST_STREAM(NO_ERROR), uploads must fit),ReadHeaderTimeoutheader block (GOAWAY(ENHANCE_YOUR_CALM)),IdleTimeoutignores PINGsConfig.ReadTimeout/Config.ReadHeaderTimeoutgodoc; goceleris/celeris#1150WriteTimeout), no ceilingConfig.WriteTimeoutgodoc; goceleris/celeris#1119Rootof././now serves the tree below it; hidden files not served by default (Dotfiles); filesystem root refused unlessAllowFilesystemRoot;Server.Statichas no opt-outStatic,static.Configtable, pitfalls)Server.Staticgodoc,middleware/staticConfig.Root/Dotfiles/AllowFilesystemRootgodoc; goceleris/celeris#1152..segments no longer serves files above it (v1.3.3 through v1.5.11); devices, FIFOs and sockets not served;Staticmissing file is 404 (was 500)Static)Server.Static,Context.FileFromDirgodocFileFromDirkeeps serving hidden files and accepts abaseDirof././//(v1.6.0)Context.FileFromDirgodoc; goceleris/celeris#1152Config.SetTimeout(new, default 1 s; an ignoring store may still write later;MemoryStore/MemoryKVunbounded)middleware/cacheConfig.SetTimeoutgodoc; goceleris/celeris#1151Corrections to existing text (not in the brief)
Config.WriteTimeoutgodoc, epoll: the 25 ms sweep timer is armed on every loop, whatever the timeouts are (Refs #1194) celeris#1197).ReadTimeoutandIdleTimeoutonly.WriteTimeoutis judged in windows that end at a sweep (Config.ReadTimeoutgodoc), so a 1 sWriteTimeoutclosed a client that reads nothing at about 2 s in epoll: the 25 ms sweep timer is armed on every loop, whatever the timeouts are (Refs #1194) celeris#1197's measurement. Reworded.WithEngineall driver FDs land on the server's worker goroutine; it now matches the busy-poll table (only Pub/Sub andConnectorconnections do on a started native server; commands and thePooluse netpoll; standalone loop beforeStartor on std). Sources:driver/redis/options.go(Config.SocketBusyPoll),driver/internal/eventloop/registry.go(Resolve).WriteTimeout"for the whole response: progress does not extend it". Since engines: HTTP/2 WriteTimeout bounds a response that waits for the client's window, as a minimum rate: stage 2 of the per-stream deadlines (v1.6.0, Refs #889) celeris#1167 and #1180 it is a minimum rate with no ceiling; the paragraph now states the headline rule (the wedge bound above needs it) and not the full rule (Config.WriteTimeoutgodoc).PauseAccept/ResumeAcceptwork onadaptive. TheServer.ResumeAcceptgodoc says the Adaptive engine does not implement accept control and the calls returnErrAcceptControlNotSupported, andinternal/adaptive/port_hold_internal_616_linux_test.gosays the same. Since adaptive is the Linux default, a user must selectepollorio_uringto pause.Where the brief and the source differ
Server.Shutdowngodoc says std reads the head afterShutdownbegan and drops it: the connection is closed without an answer, and reset only if body bytes are still unread (2 KiB measured gives a FIN, 64 KiB a reset). The page follows the godoc.ReadHeaderTimeout > 0and the io_uring probes were cached withsync.Oncethere;DisableDeferAcceptandSocketBusyPollare absent from v1.5.11'sconfig.go.Not documented / not placed
Test Plan
bun install --frozen-lockfilebun run validate(9 cells, 0 errors)bun run build(data layer,astro build, pagefind: 28 pages)bun run check(0 errors, 0 warnings)bun test(29 pass; includes the symbol-citation ratchet, no.go:Nlocators added)dist/docs/*: every link and anchor this PR adds resolves