OpenTracing instrumentation for Apache Thrift
Clone or download

README.md

Build Status Coverage Status Released Version

OpenTracing Apache Thrift Instrumentation

OpenTracing instrumentation for Apache Thrift

pom.xml

<dependency>
    <groupId>io.opentracing.contrib</groupId>
    <artifactId>opentracing-thrift</artifactId>
    <version>VERSION</version>
</dependency>

Usage

Please don't use FieldID equal 3333. It is a magic number for injected span context.

// Instantiate tracer
Tracer tracer = ...

// Optionally register tracer with GlobalTracer
GlobalTracer.register(tracer);

Synchronous mode

Server

// Decorate TProcessor with SpanProcessor e.g.
TProcessor processor = ...
TProcessor spanProcessor = new SpanProcessor(processor, tracer);
TServerTransport transport = ...
TServer server = new TSimpleServer(new Args(transport).processor(spanProcessor));

Client

// Decorate TProtocol with SpanProtocol e.g.

TTransport transport = ...
TProtocol protocol = new TBinaryProtocol(transport);
TProtocol spanProtocol = new SpanProtocol(protocol, tracer)

Asynchronous mode

Server

// Decorate TProcessor with SpanProcessor
TProcessor processor = ...
TProcessor spanProcessor = new SpanProcessor(processor, tracer);

TNonblockingServerSocket tnbSocketTransport = new TNonblockingServerSocket(8890, 30000);
TNonblockingServer.Args tnbArgs = new TNonblockingServer.Args(tnbSocketTransport);
tnbArgs.processor(spanProcessor);
TServer server = new TNonblockingServer(tnbArgs);

Client

// Decorate TProtocolFactory with SpanProtocol.Factory
TProtocolFactory factory = new TBinaryProtocol.Factory();
SpanProtocol.Factory protocolFactory = new SpanProtocol.Factory(factory, tracer, false);

TNonblockingTransport transport = new TNonblockingSocket("localhost", 8890);
TAsyncClientManager clientManager = new TAsyncClientManager();
AsyncClient asyncClient = new AsyncClient(protocolFactory, clientManager, transport);

// Decorate AsyncMethodCallback with TracingAsyncMethodCallback:
AsyncMethodCallback<T> callback = ...
TracingAsyncMethodCallback<T> tracingCallback = new TracingAsyncMethodCallback(callback, protocolFactory);

asyncClient.callMethod(..., tracingCallback);

Custom Client Span Tags

To customise the tags added to spans on the client side, create a custom implementation of ClientSpanDecorator.

class MyClientSpanDecorator implements ClientSpanDecorator {
    
    @Override
    public void decorate(Span span, TMessage message) {
        // Add custom tags to the span.
    }
    
    @Override
    public void onError(Throwable throwable, Span span) {
        // Add custom tags for when an error is thrown by the thrift call.
    }
}

Then pass this into your SpanProtocol.

TProtocol spanProtocol = new SpanProtocol(protocol, tracer, new MyClientSpanDecorator() );

If no custom ClientSpanDecorator is provided, the DefaultClientSpanDecorator is used. This delegates its methods to the static methods in the SpanDecorator class. The DefaultClientSpanDecorator can be extended if you want to add to the default behaviour.

License

Apache 2.0 License.