Class: Atatus::Span Private

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
ChildDurations::Methods
Defined in:
lib/atatus/span.rb,
lib/atatus/span/context.rb,
lib/atatus/span/context/db.rb,
lib/atatus/span/context/http.rb,
lib/atatus/span/context/links.rb,
lib/atatus/span/context/message.rb,
lib/atatus/span/context/service.rb,
lib/atatus/span/context/destination.rb

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Defined Under Namespace

Classes: Context, Outcome

Constant Summary collapse

DEFAULT_TYPE =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

'custom'

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ChildDurations::Methods

#child_durations, #child_started, #child_stopped

Constructor Details

#initialize(name:, transaction:, trace_context:, parent:, type: nil, subtype: nil, action: nil, context: nil, stacktrace_builder: nil, sync: nil, exit_span: false) ⇒ Span

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

rubocop:disable Metrics/ParameterLists



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/atatus/span.rb', line 42

def initialize(
  name:,
  transaction:,
  trace_context:,
  parent:,
  type: nil,
  subtype: nil,
  action: nil,
  context: nil,
  stacktrace_builder: nil,
  sync: nil,
  exit_span: false
)
  @name = name

  if subtype.nil? && type&.include?('.')
    @type, @subtype, @action = type.split('.')
  else
    @type = type || DEFAULT_TYPE
    @subtype = subtype
    @action = action
  end

  @transaction = transaction
  @transaction_id = transaction.id
  @parent = parent
  @trace_context = trace_context || parent.trace_context.child
  @sample_rate = transaction.sample_rate

  @context = context || Span::Context.new(sync: sync)
  @stacktrace_builder = stacktrace_builder

  @exit_span = exit_span
end

Instance Attribute Details

#action ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



80
81
82
 
# File 'lib/atatus/span.rb', line 80

def action
  @action
end

#context ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



90
91
92
 
# File 'lib/atatus/span.rb', line 90

def context
  @context
end

#duration ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



90
91
92
 
# File 'lib/atatus/span.rb', line 90

def duration
  @duration
end

#exit_span ⇒ Object Also known as: exit_span?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



80
81
82
 
# File 'lib/atatus/span.rb', line 80

def exit_span
  @exit_span
end

#name ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



80
81
82
 
# File 'lib/atatus/span.rb', line 80

def name
  @name
end

#original_backtrace ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



80
81
82
 
# File 'lib/atatus/span.rb', line 80

def original_backtrace
  @original_backtrace
end

#outcome ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



80
81
82
 
# File 'lib/atatus/span.rb', line 80

def outcome
  @outcome
end

#parent ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



90
91
92
 
# File 'lib/atatus/span.rb', line 90

def parent
  @parent
end

#sample_rate ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



90
91
92
 
# File 'lib/atatus/span.rb', line 90

def sample_rate
  @sample_rate
end

#self_time ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



90
91
92
 
# File 'lib/atatus/span.rb', line 90

def self_time
  @self_time
end

#stacktrace ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



90
91
92
 
# File 'lib/atatus/span.rb', line 90

def stacktrace
  @stacktrace
end

#subtype ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



80
81
82
 
# File 'lib/atatus/span.rb', line 80

def subtype
  @subtype
end

#timestamp ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



90
91
92
 
# File 'lib/atatus/span.rb', line 90

def timestamp
  @timestamp
end

#trace_context ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



80
81
82
 
# File 'lib/atatus/span.rb', line 80

def trace_context
  @trace_context
end

#transaction ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



90
91
92
 
# File 'lib/atatus/span.rb', line 90

def transaction
  @transaction
end

#transaction_id ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



90
91
92
 
# File 'lib/atatus/span.rb', line 90

def transaction_id
  @transaction_id
end

#type ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



80
81
82
 
# File 'lib/atatus/span.rb', line 80

def type
  @type
end

Instance Method Details

#done(clock_end: Util.monotonic_micros) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



121
122
123
124
 
# File 'lib/atatus/span.rb', line 121

def done(clock_end: Util.monotonic_micros)
  stop clock_end
  self
end

#inspect ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



155
156
157
158
159
160
161
162
163
 
# File 'lib/atatus/span.rb', line 155

def inspect
  "<Atatus::Span id:#{trace_context&.id}" \
    " name:#{name.inspect}" \
    " type:#{type.inspect}" \
    " subtype:#{subtype.inspect}" \
    " action:#{action.inspect}" \
    " exit_span:#{exit_span.inspect}" \
    '>'
end

#prepare_for_serialization! ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



126
127
128
129
 
# File 'lib/atatus/span.rb', line 126

def prepare_for_serialization!
  # build_stacktrace! if should_build_stacktrace?
  self.original_backtrace = nil # release original
end

#running? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 


139
140
141
 
# File 'lib/atatus/span.rb', line 139

def running?
  started? && !stopped?
end

#set_destination(address: nil, port: nil, service: nil, cloud: nil) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/atatus/span.rb', line 143

def set_destination(address: nil, port: nil, service: nil, cloud: nil)
  context.destination = Span::Context::Destination.new(
    address: address,
    port: port,
    service: service,
    cloud: cloud
  )
  context.service = Span::Context::Service.new(
    target: Span::Context::Service::Target.new(name: context.destination.service.name, type: context.destination.service.type )
  )
end

#start(clock_start = Util.monotonic_micros) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

life cycle



106
107
108
109
110
111
 
# File 'lib/atatus/span.rb', line 106

def start(clock_start = Util.monotonic_micros)
  @timestamp = Util.micros
  @clock_start = clock_start
  @parent.child_started
  self
end

#started? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 


135
136
137
 
# File 'lib/atatus/span.rb', line 135

def started?
  !!timestamp
end

#stop(clock_end = Util.monotonic_micros) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



113
114
115
116
117
118
119
 
# File 'lib/atatus/span.rb', line 113

def stop(clock_end = Util.monotonic_micros)
  @duration ||= (clock_end - @clock_start)
  @parent.child_stopped
  @self_time = @duration - child_durations.duration

  self
end

#stopped? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 


131
132
133
 
# File 'lib/atatus/span.rb', line 131

def stopped?
  !!duration
end