Skip to content

Commit 3f7fbe9

Browse files
committed
Improve Flask distributed_tracing documentation
1 parent 6408c94 commit 3f7fbe9

File tree

4 files changed

+8
-5
lines changed

4 files changed

+8
-5
lines changed

ddtrace/contrib/flask/__init__.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
1111
and create a `TraceMiddleware` object::
1212
13-
traced_app = TraceMiddleware(app, tracer, service="my-flask-app")
13+
traced_app = TraceMiddleware(app, tracer, service="my-flask-app", distributed_tracing=False)
1414
1515
Here is the end result, in a sample app::
1616
@@ -22,12 +22,14 @@
2222
2323
app = Flask(__name__)
2424
25-
traced_app = TraceMiddleware(app, tracer, service="my-flask-app")
25+
traced_app = TraceMiddleware(app, tracer, service="my-flask-app", distributed_tracing=False)
2626
2727
@app.route("/")
2828
def home():
2929
return "hello world"
3030
31+
Set `distributed_tracing=True` if this is called remotely from an instrumented application.
32+
We suggest to enable it only for internal services where headers are under your control.
3133
"""
3234

3335
from ..util import require_modules

ddtrace/contrib/flask/middleware.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@
2323

2424
class TraceMiddleware(object):
2525

26-
def __init__(self, app, tracer, service="flask", use_signals=True, use_distributed_tracing=False):
26+
def __init__(self, app, tracer, service="flask", use_signals=True, distributed_tracing=False):
2727
self.app = app
2828
self.app.logger.info("initializing trace middleware")
2929

3030
# save our traces.
3131
self._tracer = tracer
3232
self._service = service
33-
self._use_distributed_tracing = use_distributed_tracing
33+
self._use_distributed_tracing = distributed_tracing
3434

3535
self._tracer.set_service_info(
3636
service=service,

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,7 @@ For that, refer to the configuration of the given integration.
285285
Supported web frameworks:
286286

287287
- Django
288+
- Flask
288289

289290

290291
HTTP client/server

tests/contrib/flask/test_flask.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ def handle_my_exception(e):
9292
# work)
9393
service = "test.flask.service"
9494
assert not writer.pop() # should always be empty
95-
traced_app = TraceMiddleware(app, tracer, service=service, use_distributed_tracing=True)
95+
traced_app = TraceMiddleware(app, tracer, service=service, distributed_tracing=True)
9696

9797
# make the app testable
9898
app.config['TESTING'] = True

0 commit comments

Comments
 (0)