abuse

type Action int

type ClientImpact struct {
	Client     string `json:"client"`
	Requests   int    `json:"requests"`
	WouldBlock int    `json:"would_block"`
	// TopReason is the reason that blocked this client most often.
	TopReason string `json:"top_reason"`
}

type Clock func() int64

type Counters struct {
	// contains filtered or unexported fields
}

type Decision struct {
	Action Action
	Reason Reason
	// RetryAfter is whole seconds, at least 1, set only for rate limit blocks.
	RetryAfter int
}

type Engine struct {
	// contains filtered or unexported fields
}

type FieldError struct {
	Field   string `json:"field"`
	Message string `json:"message"`
}

type Limiter struct {
	// contains filtered or unexported fields
}

type Limits struct {
	MaxRPS            float64
	MaxBurst          int
	MaxDenyEntries    int
	MaxAgentEntries   int
	DefaultRPS        float64
	DefaultBurst      int
	MaxTrackedClients int
	Shards            int
	IdleEvict         time.Duration
	MaxRetryAfter     time.Duration
	DryRunDefault     time.Duration
	DryRunMax         time.Duration
	DryRunTop         int
	// SuggestShare is the fraction of the app's peak request rate one client
	// may use before the suggested limit bites; SuggestBurstSeconds sizes the
	// suggested burst as that many seconds of the suggested rate.
	SuggestShare        float64
	SuggestBurstSeconds float64
}

type Mode string

type Observation struct {
	Time      time.Time
	Client    netip.Addr
	UserAgent string
}

type Policy struct {
	Mode Mode `json:"mode"`
	// RPS is the sustained request rate allowed per client IP; Burst is the
	// bucket size (at least 1 whenever RPS is set).
	RPS   float64 `json:"rps,omitempty"`
	Burst int     `json:"burst,omitempty"`
	// DenyCIDRs are addresses and ranges turned away outright.
	DenyCIDRs []string `json:"deny_cidrs,omitempty"`
	// DenyUserAgents are case-insensitive substrings of the User-Agent header.
	DenyUserAgents   []string `json:"deny_user_agents,omitempty"`
	RequireUserAgent bool     `json:"require_user_agent,omitempty"`
}

type Reason int

type ReasonTotal struct {
	Reason string `json:"reason"`
	Count  int    `json:"count"`
}

type Registry struct {
	// contains filtered or unexported fields
}

type ReplayResult struct {
	Requests   int            `json:"requests"`
	WouldBlock int            `json:"would_block"`
	Percent    float64        `json:"percent"`
	ByReason   []ReasonTotal  `json:"by_reason"`
	TopClients []ClientImpact `json:"top_clients"`
	From       time.Time      `json:"from"`
	To         time.Time      `json:"to"`
}

type Snapshot struct {
	Allowed    uint64
	WouldBlock [ReasonCount]uint64
	Blocked    [ReasonCount]uint64
	FailOpen   uint64
}

type State struct {
	Limiter  *Limiter
	Counters *Counters
}

type Suggestion struct {
	PeakRPS float64 `json:"peak_rps"`
	RPS     float64 `json:"rps"`
	Burst   int     `json:"burst"`
	// FromTraffic is false when there was no traffic and the instance
	// defaults were used.
	FromTraffic bool `json:"from_traffic"`
}

type ValidationError struct{ Fields []FieldError }