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 {
}

// `result.FilterResult` will contain a bool `Block` which when set to `true` means to block the request and `false` to
// continue the request. It also contains `ResponseStatusCode` which is the HTTP status code to return.

// Filter evaluates whether request should be blocked based on the url and headers.
func (FooURLFilter) EvaluateURLAndHeaders(span sdk.Span, url string, headers map[string][]string) result.FilterResult {
	return false
}

// Filter evaluates whether request should be blocked based on the body.
func (FooURLFilter) EvaluateBody(span sdk.Span, body []byte) result.FilterResult {
	return false
}

// Filter evaluates whether request should be blocked based on url, headers and body.
func (FooURLFilter) Evaluate(span sdk.Span, url string, body []byte, headers map[string][]string) result.FilterResult {
	return false
}

Documentation

Index

• type Filter
• type MultiFilter
  • func NewMultiFilter(filter ...Filter) *MultiFilter
  • func (m *MultiFilter) Evaluate(span sdk.Span) result.FilterResult
• type NoopFilter
  • func (NoopFilter) Evaluate(span sdk.Span) result.FilterResult

Types

type Filter

type Filter interface {
	// Evaluate can be used to evaluate URL, headers and body content in one call
	Evaluate(span sdk.Span) result.FilterResult
}

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) Evaluate

func (m *MultiFilter) Evaluate(span sdk.Span) result.FilterResult

Evaluate runs body evaluators for each filter until one returns true

type NoopFilter

type NoopFilter struct{}

NoopFilter is a filter that always evaluates to false

func (NoopFilter) Evaluate

func (NoopFilter) Evaluate(span sdk.Span) result.FilterResult

Evaluate that always returns false