Class: Instana::Span

Inherits:
Object
  • Object
show all
Defined in:
lib/instana/tracing/span.rb

Constant Summary collapse

REGISTERED_SPANS = 
[ :actioncontroller, :actionview, :activerecord, :excon,
:memcache, :'net-http', :rack, :render, :'rpc-client',
:'rpc-server', :'sidekiq-client', :'sidekiq-worker',
:redis, :'resque-client', :'resque-worker' ].freeze
ENTRY_SPANS = 
[ :rack, :'resque-worker', :'rpc-server', :'sidekiq-worker' ].freeze
EXIT_SPANS = 
[ :activerecord, :excon, :'net-http', :'resque-client',
:'rpc-client', :'sidekiq-client', :redis ].freeze
HTTP_SPANS = 
[ :rack, :excon, :'net-http' ].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, trace_id, parent_id: nil, start_time: ::Instana::Util.now_in_ms) ⇒ Span

Returns a new instance of Span.



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
 
# File 'lib/instana/tracing/span.rb', line 15

def initialize(name, trace_id, parent_id: nil, start_time: ::Instana::Util.now_in_ms)
  @data = {}
  @data[:t] = trace_id                    # Trace ID
  @data[:s] = ::Instana::Util.generate_id # Span ID
  @data[:p] = parent_id if parent_id      # Parent ID
  @data[:ta] = :ruby                      # Agent
  @data[:data] = {}

  # Entity Source
  @data[:f] = { :e => ::Instana.agent.report_pid,
                :h => ::Instana.agent.agent_uuid }
  # Start time
  if start_time.is_a?(Time)
    @data[:ts] = ::Instana::Util.time_to_ms(start_time)
  else
    @data[:ts] = start_time
  end

  @baggage = {}

  if ::Instana.config[:collect_backtraces]
    # For entry spans, add a backtrace fingerprint
    add_stack(limit: 2) if ENTRY_SPANS.include?(name)

    # Attach a backtrace to all exit spans
    add_stack if EXIT_SPANS.include?(name)
  end

  # Check for custom tracing
  if REGISTERED_SPANS.include?(name.to_sym)
    @data[:n] = name.to_sym
  else
    configure_custom(name)
  end
end

Instance Attribute Details

#baggage ⇒ Object

Returns the value of attribute baggage.



13
14
15
 
# File 'lib/instana/tracing/span.rb', line 13

def baggage
  @baggage
end

#parent ⇒ Object

Returns the value of attribute parent.



12
13
14
 
# File 'lib/instana/tracing/span.rb', line 12

def parent
  @parent
end

Instance Method Details

#[](key) ⇒ Object

Hash accessor to the internal @data hash



222
223
224
 
# File 'lib/instana/tracing/span.rb', line 222

def [](key)
  @data[key.to_sym]
end

#[]=(key, value) ⇒ Object

Hash setter to the internal @data hash



228
229
230
 
# File 'lib/instana/tracing/span.rb', line 228

def []=(key, value)
  @data[key.to_sym] = value
end

#add_error(e) ⇒ Object

Log an error into the span

Parameters:

  • e (Exception) —

    The exception to be logged



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/instana/tracing/span.rb', line 83

def add_error(e)
  @data[:error] = true

  if @data.key?(:ec)
    @data[:ec] = @data[:ec] + 1
  else
    @data[:ec] = 1
  end

  # If a valid exception has been passed in, log the information about it
  # In case of just logging an error for things such as HTTP client 5xx
  # responses, an exception/backtrace may not exist.
  if e
    if e.backtrace.is_a?(Array)
      add_stack(stack: e.backtrace)
    end

    if HTTP_SPANS.include?(@data[:n])
      set_tags(:http => { :error => "#{e.class}: #{e.message}" })
    else
      log(:error, Time.now, { :message => e.message, :parameters => e.class.to_s })
    end
    e.instance_variable_set(:@instana_logged, true)
  end
  self
end

#add_stack(limit: nil, stack: Kernel.caller) ⇒ Object

Adds a backtrace to this span

Parameters:

  • limit (Integer) (defaults to: nil) —

    Limit the backtrace to the top <limit> frames



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/instana/tracing/span.rb', line 55

def add_stack(limit: nil, stack: Kernel.caller)
  frame_count = 0
  @data[:stack] = []

  stack.each do |i|
    # If the stack has the full instana gem version in it's path
    # then don't include that frame. Also don't exclude the Rack module.
    if !i.match(/instana\/instrumentation\/rack.rb/).nil? ||
      (i.match(::Instana::VERSION_FULL).nil? && i.match('lib/instana/').nil?)

      break if limit && frame_count >= limit

      x = i.split(':')

      @data[:stack] << {
        :c => x[0],
        :n => x[1],
        :m => x[2]
      }
     frame_count = frame_count + 1 if limit
    end
  end
