Skip to content

Commit ea9644f

Browse files
committed
Set general default to True and adapt SQLAlchemy to follow the flag
1 parent 0ba9210 commit ea9644f

File tree

3 files changed

+12
-6
lines changed

3 files changed

+12
-6
lines changed

aws_xray_sdk/core/recorder.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ def configure(self, sampling=None, plugins=None,
8383
context=None, emitter=None, streaming=None,
8484
dynamic_naming=None, streaming_threshold=None,
8585
max_trace_back=None, sampler=None,
86-
stream_sql=False):
86+
stream_sql=True):
8787
"""Configure global X-Ray recorder.
8888
8989
Configure needs to run before patching thrid party libraries

aws_xray_sdk/ext/sqlalchemy/util/decorators.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ def wrapper(*args, **kw):
4747
if isinstance(arg, XRayQuery):
4848
try:
4949
sql = parse_bind(arg.session.bind)
50-
sql['sanitized_query'] = str(arg)
50+
if xray_recorder.stream_sql:
51+
sql['sanitized_query'] = str(arg)
5152
except Exception:
5253
sql = None
5354
if sql is not None:

tests/ext/flask_sqlalchemy/test_query.py

+9-4
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,15 @@ class User(db.Model):
2222
password = db.Column(db.String(255), nullable=False)
2323

2424

25-
@pytest.fixture()
26-
def session():
25+
@pytest.fixture(
26+
params=[
27+
False,
28+
True,
29+
],
30+
)
31+
def session(request):
2732
"""Test Fixture to Create DataBase Tables and start a trace segment"""
28-
xray_recorder.configure(service='test', sampling=False, context=Context())
33+
xray_recorder.configure(service='test', sampling=False, context=Context(), stream_sql=request.param)
2934
xray_recorder.clear_trace_entities()
3035
xray_recorder.begin_segment('SQLAlchemyTest')
3136
db.create_all()
@@ -41,8 +46,8 @@ def test_all(capsys, session):
4146
User.query.all()
4247
subsegment = find_subsegment_by_annotation(xray_recorder.current_segment(), 'sqlalchemy', 'sqlalchemy.orm.query.all')
4348
assert subsegment['annotations']['sqlalchemy'] == 'sqlalchemy.orm.query.all'
44-
assert subsegment['sql']['sanitized_query']
4549
assert subsegment['sql']['url']
50+
assert bool(subsegment['sql'].get('sanitized_query', None)) is xray_recorder.stream_sql
4651

4752

4853
def test_add(capsys, session):

0 commit comments

Comments
 (0)