debian-mirror-gitlab/debian/gems-compat/opentracing-0.4.3/lib/opentracing/scope_manager.rb
2019-03-14 13:13:30 +05:30

35 lines
1.2 KiB
Ruby

module OpenTracing
# ScopeManager represents an OpenTracing ScopeManager
#
# See http://www.opentracing.io for more information.
#
# The ScopeManager interface abstracts both the activation of Span instances
# via ScopeManager#activate and access to an active Span/Scope via
# ScopeManager#active
#
class ScopeManager
NOOP_INSTANCE = ScopeManager.new.freeze
# Make a span instance active.
#
# @param span [Span] the Span that should become active
# @param finish_on_close [Boolean] whether the Span should automatically be
# finished when Scope#close is called
# @return [Scope] instance to control the end of the active period for the
# Span. It is a programming error to neglect to call Scope#close on the
# returned instance.
def activate(span, finish_on_close: true)
Scope::NOOP_INSTANCE
end
# @return [Scope] the currently active Scope which can be used to access the
# currently active Span.
#
# If there is a non-null Scope, its wrapped Span becomes an implicit parent
# (as Reference#CHILD_OF) of any newly-created Span at Tracer#start_active_span
# or Tracer#start_span time.
def active
Scope::NOOP_INSTANCE
end
end
end