ratelimit

Documentation

Overview

Package ratelimit provides tools to work with rate limits imposed by Sentry's data ingestion pipeline.

Index

• type Category
  • func (c Category) String() string
• type Deadline
  • func (d Deadline) After(other Deadline) bool
  • func (d Deadline) Equal(e Deadline) bool
  • func (d Deadline) String() string
• type Map
  • func FromResponse(r *http.Response) Map
  • func (m Map) Deadline(c Category) Deadline
  • func (m Map) IsRateLimited(c Category) bool
  • func (m Map) Merge(other Map)

Types

type Category

type Category string

Category classifies supported payload types that can be ingested by Sentry and, therefore, rate limited.

const (
	CategoryUnknown     Category = "unknown" // Unknown category should not get rate limited
	CategoryAll         Category = ""        // Special category for empty categories (applies to all)
	CategoryError       Category = "error"
	CategoryTransaction Category = "transaction"
	CategoryLog         Category = "log_item"
	CategoryMonitor     Category = "monitor"
)

Known rate limit categories that are specified in rate limit headers.

func (Category) String

func (c Category) String() string

String returns the category formatted for debugging.

type Deadline

type Deadline time.Time

A Deadline is a time instant when a rate limit expires.

func (Deadline) After

func (d Deadline) After(other Deadline) bool

After reports whether the deadline d is after other.

func (Deadline) Equal

func (d Deadline) Equal(e Deadline) bool

Equal reports whether d and e represent the same deadline.

func (Deadline) String

func (d Deadline) String() string

String returns the deadline formatted for debugging.

type Map

type Map map[Category]Deadline

Map maps categories to rate limit deadlines.

A rate limit is in effect for a given category if either the category's deadline or the deadline for the special CategoryAll has not yet expired.

Use IsRateLimited to check whether a category is rate-limited.

func FromResponse

func FromResponse(r *http.Response) Map

FromResponse returns a rate limit map from an HTTP response.

func (Map) Deadline

func (m Map) Deadline(c Category) Deadline

Deadline returns the deadline when the rate limit for the given category or the special CategoryAll expire, whichever is furthest into the future.

func (Map) IsRateLimited

func (m Map) IsRateLimited(c Category) bool

IsRateLimited returns true if the category is currently rate limited.

func (Map) Merge

func (m Map) Merge(other Map)

Merge merges the other map into m.

If a category appears in both maps, the deadline that is furthest into the future is preserved.