sender

Documentation

Index

• func Unary(setter UsageSetter) grpc.UnaryServerInterceptor
• type Config
  • func (c *Config) Validate() error
• type NoopUsageSetter
  • func (s NoopUsageSetter) AddUsage(usage *v1.UsageRecord)
• type UsageSender
  • func New(ctx context.Context, c Config, opt grpc.DialOption, log logr.Logger) (*UsageSender, error)
  • func (s *UsageSender) AddUsage(usage *v1.UsageRecord)
  • func (s *UsageSender) Run(ctx context.Context)
• type UsageSetter

Functions

func Unary

func Unary(setter UsageSetter) grpc.UnaryServerInterceptor

Unary is a interceptor that records API usage for gRPC calls with the user info.

Types

type Config

type Config struct {
	// Enable is the flag to enable the sender.
	Enable bool `yaml:"enable"`
	// APIUsageInternalServerAddr is the address of the server to send usage data to.
	APIUsageInternalServerAddr string `yaml:"apiUsageInternalServerAddr"`
	// InitialDelay is the time to wait before starting the sender.
	InitialDelay time.Duration `yaml:"initialDelay"`
	// Interval is the interval at which the sender sends usage data to the server.
	Interval time.Duration `yaml:"interval"`
	// UsageChannelSize is the size of the channel that stores usage data.
	UsageChannelSize int `yaml:"usageChannelSize"`
	// MaxMessageSize is the maximum size of a message that the sender can send one gRPC call.
	MaxMessageSize int `yaml:"maxMessageSize"`
}

Config is the configuration for the sender.

func (*Config) Validate

func (c *Config) Validate() error

Validate validates the configuration.

type NoopUsageSetter

type NoopUsageSetter struct{}

NoopUsageSetter does nothing.

func (NoopUsageSetter) AddUsage

func (s NoopUsageSetter) AddUsage(usage *v1.UsageRecord)

AddUsage does nothing

type UsageSender

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

UsageSender is a component that sends usage data to the API server.

func New

func New(ctx context.Context, c Config, opt grpc.DialOption, log logr.Logger) (*UsageSender, error)

New creates a new UsageSender.

func (*UsageSender) AddUsage

func (s *UsageSender) AddUsage(usage *v1.UsageRecord)

AddUsage adds a usage record to the sender.

func (*UsageSender) Run

func (s *UsageSender) Run(ctx context.Context)

Run starts the usage sender. It sends usage data to the usage collector. If the maximum message size is exceeded, the sender will send the data immediately.

type UsageSetter

type UsageSetter interface {
	AddUsage(usage *v1.UsageRecord)
}

UsageSetter is an interface that allows components to add usage data to the sender.