Class: OpenTracing::Reference

Inherits:

Object

• Object
• OpenTracing::Reference

Defined in:

lib/opentracing/reference.rb

Overview

:nodoc:

Constant Summary

CHILD_OF =

'child_of'.freeze

FOLLOWS_FROM =

'follows_from'.freeze

Instance Attribute Summary

• #context ⇒ SpanContext readonly

  The context of a span this reference is referencing.

• #type ⇒ String readonly

  Reference type.

Class Method Summary

• .child_of(context) ⇒ Reference

  A ChildOf reference.

• .follows_from(context) ⇒ Reference

  A FollowsFrom reference.

Instance Method Summary

• #initialize(type, context) ⇒ Reference constructor

  A new instance of Reference.

Constructor Details

#initialize(type, context) ⇒ Reference

# File 'lib/opentracing/reference.rb', line 68

def initialize(type, context)
  @type = type
  @context = context
end

Instance Attribute Details

#context ⇒ SpanContext (readonly)

# File 'lib/opentracing/reference.rb', line 77

def context
  @context
end

#type ⇒ String (readonly)

# File 'lib/opentracing/reference.rb', line 74

def type
  @type
end

Class Method Details

.child_of(context) ⇒ Reference

Returns a ChildOf reference.

Examples:

root_span = OpenTracing.start_span('root operation')
child_span = OpenTracing.start_span('child operation', references: [
  OpenTracing::Reference.child_of(root_span)
])

# File 'lib/opentracing/reference.rb', line 27

def self.child_of(context)
  context = context.context if context.is_a?(Span)
  Reference.new(CHILD_OF, context)
end

.follows_from(context) ⇒ Reference

Returns a FollowsFrom reference.

Examples:

context = OpenTracing.extract(OpenTracing::FORMAT_RACK, rack_env)
span = OpenTracing.start_span('following operation', references: [
  OpenTracing::Reference.follows_from(context)
])

# File 'lib/opentracing/reference.rb', line 63

def self.follows_from(context)
  context = context.context if context.is_a?(Span)
  Reference.new(FOLLOWS_FROM, context)
end