end

#close(end_time = ::Instana::Util.now_in_ms) ⇒ Span

Closes out the span. This difference between this and the finish method tells us how the tracing is being performed (with OpenTracing or Instana default)

Parameters:

  • end_time (Time) (defaults to: ::Instana::Util.now_in_ms) —

    custom end time, if not now

Returns:



131
132
133
134
135
136
137
138
139
 
# File 'lib/instana/tracing/span.rb', line 131

def close(end_time = ::Instana::Util.now_in_ms)

  if end_time.is_a?(Time)
    end_time = ::Instana::Util.time_to_ms(end_time)
  end

  @data[:d] = end_time - @data[:ts]
  self
end

#configure_custom(name) ⇒ Object

Configure this span to be a custom span per the SDK generic span type.

Parameters:

  • name (String) —

    name of the span

  • kvs (Hash) —

    list of key values to be reported in the span



117
118
119
120
121
122
 
# File 'lib/instana/tracing/span.rb', line 117

def configure_custom(name)
  @data[:n] = :sdk
  @data[:data] = { :sdk => { :name => name.to_sym } }
  @data[:data][:sdk][:custom] = { :tags => {}, :logs => {} }
  self
end

#context ⇒ Instana::SpanContext

Retrieve the context of this span.

Returns:



149
150
151
 
# File 'lib/instana/tracing/span.rb', line 149

def context
  @context ||= ::Instana::SpanContext.new(@data[:t], @data[:s], @baggage)
end

#custom? ⇒ Boolean

Indicates whether this span is a custom or registered Span

Returns:

  • (Boolean) 


245
246
247
 
# File 'lib/instana/tracing/span.rb', line 245

def custom?
  @data[:n] == :sdk
end

#duration ⇒ Integer

Get the duration value for this Span

Returns:

  • (Integer) —

    the duration in milliseconds



207
208
209
 
# File 'lib/instana/tracing/span.rb', line 207

def duration
  @data[:d]
end

#finish(end_time = ::Instana::Util.now_in_ms) ⇒ Object

Finish the Instana::Span Spec: OpenTracing API

Parameters:

  • end_time (Time) (defaults to: ::Instana::Util.now_in_ms) —

    custom end time, if not now



375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/instana/tracing/span.rb', line 375

def finish(end_time = ::Instana::Util.now_in_ms)
  if ::Instana.tracer.current_span.id != id
    ::Instana.logger.debug "Closing a span that isn't active. This will result in a broken trace: #{self.inspect}"
  end

  if is_root?
    # This is the root span for the trace.  Call log_end to close
    # out and queue the trace
    ::Instana.tracer.log_end(name, {}, end_time)
  else
    ::Instana.tracer.current_trace.end_span({}, end_time)
  end
  self
end

#get_baggage_item(key) ⇒ Object

Get a baggage item Spec: OpenTracing API

Parameters:

  • key (String) —

    the key of the baggage item

Returns:

  • Value of the baggage item



336
337
338
 
# File 'lib/instana/tracing/span.rb', line 336

def get_baggage_item(key)
  @baggage[key]
end

#id ⇒ Integer

Retrieve the ID for this span

Returns:

  • (Integer) —

    the span ID



156
157
158
 
# File 'lib/instana/tracing/span.rb', line 156

def id
  @data[:s]
end

#inspect ⇒ Object 



249
250
251
 
# File 'lib/instana/tracing/span.rb', line 249

def inspect
  @data.inspect
end

#is_root? ⇒ Boolean

Indicates whether this span in the root span in the Trace

Returns:

  • (Boolean) 


216
217
218
 
# File 'lib/instana/tracing/span.rb', line 216

def is_root?
  @data[:s] == @data[:t]
end

#key?(k) ⇒ Boolean

Hash key query to the internal @data hash

Returns:

  • (Boolean) 


234
235
236
 
# File 'lib/instana/tracing/span.rb', line 234

def key?(k)
  @data.key?(k.to_sym)
end

#log(event = nil, timestamp = Time.now, **fields) ⇒ Object

Add a log entry to this span Spec: OpenTracing API

Parameters:

  • event (String) (defaults to: nil) —

    event name for the log

  • timestamp (Time) (defaults to: Time.now) —

    time of the log

  • fields (Hash) —

    Additional information to log



