validator

Documentation

Index

• Constants
• func New(name string, filterName string, opts ...Option) validator
• type HashableProtoMessage
• type Option
  • func WithCacheSize(size int) Option
  • func WithCounters(cacheHits, cacheMisses *stats.Int64Measure) Option
• type Validator

Constants

const DefaultCacheSize int = 1024

DefaultCacheSize defines the default size of the LRU cache used by the validator

Functions

func New

func New(name string, filterName string, opts ...Option) validator

New returns a new Validator

Types

type HashableProtoMessage

type HashableProtoMessage interface {
	protoiface.MessageV1
	Hash(hasher hash.Hash64) (uint64, error)
}

HashableProtoMessage defines a ProtoMessage that can be hashed. Useful when passing different ProtoMessages objects that need to be hashed.

type Option

type Option func(*config)

func WithCacheSize

func WithCacheSize(size int) Option

func WithCounters

func WithCounters(cacheHits, cacheMisses *stats.Int64Measure) Option

type Validator

type Validator interface {
	// ValidateConfig validates the given envoy config and returns any out and error from envoy. Returns nil if the envoy binary is not found.
	ValidateConfig(ctx context.Context, config HashableProtoMessage) error

	// CacheLength returns the returns the number of items in the cache
	CacheLength() int
}

Validator validates an envoy config by running it by envoy in validate mode. This requires the envoy binary to be present at $ENVOY_BINARY_PATH (defaults to /usr/local/bin/envoy). Results are cached via an LRU cache for performance