This is Haystack's client library for Python that implements OpenTracing

Further information can be found on opentracing.io

See examples in /examples directory. See opentracing usage for additional information.

First initialize the tracer at the application level by supplying a service name and recorder

import opentracing
from haystack import HaystackAgentRecorder
from haystack import HaystackTracer

opentracing.tracer = HaystackTracer("a_service", HaystackAgentRecorder())

Starting a span can be done as a managed resource using start_active_span()

with opentracing.tracer.start_active_span("span-name") as scope:
    do_stuff()

or finish the span on your own terms with

span = opentracing.tracer.start_span("span-name")
do_stuff()
span.finish()

Note: If there is a Scope, it will act as the parent to any newly started Span unless the programmer passes ignore_active_span=True at start_span()/start_active_span() time or specified parent context explicitly using childOf=parent_context

If necessary, default propagation headers can be replaced with custom ones by specifying custom propagator options. Register the new propagator with the tracer once configured.

prop_opts = PropagatorOpts("X-Trace-ID", "X-Span-ID", "X-Parent-Span", "X-baggage-")
opentracing.tracer.register_propagator(opentracing.Format.HTTP_HEADERS, TextPropagator(prop_opts))

All modules define their logger via logging.getLogger(__name__)

So in order to define specific logging format or level for this library use getLogger('haystack') or configure the root logger.

Create a python3 virtual environment, activate it and then make bootstrap

make example

Create a new release in github specifying a semver compliant tag greater than the current release version.