Class: Zipkin::Span

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(context, operation_name, reporter, start_time: Time.now, tags: {}, references: nil) ⇒ Span

Creates a new Zipkin::Span

Parameters:

  • context (SpanContext) —

    the context of the span

  • operation_name (String) —

    the operation name

  • reporter (#report) —

    the span reporter



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# 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 { |key, value| set_tag(key, value) }
end

Instance Attribute Details

#context ⇒ Object (readonly)

Returns the value of attribute context.



7
8
9
 
# File 'lib/zipkin/span.rb', line 7

def context
  @context
end

#end_time ⇒ Object (readonly)

Returns the value of attribute end_time.



7
8
9
 
# File 'lib/zipkin/span.rb', line 7

def end_time
  @end_time
end

#logs ⇒ Object (readonly)

Returns the value of attribute logs.



7
8
9
 
# File 'lib/zipkin/span.rb', line 7

def logs
  @logs
end

#operation_name ⇒ Object

Returns the value of attribute operation_name.



5
6
7
 
# File 'lib/zipkin/span.rb', line 5

def operation_name
  @operation_name
end

#references ⇒ Object (readonly)

Returns the value of attribute references.



7
8
9
 
# File 'lib/zipkin/span.rb', line 7

def references
  @references
end

#start_time ⇒ Object (readonly)

Returns the value of attribute start_time.



7
8
9
 
# File 'lib/zipkin/span.rb', line 7

def start_time
  @start_time
end

#tags ⇒ Object (readonly)

Returns the value of attribute tags.



7
8
9
 
# File 'lib/zipkin/span.rb', line 7

def tags
  @tags
end

Instance Method Details

#finish(end_time: Time.now) ⇒ Object

Finish the Zipkin::Span

Parameters:

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

    custom end time, if not now



82
83
84
85
 
# 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) ⇒ Object

Get a baggage item

Parameters:

  • key (String) —

    the key of the baggage item

Returns:

  • Value of the baggage item



58
59
60
 
# File 'lib/zipkin/span.rb', line 58

def get_baggage_item(key)
  nil
end

#log(*args) ⇒ Object

Deprecated.

Use #log_kv instead.

Add a log entry to this span



65
66
67
68
 
# 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) ⇒ Object

Add a log entry to this span

Parameters:

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

    time of the log

  • fields (Hash) —

    Additional information to log



74
75
76
77
 
# 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) ⇒ Object

Set a baggage item on the span

Parameters:

  • key (String) —

    the key of the baggage item

  • value (String) —

    the value of the baggage item



49
50
51
 
# File 'lib/zipkin/span.rb', line 49

def set_baggage_item(key, value)
  self
end

#set_tag(key, value) ⇒ Object

Set a tag value on this span

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



40
41
42
43
 
# 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