OpenTracing instrumentation for Requests
Clone or download

README.rst

Requests OpenTracing

This package enables tracing http requests in a Requests Session via The OpenTracing Project. Once a production system contends with real concurrency or splits into many services, crucial (and formerly easy) tasks become difficult: user-facing latency optimization, root-cause analysis of backend errors, communication about distinct pieces of a now-distributed system, etc. Distributed tracing follows a request on its journey from inception to completion from mobile/browser all the way to the microservices.

As core services and libraries adopt OpenTracing, the application builder is no longer burdened with the task of adding basic tracing instrumentation to their own code. In this way, developers can build their applications with the tools they prefer and benefit from built-in tracing instrumentation. OpenTracing implementations exist for major distributed tracing systems and can be bound or swapped with a one-line configuration change.

If you want to learn more about the underlying Python API, visit the Python source code.

Installation

Run the following command:

$ pip install requests-opentracing

Usage

The provided requests.Session subclass allows the tracing of http methods using the OpenTracing API. All that it requires is for a SessionTracing instance to be initialized using an instance of an OpenTracing tracer and treated as a standard Requests session.

Initialize

SessionTracing takes the Tracer instance that is supported by OpenTracing and an optional dictionary of desired tags for each created span. You can also specify whether you'd like your current trace context to be propagated via http headers with your client request. To create a SessionTracing object, you can either pass in a tracer object directly or default to the opentracing.tracer global tracer that's set elsewhere in your application:

from requests_opentracing import SessionTracing

opentracing_tracer = # some OpenTracing tracer implementation
traced_session = SessionTracing(opentracing_tracer, propagate=True,  # propagation allows distributed tracing
                                span_tags=dict(my_helpful='tag'))    # in upstream services you control.
resp = traced_session.get(my_url)

or

from requests_opentracing import SessionTracing
import opentracing
import requests

opentracing.tracer = # some OpenTracing tracer implementation
traced_session = SessionTracing()  # default to opentracing.tracer

Further Information

If you're interested in learning more about the OpenTracing standard, please visit opentracing.io or join the mailing list. If you would like to implement OpenTracing in your project and need help, feel free to send us a note at community@opentracing.io.