filters

Documentation

Overview

Package filters provides a set of filters useful with the otelgrpc.WithFilter option to control which inbound requests are instrumented.

Index

• func All(fs ...otelgrpc.Filter) otelgrpc.Filter
• func Any(fs ...otelgrpc.Filter) otelgrpc.Filter
• func FullMethodName(n string) otelgrpc.Filter
• func HealthCheck() otelgrpc.Filter
• func MethodName(n string) otelgrpc.Filter
• func MethodPrefix(pre string) otelgrpc.Filter
• func None(fs ...otelgrpc.Filter) otelgrpc.Filter
• func Not(f otelgrpc.Filter) otelgrpc.Filter
• func ServiceName(s string) otelgrpc.Filter
• func ServicePrefix(pre string) otelgrpc.Filter

Functions

func All

func All(fs ...otelgrpc.Filter) otelgrpc.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 ...otelgrpc.Filter) otelgrpc.Filter

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

func FullMethodName

func FullMethodName(n string) otelgrpc.Filter

FullMethodName returns a Filter that returns true if the request's full RPC method string, i.e. /package.service/method, starts with the provided string n.

func HealthCheck

func HealthCheck() otelgrpc.Filter

HealthCheck returns a Filter that returns true if the request's service name is health check defined by gRPC Health Checking Protocol. https://github.com/grpc/grpc/blob/master/doc/health-checking.md

func MethodName

func MethodName(n string) otelgrpc.Filter

MethodName returns a Filter that returns true if the request's method name matches the provided string n.

func MethodPrefix

func MethodPrefix(pre string) otelgrpc.Filter

MethodPrefix returns a Filter that returns true if the request's method starts with the provided string pre.

func None

func None(fs ...otelgrpc.Filter) otelgrpc.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 otelgrpc.Filter) otelgrpc.Filter

Not provides a convenience mechanism for inverting a Filter.

func ServiceName

func ServiceName(s string) otelgrpc.Filter

ServiceName returns a Filter that returns true if the request's service name, i.e. package.service, matches s.

func ServicePrefix

func ServicePrefix(pre string) otelgrpc.Filter

ServicePrefix returns a Filter that returns true if the request's service name, i.e. package.service, starts with the provided string pre.