class OpenTracing::Span

Span represents an OpenTracing Span

See www.opentracing.io for more information.

Constants

NOOP_INSTANCE

Public Instance Methods

context() click to toggle source

Span Context

@return [SpanContext]

# File lib/opentracing/span.rb, line 16
def context
  SpanContext::NOOP_INSTANCE
end
finish(end_time: Time.now) click to toggle source

Finish the {Span} @param end_time [Time] custom end time, if not now

# File lib/opentracing/span.rb, line 64
def finish(end_time: Time.now)
  nil
end
get_baggage_item(key) click to toggle source

Get a baggage item @param key [String] the key of the baggage item @return [String] value of the baggage item

# File lib/opentracing/span.rb, line 38
def get_baggage_item(key)
  nil
end
log(event: nil, timestamp: Time.now, **fields) click to toggle source

@deprecated Use {#log_kv} instead. Reason: event is an optional standard log field defined in spec and not required. Also, method name {#log_kv} is more consistent with other language implementations such as Python and Go.

Add a log entry to this span @param event [String] event name for the log @param timestamp [Time] time of the log @param fields [Hash{Symbol=>Object}] Additional information to log

# File lib/opentracing/span.rb, line 50
def log(event: nil, timestamp: Time.now, **fields)
  warn 'Span#log is deprecated.  Please use Span#log_kv instead.'
  nil
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{Symbol=>Object}] Additional information to log

# File lib/opentracing/span.rb, line 58
def log_kv(timestamp: Time.now, **fields)
  nil
end
operation_name=(name) click to toggle source

Set the name of the operation

@param [String] name

# File lib/opentracing/span.rb, line 11
def operation_name=(name); 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/opentracing/span.rb, line 31
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/opentracing/span.rb, line 24
def set_tag(key, value)
  self
end