Skip to content

More consistent naming of Tracer.start_*() methods with other language implementations #1

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
itsderek23 wants to merge 1 commit into
base: palazzem/scope-manager
Choose a base branch
from
Open

More consistent naming of Tracer.start_*() methods with other language implementations #1

Show file tree
Hide file tree
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
110 changes: 55 additions & 55 deletions opentracing/harness/api_check.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,47 +71,47 @@ def test_start_span(self):
payload={'hospital': 'Brooklyn Pre-Med Hospital',
'city': 'Old New York'})

def test_start_active(self):
def test_start_active_scope(self):
# the first usage returns a `Scope` that wraps a root `Span`
tracer = self.tracer()
scope = tracer.start_active(operation_name='Fry')
scope = tracer.start_active_scope(operation_name='Fry')

assert scope.span() is not None
if self.check_scope_manager():
assert self.is_parent(None, scope.span())

def test_start_active_parent(self):
def test_start_active_scope_parent(self):
# ensure the `ScopeManager` provides the right parenting
tracer = self.tracer()
with tracer.start_active(operation_name='Fry') as parent:
with tracer.start_active(operation_name='Farnsworth') as child:
with tracer.start_active_scope(operation_name='Fry') as parent:
with tracer.start_active_scope(operation_name='Farnsworth') as child:
if self.check_scope_manager():
assert self.is_parent(parent.span(), child.span())

