Rate Limiter

RateLimiter proporciona un middleware de rate limiter que limita el número de requests enviados al servidor desde una IP o identificador particular dentro de un periodo.

Por defecto, un store en memoria lleva la cuenta de los requests. La implementación en memoria por defecto se centra en la corrección y puede no ser la mejor opción para un número alto de requests concurrentes o una gran cantidad de identificadores distintos (>16k).

Todo el middleware principal reside en el paquete middleware:

import "github.com/labstack/echo/v5/middleware"

Uso

Para agregar un rate limit a tu aplicación, agrega el middleware RateLimiter. El ejemplo siguiente limita la aplicación a 20 requests/sec usando el store en memoria por defecto:

e.Use(middleware.RateLimiter(middleware.NewRateLimiterMemoryStore(20.0)))

Nota

Si la tasa proporcionada es un número float, Burst se trata como el valor redondeado hacia abajo de la tasa.

Configuración personalizada

config := middleware.RateLimiterConfig{
  Skipper: middleware.DefaultSkipper,
  Store: middleware.NewRateLimiterMemoryStoreWithConfig(
    middleware.RateLimiterMemoryStoreConfig{Rate: 10, Burst: 30, ExpiresIn: 3 * time.Minute},
  ),
  IdentifierExtractor: func(c *echo.Context) (string, error) {
    id := c.RealIP()
    return id, nil
  },
  ErrorHandler: func(c *echo.Context, err error) error {
    return c.JSON(http.StatusForbidden, nil)
  },
  DenyHandler: func(c *echo.Context, identifier string, err error) error {
    return c.JSON(http.StatusTooManyRequests, nil)
  },
}

e.Use(middleware.RateLimiterWithConfig(config))

Errores

var (
  // ErrRateLimitExceeded denotes an error raised when the rate limit is exceeded.
  ErrRateLimitExceeded = echo.NewHTTPError(http.StatusTooManyRequests, "rate limit exceeded")
  // ErrExtractorError denotes an error raised when the extractor function is unsuccessful.
  ErrExtractorError = echo.NewHTTPError(http.StatusForbidden, "error while extracting identifier")
)

Consejo

Para implementar tu propio store, satisface la interfaz RateLimiterStore y pásalo a RateLimiterConfig.

Configuración

RateLimiterConfig · github.com/labstack/echo/v5@5196b9b

Las descripciones de los campos se generan a partir de comentarios del código fuente en inglés.

Campos del código fuente

Campo	Tipo	Descripción	Fuente
Skipper	Skipper	—	L39
BeforeFunc	BeforeFunc	—	L40
IdentifierExtractor	Extractor	IdentifierExtractor uses *echo.Context to extract the identifier for a visitor	L42
Store	RateLimiterStore	Store defines a store for the rate limiter	L44
ErrorHandler	func(c *echo.Context, err error) error	ErrorHandler provides a handler to be called when IdentifierExtractor returns an error	L46
DenyHandler	func(c *echo.Context, identifier string, err error) error	DenyHandler provides a handler to be called when RateLimiter denies access	L48

Funciones del código fuente

Tipo	Fuente
func RateLimiter(store RateLimiterStore) echo.MiddlewareFunc	L86
func RateLimiterWithConfig(config RateLimiterConfig) echo.MiddlewareFunc	L119

RateLimiterMemoryStoreConfig · github.com/labstack/echo/v5@5196b9b

Las descripciones de los campos se generan a partir de comentarios del código fuente en inglés.

Campos del código fuente

Campo	Tipo	Descripción	Fuente
Rate	float64	—	L245
Burst	int	—	L246
ExpiresIn	time.Duration	—	L247

Funciones del código fuente

Tipo	Fuente
func NewRateLimiterMemoryStore(rateLimit float64) (store *RateLimiterMemoryStore)	L200
func NewRateLimiterMemoryStoreWithConfig(config RateLimiterMemoryStoreConfig) (store *RateLimiterMemoryStore)	L225

Configuración por defecto

// DefaultRateLimiterConfig defines default values for RateLimiterConfig.
var DefaultRateLimiterConfig = RateLimiterConfig{
  Skipper: DefaultSkipper,
  IdentifierExtractor: func(c *echo.Context) (string, error) {
    id := c.RealIP()
    return id, nil
  },
  ErrorHandler: func(c *echo.Context, err error) error {
    return &echo.HTTPError{
      Code:     ErrExtractorError.Code,
      Message:  ErrExtractorError.Message,
      Internal: err,
    }
  },
  DenyHandler: func(c *echo.Context, identifier string, err error) error {
    return &echo.HTTPError{
      Code:     ErrRateLimitExceeded.Code,
      Message:  ErrRateLimitExceeded.Message,
      Internal: err,
    }
  },
}