limithandler

Documentation

Index

• func EnableAcquireTimeHistogram(buckets []float64)
• func SetMaxRepoConcurrency(config map[string]int)
• type ConcurrencyLimiter
  • func NewLimiter(max int, monitor ConcurrencyMonitor) *ConcurrencyLimiter
  • func (c *ConcurrencyLimiter) Limit(ctx context.Context, lockKey string, f LimitedFunc) (interface{}, error)
• type ConcurrencyMonitor
  • func NewPromMonitor(system string, fullMethod string) ConcurrencyMonitor
• type GetLockKey
• type LimitedFunc
• type LimiterMiddleware
  • func New(getLockKey GetLockKey) LimiterMiddleware
  • func (c *LimiterMiddleware) StreamInterceptor() grpc.StreamServerInterceptor
  • func (c *LimiterMiddleware) UnaryInterceptor() grpc.UnaryServerInterceptor

Functions

func EnableAcquireTimeHistogram

func EnableAcquireTimeHistogram(buckets []float64)

EnableAcquireTimeHistogram enables histograms for acquisition times

func SetMaxRepoConcurrency

func SetMaxRepoConcurrency(config map[string]int)

SetMaxRepoConcurrency Configures the max concurrency per repo per RPC

Types

type ConcurrencyLimiter

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

ConcurrencyLimiter contains rate limiter state

func NewLimiter

func NewLimiter(max int, monitor ConcurrencyMonitor) *ConcurrencyLimiter

NewLimiter creates a new rate limiter

func (*ConcurrencyLimiter) Limit

func (c *ConcurrencyLimiter) Limit(ctx context.Context, lockKey string, f LimitedFunc) (interface{}, error)

Limit will limit the concurrency of f

type ConcurrencyMonitor

type ConcurrencyMonitor interface {
	Queued(ctx context.Context)
	Dequeued(ctx context.Context)
	Enter(ctx context.Context, acquireTime time.Duration)
	Exit(ctx context.Context)
}

ConcurrencyMonitor allows the concurrency monitor to be observed

func NewPromMonitor

func NewPromMonitor(system string, fullMethod string) ConcurrencyMonitor

NewPromMonitor creates a new ConcurrencyMonitor that tracks limiter activity in Prometheus.

type GetLockKey

type GetLockKey func(context.Context) string

GetLockKey function defines the lock key of an RPC invocation based on its context

type LimitedFunc

type LimitedFunc func() (resp interface{}, err error)

LimitedFunc represents a function that will be limited

type LimiterMiddleware

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

LimiterMiddleware contains rate limiter state

func New

func New(getLockKey GetLockKey) LimiterMiddleware

New creates a new rate limiter

func (*LimiterMiddleware) StreamInterceptor

func (c *LimiterMiddleware) StreamInterceptor() grpc.StreamServerInterceptor

StreamInterceptor returns a Stream Interceptor

func (*LimiterMiddleware) UnaryInterceptor

func (c *LimiterMiddleware) UnaryInterceptor() grpc.UnaryServerInterceptor

UnaryInterceptor returns a Unary Interceptor