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
• func PseudoFNV64a(s string) uint64
• type Backend
• type Hasher
• type Limiter
• type LimiterStore
• type MemoryBackend
  • func NewMemoryBackend(ctx context.Context, ttl time.Duration) *MemoryBackend
  • func (m *MemoryBackend) Load(key string, f func() interface{}) interface{}
  • func (m *MemoryBackend) Store(key string, v interface{}) error
• type ShardedMemoryBackend
  • func DefaultShardedMemoryBackend(ctx context.Context) *ShardedMemoryBackend
  • func NewShardedMemoryBackend(ctx context.Context, shards uint64, ttl time.Duration, h Hasher) *ShardedMemoryBackend
  • func (b *ShardedMemoryBackend) Load(key string, f func() interface{}) interface{}
  • func (b *ShardedMemoryBackend) 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 is the default eviction time
	DataTTL = 10 * time.Minute
)

Functions

func PseudoFNV64a

func PseudoFNV64a(s string) uint64

Types

type Backend

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

Backend is the interface of the persistence layer

type Hasher

type Hasher func(string) uint64

Hasher gets a hash for the received string

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(ctx context.Context, ttl time.Duration) *MemoryBackend

func (*MemoryBackend) Load

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

Load implements the Backend interface

func (*MemoryBackend) Store

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

Store implements the Backend interface

type ShardedMemoryBackend

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

ShardedMemoryBackend is a memory backend shardering the data in order to avoid mutex contention

func DefaultShardedMemoryBackend

func DefaultShardedMemoryBackend(ctx context.Context) *ShardedMemoryBackend

DefaultShardedMemoryBackend is a 2018 sharded ShardedMemoryBackend

func NewShardedMemoryBackend

func NewShardedMemoryBackend(ctx context.Context, shards uint64, ttl time.Duration, h Hasher) *ShardedMemoryBackend

NewShardedMemoryBackend returns a ShardedMemoryBackend with 'shards' shards

func (*ShardedMemoryBackend) Load

func (b *ShardedMemoryBackend) Load(key string, f func() interface{}) interface{}

Load implements the Backend interface

func (*ShardedMemoryBackend) Store

func (b *ShardedMemoryBackend) Store(key string, v interface{}) error

Store implements the Backend interface