Skip to content

Timeout ​

Added: v1.3.0

Sets a context deadline on each request. Downstream operations that respect context cancellation (database queries, HTTP calls) will cancel cleanly when the deadline is exceeded.

Usage ​

go
r.Use(middleware.Timeout(30 * time.Second))

Custom Duration ​

go
r.Use(middleware.Timeout(5 * time.Second))

With Config ​

go
r.Use(middleware.TimeoutWithConfig(middleware.TimeoutConfig{
    Duration: 5 * time.Second,
    Skipper:  zen.SkipPrefixes("/long-running"),
}))

Or start from defaults and modify:

go
cfg := middleware.DefaultTimeoutConfig()
cfg.Duration = 5 * time.Second
cfg.Skipper = zen.SkipPrefixes("/long-running")

r.Use(middleware.TimeoutWithConfig(cfg))

Options ​

OptionDefaultDescription
Duration30sMaximum time a request can take
SkippernilSkip timeout for matching requests

Released under the MIT License.