Skip to content

add parameter to use with flask opentracing #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add parameter to use with flask opentracing #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions sqlalchemy_opentracing/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,32 +5,40 @@
g_tracer = None
g_trace_all_queries = False
g_trace_all_engines = False
g_flask_tracer = False
g_origin_tracer = None

def init_tracing(tracer, trace_all_engines=True, trace_all_queries=True):

def init_tracing(tracer, trace_all_engines=True, trace_all_queries=True, flask_tracer=False):
'''
Set our global tracer.
Tracer objects from our pyramid/flask/django libraries
can be passed as well.
'''
global g_tracer, g_trace_all_engines, g_trace_all_queries
global g_tracer, g_trace_all_engines, g_trace_all_queries, g_flask_tracer, g_origin_tracer

g_origin_tracer = tracer

if hasattr(tracer, '_tracer'):
tracer = tracer._tracer

g_tracer = tracer
g_trace_all_queries = trace_all_queries
g_trace_all_engines = trace_all_engines
g_flask_tracer = flask_tracer

if trace_all_engines:
register_engine(Engine)


def get_traced(obj):
'''
Gets a bool indicating whether or not this
object is marked for tracing.
'''
return getattr(obj, '_traced', False)


def set_traced(obj):
'''
Mark a statement/session to be traced.
Expand All @@ -46,6 +54,7 @@ def set_traced(obj):
# after commit/rollback.
_register_connection_events(obj)


def clear_traced(obj):
'''
Clear an object's decorated tracing fields,
Expand All @@ -56,11 +65,17 @@ def clear_traced(obj):
if hasattr(obj, '_traced'):
del obj._traced


def get_parent_span(obj):
'''
Gets a parent span for this object, if any.
'''
return getattr(obj, '_parent_span', None)
parent_span = getattr(obj, '_parent_span', None)
# use flask_tracer current span as default parent span
if parent_span is None and g_flask_tracer:
parent_span = g_origin_tracer.get_span()
return parent_span


def set_parent_span(obj, parent_span):
'''
Expand All @@ -70,13 +85,15 @@ def set_parent_span(obj, parent_span):
obj._parent_span = parent_span
set_traced(obj)


def has_parent_span(obj):
'''
Get whether or not the statement has
a parent span.
'''
return hasattr(obj, '_parent_span')


def register_engine(obj):
'''
Register an engine to have its events be traced.
Expand All @@ -90,6 +107,7 @@ def register_engine(obj):
listen(obj, 'after_cursor_execute', _engine_after_cursor_handler)
listen(obj, 'handle_error', _engine_error_handler)


def unregister_engine(obj):
'''
Remove an engine from having its events being traced.
Expand All @@ -98,13 +116,15 @@ def unregister_engine(obj):
remove(obj, 'after_cursor_execute', _engine_after_cursor_handler)
remove(obj, 'handle_error', _engine_error_handler)


def _clear_tracer():
'''
Set the tracer to None. For test cases usage.
'''
global g_tracer
g_tracer = None


def _can_operation_be_traced(conn, stmt_obj):
'''
Get whether an operation can be traced, depending on its
Expand Down Expand Up @@ -173,6 +193,7 @@ def _engine_before_cursor_handler(conn, cursor,
def _engine_after_cursor_handler(conn, cursor,
statement, parameters,
context, executemany):

span = getattr(context, '_span', None)
if span is None:
return
Expand Down Expand Up @@ -243,3 +264,4 @@ def _session_after_begin_handler(session, transaction, conn):
def _session_cleanup_handler(session):
clear_traced(session)