The highest tagged major version is
Documentation
¶
Overview ¶
`grpc_opentracing` adds OpenTracing
OpenTracing Interceptors ¶
These are both client-side and server-side interceptors for OpenTracing. They are a provider-agnostic, with backends such as Zipkin, or Google Stackdriver Trace.
For a service that sends out requests and receives requests, you *need* to use both, otherwise downstream requests will not have the appropriate requests propagated.
All server-side spans are tagged with grpc_ctxtags information.
For more information see: http://opentracing.io/documentation/ https://github.com/opentracing/specification/blob/master/semantic_conventions.md
Index ¶
- Constants
- func ClientAddContextTags(ctx context.Context, tags opentracing.Tags) context.Context
- func StreamClientInterceptor(opts ...Option) grpc.StreamClientInterceptor
- func StreamServerInterceptor(opts ...Option) grpc.StreamServerInterceptor
- func UnaryClientInterceptor(opts ...Option) grpc.UnaryClientInterceptor
- func UnaryServerInterceptor(opts ...Option) grpc.UnaryServerInterceptor
- type FilterFunc
- type OpNameFunc
- type Option
- type UnaryRequestHandlerFunc
Constants ¶
const ( TagTraceId = "trace.traceid" TagSpanId = "trace.spanid" TagSampled = "trace.sampled" )
Variables ¶
This section is empty.
Functions ¶
func ClientAddContextTags ¶
ClientAddContextTags returns a context with specified opentracing tags, which are used by UnaryClientInterceptor/StreamClientInterceptor when creating a new span.
func StreamClientInterceptor ¶
func StreamClientInterceptor(opts ...Option) grpc.StreamClientInterceptor
StreamClientInterceptor returns a new streaming client interceptor for OpenTracing.
func StreamServerInterceptor ¶
func StreamServerInterceptor(opts ...Option) grpc.StreamServerInterceptor
StreamServerInterceptor returns a new streaming server interceptor for OpenTracing.
func UnaryClientInterceptor ¶
func UnaryClientInterceptor(opts ...Option) grpc.UnaryClientInterceptor
UnaryClientInterceptor returns a new unary client interceptor for OpenTracing.
func UnaryServerInterceptor ¶
func UnaryServerInterceptor(opts ...Option) grpc.UnaryServerInterceptor
UnaryServerInterceptor returns a new unary server interceptor for OpenTracing.
Types ¶
type FilterFunc ¶
FilterFunc allows users to provide a function that filters out certain methods from being traced.
If it returns false, the given request will not be traced.
type OpNameFunc ¶ added in v1.3.0
OpNameFunc is a func that allows custom operation names instead of the gRPC method.
type Option ¶
type Option func(*options)
func WithFilterFunc ¶
func WithFilterFunc(f FilterFunc) Option
WithFilterFunc customizes the function used for deciding whether a given call is traced or not.
func WithOpName ¶ added in v1.3.0
func WithOpName(f OpNameFunc) Option
WithOpName customizes the trace Operation name
func WithTraceHeaderName ¶ added in v1.2.1
WithTraceHeaderName customizes the trace header name where trace metadata passed with requests. Default one is `uber-trace-id`
func WithTracer ¶
func WithTracer(tracer opentracing.Tracer) Option
WithTracer sets a custom tracer to be used for this middleware, otherwise the opentracing.GlobalTracer is used.
func WithUnaryRequestHandlerFunc ¶ added in v1.2.1
func WithUnaryRequestHandlerFunc(f UnaryRequestHandlerFunc) Option
WithUnaryRequestHandlerFunc sets a custom handler for the request
type UnaryRequestHandlerFunc ¶ added in v1.2.1
type UnaryRequestHandlerFunc func(span opentracing.Span, req interface{})
UnaryRequestHandlerFunc is a custom request handler
Source Files