1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
|
# Copyright (c) 2017 The OpenTracing Authors.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
from __future__ import absolute_import
from .span import Span, SpanContext
from .scope import Scope
class ScopeManager(object):
"""The :class:`ScopeManager` interface abstracts both the activation of
a :class:`Span` and access to an active :class:`Span`/:class:`Scope`.
"""
def __init__(self):
# TODO: `tracer` should not be None, but we don't have a reference;
# should we move the NOOP SpanContext, Span, Scope to somewhere
# else so that they're globally reachable?
self._noop_span = Span(tracer=None, context=SpanContext())
self._noop_scope = Scope(self, self._noop_span)
def activate(self, span, finish_on_close):
"""Makes a :class:`Span` active.
:param span: the :class:`Span` that should become active.
:param finish_on_close: whether :class:`Span` should be automatically
finished when :meth:`Scope.close()` is called.
:rtype: Scope
:return: a :class:`Scope` to control the end of the active period for
*span*. It is a programming error to neglect to call
:meth:`Scope.close()` on the returned instance.
"""
return self._noop_scope
@property
def active(self):
"""Returns the currently active :class:`Scope` which can be used to access the
currently active :attr:`Scope.span`.
If there is a non-null :class:`Scope`, its wrapped :class:`Span`
becomes an implicit parent of any newly-created :class:`Span` at
:meth:`Tracer.start_active_span()` time.
:rtype: Scope
:return: the :class:`Scope` that is active, or ``None`` if not
available.
"""
return self._noop_scope
|