def test_start_active_ignore_active_scope(self):
def test_start_active_scope_ignore_active_scope(self):
# ensure the `ScopeManager` ignores the active `Scope`
# if the flag is set
tracer = self.tracer()
with tracer.start_active(operation_name='Fry') as parent:
with tracer.start_active(operation_name='Farnsworth',
with tracer.start_active_scope(operation_name='Fry') as parent:
with tracer.start_active_scope(operation_name='Farnsworth',
ignore_active_scope=True) as child:
if self.check_scope_manager():
assert not self.is_parent(parent.span(), child.span())

def test_start_active_finish_on_close(self):
def test_start_active_scope_finish_on_close(self):
# ensure a `Span` is finished when the `Scope` close
tracer = self.tracer()
scope = tracer.start_active(operation_name='Fry')
scope = tracer.start_active_scope(operation_name='Fry')
with mock.patch.object(scope.span(), 'finish') as finish:
scope.close()

if self.check_scope_manager():
assert finish.call_count == 1

def test_start_active_not_finish_on_close(self):
def test_start_active_scope_not_finish_on_close(self):
# a `Span` is not finished when the flag is set
tracer = self.tracer()
scope = tracer.start_active(operation_name='Fry',
scope = tracer.start_active_scope(operation_name='Fry',
finish_on_close=False)
with mock.patch.object(scope.span(), 'finish') as finish:
scope.close()
Expand All @@ -121,46 +121,46 @@ def test_start_active_not_finish_on_close(self):
def test_scope_as_context_manager(self):
tracer = self.tracer()

with tracer.start_active(operation_name='antiquing') as scope:
with tracer.start_active_scope(operation_name='antiquing') as scope:
assert scope.span() is not None

def test_start_manual(self):
def test_start_span(self):
tracer = self.tracer()
span = tracer.start_manual(operation_name='Fry')
span = tracer.start_span(operation_name='Fry')
span.finish()
with tracer.start_manual(operation_name='Fry',
with tracer.start_span(operation_name='Fry',
tags={'birthday': 'August 14 1974'}) as span:
span.log_event('birthplace',
payload={'hospital': 'Brooklyn Pre-Med Hospital',
'city': 'Old New York'})

def test_start_manual_propagation(self):
# `start_manual` must inherit the current active `Scope` span
def test_start_span_propagation(self):
# `start_span` must inherit the current active `Scope` span
tracer = self.tracer()
with tracer.start_active(operation_name='Fry') as parent:
with tracer.start_manual(operation_name='Farnsworth') as child:
with tracer.start_active_scope(operation_name='Fry') as parent:
with tracer.start_span(operation_name='Farnsworth') as child:
if self.check_scope_manager():
assert self.is_parent(parent.span(), child)

def test_start_manual_propagation_ignore_active_scope(self):
# `start_manual` doesn't inherit the current active `Scope` span
def test_start_span_propagation_ignore_active_scope(self):
# `start_span` doesn't inherit the current active `Scope` span
# if the flag is set
tracer = self.tracer()
with tracer.start_active(operation_name='Fry') as parent:
with tracer.start_manual(operation_name='Farnsworth',
with tracer.start_active_scope(operation_name='Fry') as parent:
with tracer.start_span(operation_name='Farnsworth',
ignore_active_scope=True) as child:
if self.check_scope_manager():
assert not self.is_parent(parent.span(), child)

def test_start_manual_with_parent(self):
def test_start_span_with_parent(self):
tracer = self.tracer()
parent_span = tracer.start_manual(operation_name='parent')
parent_span = tracer.start_span(operation_name='parent')
assert parent_span is not None
span = tracer.start_manual(
span = tracer.start_span(
operation_name='Leela',
child_of=parent_span)
span.finish()
span = tracer.start_manual(
span = tracer.start_span(
operation_name='Leela',
references=[opentracing.follows_from(parent_span.context)],
tags={'birthplace': 'sewers'})
Expand All @@ -169,15 +169,15 @@ def test_start_manual_with_parent(self):

def test_start_child_span(self):
tracer = self.tracer()
parent_span = tracer.start_manual(operation_name='parent')
parent_span = tracer.start_span(operation_name='parent')
assert parent_span is not None
child_span = opentracing.start_child_span(
parent_span, operation_name='Leela')
child_span.finish()
parent_span.finish()

def test_set_operation_name(self):
span = self.tracer().start_manual().set_operation_name('Farnsworth')
span = self.tracer().start_span().set_operation_name('Farnsworth')
span.finish()

def test_span_as_context_manager(self):
Expand All @@ -187,14 +187,14 @@ def test_span_as_context_manager(self):
def mock_finish(*_):
finish['called'] = True

with tracer.start_manual(operation_name='antiquing') as span:
with tracer.start_span(operation_name='antiquing') as span:
setattr(span, 'finish', mock_finish)
assert finish['called'] is True

# now try with exception
finish['called'] = False
try:
with tracer.start_manual(operation_name='antiquing') as span:
with tracer.start_span(operation_name='antiquing') as span:
setattr(span, 'finish', mock_finish)
raise ValueError()
except ValueError:
Expand All @@ -203,14 +203,14 @@ def mock_finish(*_):
raise AssertionError('Expected ValueError') # pragma: no cover

def test_span_tag_value_types(self):
with self.tracer().start_manual(operation_name='ManyTypes') as span:
with self.tracer().start_span(operation_name='ManyTypes') as span:
span. \
set_tag('an_int', 9). \
set_tag('a_bool', True). \
set_tag('a_string', 'aoeuidhtns')

def test_span_tags_with_chaining(self):
span = self.tracer().start_manual(operation_name='Farnsworth')
span = self.tracer().start_span(operation_name='Farnsworth')
span. \
set_tag('birthday', '9 April, 2841'). \
set_tag('loves', 'different lengths of wires')
Expand All @@ -220,7 +220,7 @@ def test_span_tags_with_chaining(self):
span.finish()

def test_span_logs(self):
span = self.tracer().start_manual(operation_name='Fry')
span = self.tracer().start_span(operation_name='Fry')

# Newer API
span.log_kv(
Expand All @@ -245,7 +245,7 @@ def test_span_logs(self):
payload={'year': 2999})

def test_span_baggage(self):
with self.tracer().start_manual(operation_name='Fry') as span:
with self.tracer().start_span(operation_name='Fry') as span:
assert span.context.baggage == {}
span_ref = span.set_baggage_item('Kiff-loves', 'Amy')
assert span_ref is span
Expand All @@ -255,15 +255,15 @@ def test_span_baggage(self):
pass

def test_context_baggage(self):
with self.tracer().start_manual(operation_name='Fry') as span:
with self.tracer().start_span(operation_name='Fry') as span:
assert span.context.baggage == {}
span.set_baggage_item('Kiff-loves', 'Amy')
if self.check_baggage_values():
assert span.context.baggage == {'Kiff-loves': 'Amy'}
pass

def test_text_propagation(self):
with self.tracer().start_manual(operation_name='Bender') as span:
with self.tracer().start_span(operation_name='Bender') as span:
text_carrier = {}
self.tracer().inject(
span_context=span.context,
Expand All @@ -275,7 +275,7 @@ def test_text_propagation(self):
assert extracted_ctx.baggage == {}

def test_binary_propagation(self):
with self.tracer().start_manual(operation_name='Bender') as span:
with self.tracer().start_span(operation_name='Bender') as span:
bin_carrier = bytearray()
self.tracer().inject(
span_context=span.context,
Expand All @@ -292,35 +292,35 @@ def test_mandatory_formats(self):
(Format.HTTP_HEADERS, {}),
(Format.BINARY, bytearray()),
]
with self.tracer().start_manual(operation_name='Bender') as span:
with self.tracer().start_span(operation_name='Bender') as span:
for fmt, carrier in formats:
# expecting no exceptions
span.tracer.inject(span.context, fmt, carrier)
span.tracer.extract(fmt, carrier)

def test_unknown_format(self):
custom_format = 'kiss my shiny metal ...'
with self.tracer().start_manual(operation_name='Bender') as span:
with self.tracer().start_span(operation_name='Bender') as span:
with pytest.raises(opentracing.UnsupportedFormatException):
span.tracer.inject(span.context, custom_format, {})
with pytest.raises(opentracing.UnsupportedFormatException):
span.tracer.extract(custom_format, {})

def test_tracer_start_active_scope(self):
def test_tracer_start_active_scope_scope(self):
# the Tracer ScopeManager should store the active Scope
tracer = self.tracer()
scope = tracer.start_active(operation_name='Fry')
scope = tracer.start_active_scope(operation_name='Fry')

if self.check_scope_manager():
assert tracer.scope_manager.active() == scope

scope.close()

def test_tracer_start_active_nesting(self):
def test_tracer_start_active_scope_nesting(self):
# when a Scope is closed, the previous one must be activated
tracer = self.tracer()
with tracer.start_active(operation_name='Fry') as parent:
with tracer.start_active(operation_name='Farnsworth'):
with tracer.start_active_scope(operation_name='Fry') as parent:
with tracer.start_active_scope(operation_name='Farnsworth'):
pass

if self.check_scope_manager():
Expand All @@ -329,13 +329,13 @@ def test_tracer_start_active_nesting(self):
if self.check_scope_manager():
assert tracer.scope_manager.active() is None

def test_tracer_start_active_nesting_finish_on_close(self):
def test_tracer_start_active_scope_nesting_finish_on_close(self):
# finish_on_close must be correctly handled
tracer = self.tracer()
parent = tracer.start_active(operation_name='Fry',
parent = tracer.start_active_scope(operation_name='Fry',
finish_on_close=False)
with mock.patch.object(parent.span(), 'finish') as finish:
with tracer.start_active(operation_name='Farnsworth'):
with tracer.start_active_scope(operation_name='Farnsworth'):
pass
parent.close()

Expand All @@ -344,20 +344,20 @@ def test_tracer_start_active_nesting_finish_on_close(self):
if self.check_scope_manager():
assert tracer.scope_manager.active() is None

def test_tracer_start_active_wrong_close_order(self):
def test_tracer_start_active_scope_wrong_close_order(self):
# only the active `Scope` can be closed
tracer = self.tracer()
parent = tracer.start_active(operation_name='Fry')
child = tracer.start_active(operation_name='Farnsworth')
parent = tracer.start_active_scope(operation_name='Fry')
child = tracer.start_active_scope(operation_name='Farnsworth')
parent.close()

if self.check_scope_manager():
assert tracer.scope_manager.active() == child

def test_tracer_start_manual_scope(self):
def test_tracer_start_span_scope(self):
# the Tracer ScopeManager should not store the new Span
tracer = self.tracer()
span = tracer.start_manual(operation_name='Fry')
span = tracer.start_span(operation_name='Fry')

if self.check_scope_manager():
assert tracer.scope_manager.active() is None
Expand All @@ -374,7 +374,7 @@ def test_tracer_scope_manager_active(self):
def test_tracer_scope_manager_activate(self):
# a `ScopeManager` should activate any `Span`
tracer = self.tracer()
span = tracer.start_manual(operation_name='Fry')
span = tracer.start_span(operation_name='Fry')
tracer.scope_manager.activate(span)

if self.check_scope_manager():
Expand Down
2 changes: 1 addition & 1 deletion opentracing/scope_manager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ def active(self):
currently active `Scope#span()`.

If there is a non-null `Scope`, its wrapped `Span` becomes an implicit
parent of any newly-created `Span` at `Tracer#start_active()`
parent of any newly-created `Span` at `Tracer#start_active_scope()`
time.

:return: the `Scope` that is active, or `None` if not available.
Expand Down
Loading