rules

Documentation

Overview

Package rules provides primitives for working with routing rules.

Index

• type PrefixTrie
  • func NewPrefixTrie() *PrefixTrie
  • func (t *PrefixTrie) Add(s []byte)
  • func (t *PrefixTrie) Check(s []byte) bool
• type Rule
  • func (rl Rule) Match(r *rec.RecBytes, measureRegex bool) bool
• type Rules
  • func Build(crs *conf.Rules, clusters target.Clusters, measureRegex bool, ms *metrics.Prom) (Rules, error)
  • func TestBuild(crs conf.Rules, clusters map[string]*target.TestTarget, measureRegex bool, ...) (Rules, error)
  • func (rs Rules) RouteRec(r *rec.RecBytes, lg *zap.Logger)

Types

type PrefixTrie

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

PrefixTrie efficiently checks if a slice of bytes contains one of the prefixes prevoiusly added to the tree.

func NewPrefixTrie

func NewPrefixTrie() *PrefixTrie

NewPrefixTrie makes a new instance of a PrefixTrie.

func (*PrefixTrie) Add

func (t *PrefixTrie) Add(s []byte)

Add a prefix to the trie

func (*PrefixTrie) Check

func (t *PrefixTrie) Check(s []byte) bool

Check if string s contains any of the prefixes

type Rule

type Rule struct {
	Regexs     []string
	Prefixes   []string
	Targets    []target.ClusterTarget
	Continue   bool
	CompiledRE []*regexp.Regexp

	PrefixTrie *PrefixTrie
	// contains filtered or unexported fields
}

Rule is a routing rule.

func (Rule) Match

func (rl Rule) Match(r *rec.RecBytes, measureRegex bool) bool

Match a record with any of the rule regexps

type Rules

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

Rules represent all the routing rules/routing table.

func Build

func Build(crs *conf.Rules, clusters target.Clusters, measureRegex bool, ms *metrics.Prom) (Rules, error)

Build reads rules from config, compiles them.

func TestBuild

func TestBuild(crs conf.Rules, clusters map[string]*target.TestTarget, measureRegex bool, ms *metrics.Prom) (Rules, error)

TestBuild makes a set of rules for testing.

func (Rules) RouteRec

func (rs Rules) RouteRec(r *rec.RecBytes, lg *zap.Logger)

RouteRec a record by following the rules