Skip to content

Follow-ups from docs#73: the graceful-shutdown pages say a cancel behaves identically on every engine, and that ShutdownTimeout bounds only the hooks #738

Description

@FumingPower3925

Follow-ups from goceleris/docs#73 (#673's docs), left open under the maintainer's two-round review cap (2026-09-27). CodeRabbit left two MINOR threads on docs#73. Both claims were checked against the docs at head 15a75d2 and celeris main fee0d1c, and both hold. They are tracked here instead of in that PR. Both sit where #703 will change the rule (today hook timing and the drain differ by engine), so the #703 lane should fix the text together with its fix.

1. graceful-shutdown.md:24-26 (at 15a75d2) says a cancelled context "behaves identically across std and the native Linux engines".

2. Config.ShutdownTimeout is described as applying only to the hook phase, and getting-started promises every request finishes.

  • graceful-shutdown.md, the "Entry points at a glance" rows for StartWithContext and StartWithListenerAndContext, say the timeout is "applied to the hook phase".
  • On std and adaptive the watcher's Shutdown uses one context, bounded by ShutdownTimeout, for the engine drain and then every hook (celeris server.go listenUntilCancelled, then shutdown). The same page's note, "The shutdown context is shared across the engine drain and every hook", already says so.
  • getting-started.md:191-192 (the code comment) and 200-201 say StartWithContext returns "after in-flight requests have finished". When the deadline expires first, the engine closes the remaining connections (engine contract, celeris engine/engine.go), so those requests do not finish.
  • Fix: describe ShutdownTimeout as one deadline shared by the drain and the hooks on std and adaptive, and say the drain is attempted within it rather than promising every request finishes.
  • Thread: docs: EngineMetrics.Throughput always reads 0; the parser is not SIMD (celeris#653, celeris#424) docs#73 (comment)

3. graceful-shutdown.md cites stale celeris/server.go line numbers. (CodeRabbit MINOR on docs#73 head 141386b.)

  • The entry-point table cites celeris/server.go:354, 367, 705, 716, 771, and the FAQ cites server.go:777-780. At celeris main fee0d1c, Start is at 390, Shutdown at 453, StartWithListener at 855, StartWithListenerAndContext at 870, listenUntilCancelled at 899 (the 30 s default at 901-903) and StartWithContext at 974.
  • The page's other locators (for example server.go:515-540 for PauseAccept and 748-763 for InheritListener) predate the v1.6.0 changes too.
  • Fix: refresh every server.go locator on the page against the release commit, or cite symbols instead of line numbers, as the rest of the docs#73 text does (for example celeris/server.go (Shutdown)).
  • Thread: docs: EngineMetrics.Throughput always reads 0; the parser is not SIMD (celeris#653, celeris#424) docs#73 (comment)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions