Class: OpenCensus::Trace::Span

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

Overview

Span represents a span in a trace record. Spans are contained in a trace and arranged in a forest. That is, each span may be a root span or have a parent span, and may have zero or more children.

Constant Summary collapse

SPAN_KIND_UNSPECIFIED =

A span kind, indicating the span kind is unspecified.

Returns:

  • (Symbol) 
:SPAN_KIND_UNSPECIFIED
SERVER =

A span kind, indicating that the span covers server-side handling of an RPC or other remote network request.

Returns:

  • (Symbol) 
:SERVER
CLIENT =

A span kind, indicating that the span covers the client-side wrapper around an RPC or other remote request.

Returns:

  • (Symbol) 
:CLIENT

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ Hash<String, (TruncatableString, Integer, Float, Boolean)> (readonly)

The properties of this span.

Returns:



106
107
108
 
# File 'lib/opencensus/trace/span.rb', line 106

def attributes
  @attributes
end

#child_span_count ⇒ Integer? (readonly)

An optional number of child spans that were generated while this span was active. If set, allows an implementation to detect missing child spans.

Returns:

  • (Integer, nil) 


202
203
204
 
# File 'lib/opencensus/trace/span.rb', line 202

def child_span_count
  @child_span_count
end

#dropped_annotations_count ⇒ Integer (readonly)

The number of dropped annotations in all the included time events. If the value is 0, then no annotations were dropped.

Returns:

  • (Integer) 


154
155
156
 
# File 'lib/opencensus/trace/span.rb', line 154

def dropped_annotations_count
  @dropped_annotations_count
end

#dropped_attributes_count ⇒ Integer (readonly)

The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0, then no attributes were dropped.

Returns:

  • (Integer) 


115
116
117
 
# File 'lib/opencensus/trace/span.rb', line 115

def dropped_attributes_count
  @dropped_attributes_count
end

#dropped_frames_count ⇒ Integer (readonly)

The number of stack frames that were dropped because there were too many stack frames. If this value is 0, then no stack frames were dropped.

Returns:

  • (Integer) 


139
140
141
 
# File 'lib/opencensus/trace/span.rb', line 139

def dropped_frames_count
  @dropped_frames_count
end

#dropped_links_count ⇒ Integer (readonly)

The number of dropped links after the maximum size was enforced If the value is 0, then no links were dropped.

Returns:

  • (Integer) 


177
178
179
 
# File 'lib/opencensus/trace/span.rb', line 177

def dropped_links_count
  @dropped_links_count
end

#dropped_message_events_count ⇒ Integer (readonly)

The number of dropped message events in all the included time events. If the value is 0, then no message events were dropped.

Returns:

  • (Integer) 


162
163
164
 
# File 'lib/opencensus/trace/span.rb', line 162

def dropped_message_events_count
  @dropped_message_events_count
end

#end_time ⇒ Time (readonly)

The ending timestamp of this span in UTC.

Returns:

  • (Time) 


99
100
101
 
# File 'lib/opencensus/trace/span.rb', line 99

def end_time
  @end_time
end

#kind ⇒ Symbol (readonly)

The kind of span. Can be used to specify additional relationships between spans in addition to a parent/child relationship. You should use the kind constants provided by this class.

Returns:

  • (Symbol) 


85
86
87
 
# File 'lib/opencensus/trace/span.rb', line 85

def kind
  @kind
end

#links ⇒ Array<Link> (readonly)

The included links.

Returns:



169
170
171
 
# File 'lib/opencensus/trace/span.rb', line 169

def links
  @links
end

#name ⇒ TruncatableString (readonly)

The name of this span.

Returns:



76
77
78
 
# File 'lib/opencensus/trace/span.rb', line 76

def name
  @name
end

#parent_span_id ⇒ String (readonly)

The span_id of this span's parent span. If this is a root span, then this field must be empty. The ID is an 8-byte value represented as a hexadecimal string.

Returns:

  • (String) 


69
70
71
 
# File 'lib/opencensus/trace/span.rb', line 69

def parent_span_id
  @parent_span_id
end

#same_process_as_parent_span ⇒ boolean? (readonly)

A highly recommended but not required flag that identifies when a trace crosses a process boundary. True when the parent_span belongs to the same process as the current span.

Returns:

  • (boolean, nil) 


193
194
195
 
# File 'lib/opencensus/trace/span.rb', line 193

def same_process_as_parent_span
  @same_process_as_parent_span
end

#span_id ⇒ String (readonly)

A unique identifier for a span within a trace, assigned when the span is created. The ID is an 8-byte value represented as a hexadecimal string.

Returns:

  • (String) 


60
61
62
 
# File 'lib/opencensus/trace/span.rb', line 60

def span_id
  @span_id
end

#stack_trace ⇒ Array<Thread::Backtrace::Location> (readonly)

A stack trace captured at the start of the span.

Returns:

  • (Array<Thread::Backtrace::Location>) 


122
123
124
 
# File 'lib/opencensus/trace/span.rb', line 122

def stack_trace
  @stack_trace
end

#stack_trace_hash_id ⇒ Integer (readonly)

A hash of the stack trace. This may be used by exporters to identify duplicate stack traces transmitted in the same request; only one copy of the actual data needs to be sent.

Returns:

  • (Integer) 


131
132
133
 
# File 'lib/opencensus/trace/span.rb', line 131

def stack_trace_hash_id
  @stack_trace_hash_id
end

#start_time ⇒ Time (readonly)

The starting timestamp of this span in UTC.

Returns:

  • (Time) 


92
93
94
 
# File 'lib/opencensus/trace/span.rb', line 92

def start_time
  @start_time
end

#status ⇒ Status? (readonly)

An optional final status for this span.

Returns:



184
185
186
 
# File 'lib/opencensus/trace/span.rb', line 184

def status
  @status
end

#time_events ⇒ Array<TimeEvent> (readonly)

The included time events.

Returns:



146
147
148
 
# File 'lib/opencensus/trace/span.rb', line 146

def time_events
  @time_events
end

#trace_id ⇒ String (readonly)

A unique identifier for a trace. All spans from the same trace share the same trace_id. The ID is a 16-byte value represented as a hexadecimal string.

Returns:

  • (String) 


51
52
53
 
# File 'lib/opencensus/trace/span.rb', line 51

def trace_id
  @trace_id
end