Skip to content

Commit 46db440

Browse files
committed
Extend distributed tracing documentation to web frameworks
1 parent 5aed9b2 commit 46db440

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

ddtrace/propagation/http.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ def extract(self, headers):
3939
4040
from ddtrace.propagation.http import HTTPPropagator
4141
42-
def child_call(url, headers):
42+
def my_controller(url, headers):
4343
context = HTTPPropagator.extract(headers)
4444
tracer.context_provider.activate(context)
4545
46-
with tracer.trace("child_span") as span:
46+
with tracer.trace("my_controller") as span:
4747
span.set_meta('http.url', url)
4848
4949
:param dict headers: HTTP headers to extract tracing attributes.

docs/index.rst

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -272,13 +272,25 @@ Distributed Tracing
272272

273273
To trace requests across hosts, the spans on the secondary hosts must be linked together by setting `trace_id`, `parent_id` and `sampling_priority`.
274274

275+
- On the server side, it means to read propagated attributes and set them to the active tracing context.
276+
- On the client side, it means to propagate the attributes, commonly as a header/metadata.
277+
275278
`ddtrace` already provides default propagators but you can also implement your own.
276279

277-
HTTP
278-
~~~~
280+
Web frameworks
281+
~~~~~~~~~~~~~~
282+
283+
Some web framework integrations support the distributed tracing out of the box, you just have to enable it.
284+
For that, refer to the configuration of the given integration.
285+
Supported web frameworks:
286+
287+
- Django
288+
289+
290+
HTTP client/server
291+
~~~~~~~~~~~~~~~~~~
279292

280-
The `HTTPPropagator` is already automatically used in our `aiohttp` integration. For the others, you can use
281-
it manually.
293+
You can use the `HTTPPropagator` manually when used with an HTTP client or if your web framework isn't supported.
282294

283295
.. autoclass:: ddtrace.propagation.http.HTTPPropagator
284296
:members:

0 commit comments

Comments
 (0)