docs(opentracing): add celery example (#1329)

* Document how to propagate the tracer across celery tasks * docs(opentracing): add celery distributed tracing example Co-authored-by: Lie Ryan <lie.1296@gmail.com> Co-authored-by: Tahir H. Butt <tahir.butt@datadoghq.com>
DataDog · Apr 2, 2020 · e76a588 · e76a588
1 parent 3911e64
commit e76a588
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/ddtrace/contrib/celery/__init__.py b/ddtrace/contrib/celery/__init__.py
@@ -31,7 +31,6 @@ def run(self):
 By default, reported service names are:
     * ``celery-producer`` when tasks are enqueued for processing
     * ``celery-worker`` when tasks are processed by a Celery process
-
 """
 from ...utils.importlib import require_modules
 

diff --git a/docs/advanced_usage.rst b/docs/advanced_usage.rst
@@ -530,7 +530,30 @@ the :ref:`ddtrace-run<ddtracerun>` command to invoke your OpenTraced
 application.
 
 
-**Opentracer API**
+Examples
+^^^^^^^^
+
+**Celery**
+
+Distributed Tracing across celery tasks with OpenTracing.
+
+1. Install Celery OpenTracing:
+
+    pip install Celery-OpenTracing
+
+2. Replace your Celery app with the version that comes with Celery-OpenTracing:
+
+    from celery_opentracing import CeleryTracing
+    from ddtrace.opentracer import set_global_tracer, Tracer
+
+    ddtracer = Tracer()
+    set_global_tracer(ddtracer)
+
+    app = CeleryTracing(app, tracer=ddtracer)
+
+
+Opentracer API
+^^^^^^^^^^^^^^
 
 .. autoclass:: ddtrace.opentracer.Tracer
     :members: