ratelimit

Documentation

Index

• type RateLimitConfig
  • func NewRateLimitConfig(operatorID string) *RateLimitConfig
  • func (c RateLimitConfig) Build(context operator.BuildContext) ([]operator.Operator, error)
• type RateLimitOperator
  • func (p *RateLimitOperator) Process(ctx context.Context, entry *entry.Entry) error
  • func (p *RateLimitOperator) Start() error
  • func (p *RateLimitOperator) Stop() error

Types

type RateLimitConfig

type RateLimitConfig struct {
	helper.TransformerConfig `yaml:",inline"`

	Rate     float64         `json:"rate,omitempty"     yaml:"rate,omitempty"`
	Interval helper.Duration `json:"interval,omitempty" yaml:"interval,omitempty"`
	Burst    uint            `json:"burst,omitempty"    yaml:"burst,omitempty"`
}

RateLimitConfig is the configuration of a rate filter operator.

func NewRateLimitConfig

func NewRateLimitConfig(operatorID string) *RateLimitConfig

NewRateLimitConfig creates a new rate limit config with default values

func (RateLimitConfig) Build

func (c RateLimitConfig) Build(context operator.BuildContext) ([]operator.Operator, error)

Build will build a rate limit operator.

type RateLimitOperator

type RateLimitOperator struct {
	helper.TransformerOperator
	// contains filtered or unexported fields
}

RateLimitOperator is an operator that limits the rate of log consumption between operators.

func (*RateLimitOperator) Process

func (p *RateLimitOperator) Process(ctx context.Context, entry *entry.Entry) error

Process will wait until a rate is met before sending an entry to the output.

func (*RateLimitOperator) Start

func (p *RateLimitOperator) Start() error

Start will start the rate limit operator.

func (*RateLimitOperator) Stop

func (p *RateLimitOperator) Stop() error

Stop will stop the rate limit operator.