krakendrate

README

KrakenD rate limit

A collection of rate limit adaptors for the KrakenD

Notice: this package requires KrakenD >= 0.4

rate

The package rate contains a proxy adaptor and several router middlewares over the golang.org/x/time/rate lib

juju

The package juju contains a proxy adaptor and several router middlewares over the github.com/juju/ratelimit lib

Documentation

1. Official: http://www.krakend.io/docs/throttling/rate-limit/

2. Autogenerated: https://godoc.org/github.com/devopsfaith/krakend-ratelimit

Documentation

Overview

krakendrate contains a collection of curated rate limit adaptors for the KrakenD framework

Index

• Variables
• type Backend
• type Limiter
• type LimiterStore
• type MemoryBackend
  • func NewMemoryBackend() *MemoryBackend
  • func (m *MemoryBackend) Load(key string) (interface{}, bool)
  • func (m *MemoryBackend) Store(key string, v interface{}) error

Variables

var (
	// ErrLimited is the error returned when the rate limit has been exceded
	ErrLimited = errors.New("ERROR: rate limit exceded")

	DataTTL = 10 * time.Minute
)

Types

type Backend

type Backend interface {
	Load(string) (interface{}, bool)
	Store(string, interface{}) error
}

Backend is the interface of the persistence layer

type Limiter

type Limiter interface {
	Allow() bool
}

Limiter defines a simple interface for a rate limiter

type LimiterStore

type LimiterStore func(string) Limiter

LimiterStore defines the interface for a limiter lookup function

type MemoryBackend

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

MemoryBackend implements the backend interface by wrapping a sync.Map

func NewMemoryBackend

func NewMemoryBackend() *MemoryBackend

func (*MemoryBackend) Load

func (m *MemoryBackend) Load(key string) (interface{}, bool)

Load implements the Backend interface

func (*MemoryBackend) Store

func (m *MemoryBackend) Store(key string, v interface{}) error

Store implements the Backend interface