Skip to content

Commit

Permalink
[opentracer] Final doc updates (#596)
Browse files Browse the repository at this point in the history
  • Loading branch information
Kyle-Verhoog committed Sep 10, 2018
1 parent f58dc95 commit 260440b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
[![CircleCI](https://circleci.com/gh/DataDog/dd-trace-py/tree/master.svg?style=svg)](https://circleci.com/gh/DataDog/dd-trace-py/tree/master)
[![Pyversions](https://img.shields.io/pypi/pyversions/ddtrace.svg?style=flat)](https://pypi.org/project/ddtrace/)
[![PypiVersions](https://img.shields.io/pypi/v/ddtrace.svg)](https://pypi.org/project/ddtrace/)
[![OpenTracing Badge](https://img.shields.io/badge/OpenTracing-enabled-blue.svg)](http://pypi.datadoghq.com/trace/docs/installation_quickstart.html#opentracing)

`ddtrace` is Datadog's tracing library for Python. It is used to trace requests
as they flow across web servers, databases and microservices so that developers
Expand Down
12 changes: 11 additions & 1 deletion docs/advanced_usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,8 @@ OpenTracing


The Datadog opentracer can be configured via the ``config`` dictionary
parameter which accepts the following described fields.
parameter to the tracer which accepts the following described fields. See below
for usage.

+---------------------+---------------------------------------------------------+---------------+
| Configuration Key | Description | Default Value |
Expand Down Expand Up @@ -336,6 +337,15 @@ See also the `Python OpenTracing`_ repository for usage of the tracer.
.. _Python OpenTracing: https://github.com/opentracing/opentracing-python


**Alongside Datadog tracer**

The Datadog OpenTracing tracer can be used alongside the Datadog tracer. This
provides the advantage of providing tracing information collected by
``ddtrace`` in addition to OpenTracing. The simplest way to do this is to use
the :ref:`ddtrace-run<ddtracerun>` command to invoke your OpenTraced
application.


**Opentracer API**

.. autoclass:: ddtrace.opentracer.Tracer
Expand Down

0 comments on commit 260440b

Please sign in to comment.