358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/instana/tracing/span.rb', line 358

def log(event = nil, timestamp = Time.now, **fields)
  ts = ::Instana::Util.time_to_ms(timestamp).to_s
  if custom?
    @data[:data][:sdk][:custom][:logs][ts] = fields
    @data[:data][:sdk][:custom][:logs][ts][:event] = event
  else
    set_tags(:log => fields)
  end
rescue StandardError => e
  Instana.logger.debug "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
end

#name ⇒ String

Get the name (operation) of this Span

Returns:

  • (String) —

    or [Symbol] representing the span name



184
185
186
187
188
189
190
 
# File 'lib/instana/tracing/span.rb', line 184

def name
  if custom?
    @data[:data][:sdk][:name]
  else
    @data[:n]
  end
end

#name=(n) ⇒ Object

Set the name (operation) for this Span



196
197
198
199
200
201
202
 
# File 'lib/instana/tracing/span.rb', line 196

def name=(n)
  if custom?
    @data[:data][:sdk][:name] = n
  else
    @data[:n] = n
  end
end

#operation_name=(name) ⇒ Object

Set the name of the operation Spec: OpenTracing API



262
263
264
 
# File 'lib/instana/tracing/span.rb', line 262

def operation_name=(name)
  @data[:n] = name
end

#parent_id ⇒ Integer

Retrieve the parent ID of this span

Returns:

  • (Integer) —

    parent span ID



170
171
172
 
# File 'lib/instana/tracing/span.rb', line 170

def parent_id
  @data[:p]
end

#parent_id=(id) ⇒ Integer

Set the parent ID of this span

Returns:

  • (Integer) —

    parent span ID



177
178
179
 
# File 'lib/instana/tracing/span.rb', line 177

def parent_id=(id)
  @data[:p] = id
end

#raw ⇒ Object

Get the raw @data hash that summarizes this span



240
241
242
 
# File 'lib/instana/tracing/span.rb', line 240

def raw
  @data
end

#set_baggage_item(key, value) ⇒ Object

Set a baggage item on the span Spec: OpenTracing API

Parameters:

  • key (String) —

    the key of the baggage item

  • value (String) —

    the value of the baggage item



317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/instana/tracing/span.rb', line 317

def set_baggage_item(key, value)
  @baggage ||= {}
  @baggage[key] = value

  # Init/Update the SpanContext item
  if @context
    @context.baggage = @baggage
  else
    @context ||= ::Instana::SpanContext.new(@data[:t], @data[:s], @baggage)
  end
  self
end

#set_tag(key, value) ⇒ Object

Set a tag value on this span Spec: OpenTracing API

a String, Numeric, or Boolean it will be encoded with to_s

Parameters:

  • key (String) —

    the key of the tag

  • value (String, Numeric, Boolean) —

    the value of the tag. If it’s not



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/instana/tracing/span.rb', line 273

def set_tag(key, value)
  if custom?
    @data[:data][:sdk][:custom] ||= {}
    @data[:data][:sdk][:custom][:tags] ||= {}
    @data[:data][:sdk][:custom][:tags][key] = value

    if key.to_sym == :'span.kind'
      case value.to_sym
      when :server || :consumer
        @data[:data][:sdk][:type] = :entry
      when :client || :producer
        @data[:data][:sdk][:type] = :exit
      end
    end
  else
    if !@data[:data].key?(key)
      @data[:data][key] = value
    elsif value.is_a?(Hash) && self[:data][key].is_a?(Hash)
      @data[:data][key].merge!(value)
    else
      @data[:data][key] = value
    end
  end
  self
end

#set_tags(tags) ⇒ Span

Helper method to add multiple tags to this span

Returns:



304
305
306
307
308
309
310
 
# File 'lib/instana/tracing/span.rb', line 304

def set_tags(tags)
  return unless tags.is_a?(Hash)
  tags.each do |k,v|
    set_tag(k, v)
  end
  self
end

#tags(key = nil) ⇒ Object

Retrieve the hash of tags for this span



342
343
344
345
346
347
348
349
 
# File 'lib/instana/tracing/span.rb', line 342

def tags(key = nil)
  if custom?
    tags = @data[:data][:sdk][:custom][:tags]
  else
    tags = @data[:data][key]
  end
  key ? tags[key] : tags
end

#trace_id ⇒ Integer

Retrieve the Trace ID for this span

Returns:

  • (Integer) —

    the Trace ID



163
164
165
 
# File 'lib/instana/tracing/span.rb', line 163

def trace_id
  @data[:t]
end