filters

Documentation

Overview

Package filters provides a set of filters useful with the otelhttpx.WithFilter() option to control which inbound requests are traced.

Index

• func All(fs ...otelhttpx.Filter) otelhttpx.Filter
• func Any(fs ...otelhttpx.Filter) otelhttpx.Filter
• func Header(k, v string) otelhttpx.Filter
• func HeaderContains(k, v string) otelhttpx.Filter
• func Hostname(h string) otelhttpx.Filter
• func Method(m string) otelhttpx.Filter
• func None(fs ...otelhttpx.Filter) otelhttpx.Filter
• func Not(f otelhttpx.Filter) otelhttpx.Filter
• func Path(p string) otelhttpx.Filter
• func PathPrefix(p string) otelhttpx.Filter
• func Query(k, v string) otelhttpx.Filter
• func QueryContains(k, v string) otelhttpx.Filter

Functions

func All

func All(fs ...otelhttpx.Filter) otelhttpx.Filter

All takes a list of Filters and returns a Filter that returns true only if all Filters in the list return true.

func Any

func Any(fs ...otelhttpx.Filter) otelhttpx.Filter

Any takes a list of Filters and returns a Filter that returns true if any Filter in the list returns true.

func Header

func Header(k, v string) otelhttpx.Filter

Header returns a Filter that returns true if the request includes a header k with a value equal to v.

func HeaderContains

func HeaderContains(k, v string) otelhttpx.Filter

HeaderContains returns a Filter that returns true if the request includes a header k with a value that contains v.

func Hostname

func Hostname(h string) otelhttpx.Filter

Hostname returns a Filter that returns true if the request's hostname matches the provided string.

func Method

func Method(m string) otelhttpx.Filter

Method returns a Filter that returns true if the request method is equal to the provided value.

func None

func None(fs ...otelhttpx.Filter) otelhttpx.Filter

None takes a list of Filters and returns a Filter that returns true only if none of the Filters in the list return true.

func Not

func Not(f otelhttpx.Filter) otelhttpx.Filter

Not provides a convenience mechanism for inverting a Filter.

func Path

func Path(p string) otelhttpx.Filter

Path returns a Filter that returns true if the request's path matches the provided string.

func PathPrefix

func PathPrefix(p string) otelhttpx.Filter

PathPrefix returns a Filter that returns true if the request's path starts with the provided string.

func Query

func Query(k, v string) otelhttpx.Filter

Query returns a Filter that returns true if the request includes a query parameter k with a value equal to v.

func QueryContains

func QueryContains(k, v string) otelhttpx.Filter

QueryContains returns a Filter that returns true if the request includes a query parameter k with a value that contains v.