📦 go-chi / httprate-redis

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43package httprateredis

import (
	"time"

	"github.com/redis/go-redis/v9"
)

type Config struct {
	Disabled bool `toml:"disabled"` // default: false

	WindowLength time.Duration `toml:"window_length"` // default: 1m
	ClientName   string        `toml:"client_name"`   // default: ""
	PrefixKey    string        `toml:"prefix_key"`    // default: "httprate"

	// OnError lets you subscribe to all runtime Redis errors. Useful for logging/debugging.
	OnError func(err error)

	// Disable the use of the local in-memory fallback mechanism. When enabled,
	// the system will return HTTP 428 for all requests when Redis is down.
	FallbackDisabled bool `toml:"fallback_disabled"` // default: false

	// Timeout for each Redis command after which we fall back to a local
	// in-memory counter. If Redis does not respond within this duration,
	// the system will use the local counter unless it is explicitly disabled.
	FallbackTimeout time.Duration `toml:"fallback_timeout"` // default: 100ms

	// OnFallbackChange lets subscribe to local in-memory fallback changes.
	OnFallbackChange func(activated bool)

	// Client if supplied will be used and the below fields will be ignored.
	//
	// NOTE: It's recommended to set short dial/read/write timeouts and disable
	// retries on the client, so the local in-memory fallback can activate quickly.
	Client    redis.UniversalClient `toml:"-"`
	Host      string                `toml:"host"`
	Port      uint16                `toml:"port"`
	Password  string                `toml:"password"`   // optional
	DBIndex   int                   `toml:"db_index"`   // default: 0
	MaxIdle   int                   `toml:"max_idle"`   // default: 5
	MaxActive int                   `toml:"max_active"` // default: 10
}