twirp-ecosystem/twirp-opentracing

Simple OpenTracing hooks for Twirp

OpenTracing Hooks for Twirp

The ottwirp package creates an OpenTracing Twirp hook to use in your server. Derived from grpc-opentracing.

Installation

go get -u github.com/twirp-ecosystem/twirp-opentracing

Server-side usage example

Where you are instantiating your Twirp server:

var tracer opentracing.Tracer = ...

...

hooks := NewOpenTracingHooks(tracer)
service := haberdasherserver.New()
server := WithTraceContext(haberdasher.NewHaberdasherServer(service, hooks), tracer)
log.Fatal(http.ListenAndServe(":8080", server))

Client-side usage example

When instantiating your Twirp client:

var tracer opentracing.Tracer = ...

...

client := haberdasher.NewHaberdasherProtobufClient(url, NewTraceHTTPClient(http.DefaultClient, tracer))

twirp-opentracing's Issues

Add documentation

It'd be great to have some GoDocs for this package, even though it's quite lean.

Add functional filtering option

We may not want to log every single trace, there should be a functional option that can be passed in as a parameter to NewOpenTracingHooks that will prevent specific spans from being traced.