filter

README

Go Agent Filter

Filtering capability as specified in Hypertrace filter specification can be added to instrumentations.

Example

// Filter requests containing "foo" in URL
type FooURLFilter struct {
}

// Filter evaluates whether request should be blocked, `true` blocks the request and `false` continues it.
func (FooURLFilter) EvaluateURLAndHeaders(span sdk.Span, url string, headers map[string][]string) bool {
	return false
}

// Filter evaluates whether request should be blocked, `true` blocks the request and `false` continues it.
func (FooURLFilter) EvaluateBody(span sdk.Span, body []byte) bool {
	return false
}

Documentation

Index

• type Filter
• type MultiFilter
  • func NewMultiFilter(filter ...Filter) *MultiFilter
  • func (m *MultiFilter) EvaluateBody(span sdk.Span, body []byte, headers map[string][]string) bool
  • func (m *MultiFilter) EvaluateURLAndHeaders(span sdk.Span, url string, headers map[string][]string) bool
• type NoopFilter
  • func (NoopFilter) EvaluateBody(span sdk.Span, body []byte, headers map[string][]string) bool
  • func (NoopFilter) EvaluateURLAndHeaders(span sdk.Span, url string, headers map[string][]string) bool

Types

type Filter

type Filter interface {
	// EvaluateURLAndHeaders can be used to evaluate both URL and Headers
	EvaluateURLAndHeaders(span sdk.Span, url string, headers map[string][]string) bool

	// EvaluateBody can be used to evaluate the body content
	EvaluateBody(span sdk.Span, body []byte, headers map[string][]string) bool
}

Filter evaluates whether request should be blocked, `true` blocks the request and `false` continues it.

type MultiFilter

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

MultiFilter encapsulates multiple filters

func NewMultiFilter

func NewMultiFilter(filter ...Filter) *MultiFilter

NewMultiFilter creates a new MultiFilter

func (*MultiFilter) EvaluateBody

func (m *MultiFilter) EvaluateBody(span sdk.Span, body []byte, headers map[string][]string) bool

EvaluateBody runs body evaluators for each filter until one returns true

func (*MultiFilter) EvaluateURLAndHeaders

func (m *MultiFilter) EvaluateURLAndHeaders(span sdk.Span, url string, headers map[string][]string) bool

EvaluateURLAndHeaders runs URL and headers evaluation for each filter until one returns true

type NoopFilter

type NoopFilter struct{}

NoopFilter is a filter that always evaluates to false

func (NoopFilter) EvaluateBody

func (NoopFilter) EvaluateBody(span sdk.Span, body []byte, headers map[string][]string) bool

EvaluateBody that always returns false

func (NoopFilter) EvaluateURLAndHeaders

func (NoopFilter) EvaluateURLAndHeaders(span sdk.Span, url string, headers map[string][]string) bool

EvaluateURLAndHeaders that always returns false