class Zipkin::Span

Attributes

context[R]
end_time[R]
logs[R]
operation_name[RW]
references[R]
start_time[R]
tags[R]

Public Class Methods

new( context, operation_name, reporter, start_time: Time.now, tags: {}, references: nil ) click to toggle source

Creates a new {Span}

@param context [SpanContext] the context of the span @param operation_name [String] the operation name @param reporter [#report] the span reporter

@return [Span] a new Span

# File lib/zipkin/span.rb, line 16
def initialize(
  context,
  operation_name,
  reporter,
  start_time: Time.now,
  tags: {},
  references: nil
)
  @context = context
  @operation_name = operation_name
  @reporter = reporter
  @start_time = start_time
  @tags = {}
  @logs = []
  @references = references

  tags.each(&method(:set_tag))
end

Public Instance Methods

finish(end_time: Time.now) click to toggle source

Finish the {Span}

@param end_time [Time] custom end time, if not now

# File lib/zipkin/span.rb, line 82
def finish(end_time: Time.now)
  @end_time = end_time
  @reporter.report(self)
end
get_baggage_item(key) click to toggle source

Get a baggage item

@param key [String] the key of the baggage item

@return Value of the baggage item

# File lib/zipkin/span.rb, line 58
def get_baggage_item(key)
  nil
end
log(*args) click to toggle source

Add a log entry to this span

@deprecated Use {#log_kv} instead.

# File lib/zipkin/span.rb, line 65
def log(*args)
  warn 'Span#log is deprecated. Please use Span#log_kv instead.'
  log_kv(*args)
end
log_kv(timestamp: Time.now, **fields) click to toggle source

Add a log entry to this span

@param timestamp [Time] time of the log @param fields [Hash] Additional information to log

# File lib/zipkin/span.rb, line 74
def log_kv(timestamp: Time.now, **fields)
  @logs << fields.merge(timestamp: timestamp)
  nil
end
set_baggage_item(key, value) click to toggle source

Set a baggage item on the span

@param key [String] the key of the baggage item @param value [String] the value of the baggage item

# File lib/zipkin/span.rb, line 49
def set_baggage_item(key, value)
  self
end
set_tag(key, value) click to toggle source

Set a tag value on this span

@param key [String] the key of the tag @param value [String, Numeric, Boolean] the value of the tag. If it's not a String, Numeric, or Boolean it will be encoded with to_s

# File lib/zipkin/span.rb, line 40
def set_tag(key, value)
  sanitized_value = valid_tag_value?(value) ? value : value.to_s
  @tags = @tags.merge(key.to_s => sanitized_value)
end

Private Instance Methods

valid_tag_value?(value) click to toggle source

Zipkin supports only strings and numbers

# File lib/zipkin/span.rb, line 90
def valid_tag_value?(value)
  value.is_a?(String) || value.is_a?(Numeric)
end