Class: Sentry::Span

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

Direct Known Subclasses

Transaction

Defined Under Namespace

Modules: DataConventions

Constant Summary collapse

STATUS_MAP = 
{
  400 => "invalid_argument",
  401 => "unauthenticated",
  403 => "permission_denied",
  404 => "not_found",
  409 => "already_exists",
  429 => "resource_exhausted",
  499 => "cancelled",
  500 => "internal_error",
  501 => "unimplemented",
  503 => "unavailable",
  504 => "deadline_exceeded"
}
DEFAULT_SPAN_ORIGIN = 
"manual"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transaction:, description: nil, op: nil, status: nil, trace_id: nil, span_id: nil, parent_span_id: nil, sampled: nil, start_timestamp: nil, timestamp: nil, origin: nil) ⇒ Span

Returns a new instance of Span.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/sentry/span.rb', line 112

def initialize(
  transaction:,
  description: nil,
  op: nil,
  status: nil,
  trace_id: nil,
  span_id: nil,
  parent_span_id: nil,
  sampled: nil,
  start_timestamp: nil,
  timestamp: nil,
  origin: nil
)
  @trace_id = trace_id || SecureRandom.uuid.delete("-")
  @span_id = span_id || SecureRandom.uuid.delete("-").slice(0, 16)
  @parent_span_id = parent_span_id
  @sampled = sampled
  @start_timestamp = start_timestamp || Sentry.utc_now.to_f
  @timestamp = timestamp
  @description = description
  @transaction = transaction
  @op = op
  @status = status
  @data = {}
  @tags = {}
  @origin = origin || DEFAULT_SPAN_ORIGIN
end

Instance Attribute Details

#data ⇒ Hash (readonly)

Span data

Returns:

  • (Hash) 


97
98
99
 
# File 'lib/sentry/span.rb', line 97

def data
  @data
end

#description ⇒ String (readonly)

Span description

Returns:

  • (String) 


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

def description
  @description
end

#op ⇒ String (readonly)

Span operation

Returns:

  • (String) 


88
89
90
 
# File 'lib/sentry/span.rb', line 88

def op
  @op
end

#origin ⇒ String (readonly)

Span origin that tracks what kind of instrumentation created a span

Returns:

  • (String) 


100
101
102
 
# File 'lib/sentry/span.rb', line 100

def origin
  @origin
end

#parent_span_id ⇒ String (readonly)

Span parent’s span_id.

Returns:

  • (String) 


73
74
75
 
# File 'lib/sentry/span.rb', line 73

def parent_span_id
  @parent_span_id
end

#sampled ⇒ Boolean? (readonly)

Sampling result of the span.

Returns:

  • (Boolean, nil) 


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

def sampled
  @sampled
end

#span_id ⇒ String (readonly)

An uuid that can be used to identify the span.

Returns:

  • (String) 


70
71
72
 
# File 'lib/sentry/span.rb', line 70

def span_id
  @span_id
end

#span_recorder ⇒ SpanRecorder

The SpanRecorder the current span belongs to. SpanRecorder holds all spans under the same Transaction object (including the Transaction itself).

Returns:

  • (SpanRecorder) 


105
106
107
 
# File 'lib/sentry/span.rb', line 105

def span_recorder
  @span_recorder
end

#start_timestamp ⇒ Float (readonly)

Starting timestamp of the span.

Returns:

  • (Float) 


79
80
81
 
# File 'lib/sentry/span.rb', line 79

def start_timestamp
  @start_timestamp
end

#status ⇒ String (readonly)

Span status

Returns:

  • (String) 


91
92
93
 
# File 'lib/sentry/span.rb', line 91

def status
  @status
end

#tags ⇒ Hash (readonly)

Span tags

Returns:

  • (Hash) 


94
95
96
 
# File 'lib/sentry/span.rb', line 94

def tags
  @tags
end

#timestamp ⇒ Float (readonly)

Finishing timestamp of the span.

Returns:

  • (Float) 


82
83
84
 
# File 'lib/sentry/span.rb', line 82

def timestamp
  @timestamp
end

#trace_id ⇒ String (readonly)

An uuid that can be used to identify a trace.

Returns:

  • (String) 


67
68
69
 
# File 'lib/sentry/span.rb', line 67

def trace_id
  @trace_id
end

#transaction ⇒ Transaction (readonly)

The Transaction object the Span belongs to. Every span needs to be attached to a Transaction and their child spans will also inherit the same transaction.

Returns:



110
111
112
 
# File 'lib/sentry/span.rb', line 110

def transaction
  @transaction
end

Instance Method Details

#deep_dup ⇒ Object 



234
235
236
 
# File 'lib/sentry/span.rb', line 234

def deep_dup
  dup
end

#finish(end_timestamp: nil) ⇒ self

Finishes the span by adding a timestamp.

Returns:

  • (self) 


142
143
144
145
 
# File 'lib/sentry/span.rb', line 142

def finish(end_timestamp: nil)
  @timestamp = end_timestamp || @timestamp || Sentry.utc_now.to_f
  self
end

#get_trace_context ⇒ Hash

Returns the span’s context that can be used to embed in an Event.

Returns:

  • (Hash) 


187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/sentry/span.rb', line 187

def get_trace_context
  {
    trace_id: @trace_id,
    span_id: @span_id,
    parent_span_id: @parent_span_id,
    description: @description,
    op: @op,
    status: @status,
    origin: @origin
  }
end

#metrics_local_aggregator ⇒ Object

Collects gauge metrics on the span for metric summaries.



299
300
301
 
# File 'lib/sentry/span.rb', line 299

def metrics_local_aggregator
  @metrics_local_aggregator ||= Sentry::Metrics::LocalAggregator.new
end

#metrics_summary ⇒ Object 



303
304
305
 
# File 'lib/sentry/span.rb', line 303

def metrics_summary
  @metrics_local_aggregator&.to_hash
end

#set_data(key, value) ⇒ Object

Inserts a key-value pair to the span’s data payload.

Parameters:

  • key (String, Symbol)
  • value (Object) 


281
282
283
 
# File 'lib/sentry/span.rb', line 281

def set_data(key, value)
  @data[key] = value
end

#set_description(description) ⇒ Object

Sets the span’s description.

Parameters:

  • description (String) —

    description of the span.



246
247
248
 
# File 'lib/sentry/span.rb', line 246

def set_description(description)
  @description = description
end

#set_http_status(status_code) ⇒ Object

Sets the span’s status with given http status code.

Parameters:

  • status_code (String) —

    example: “500”.



265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/sentry/span.rb', line 265

def set_http_status(status_code)
  status_code = status_code.to_i
  set_data(DataConventions::HTTP_STATUS_CODE, status_code)

  status =
    if status_code >= 200 && status_code < 299
      "ok"
    else
      STATUS_MAP[status_code]
    end
  set_status(status)
end

#set_op(op) ⇒ Object

Sets the span’s operation.

Parameters:

  • op (String) —

    operation of the span.



240
241
242
 
# File 'lib/sentry/span.rb', line 240

def set_op(op)
  @op = op
end

#set_origin(origin) ⇒ Object

Sets the origin of the span.

Parameters:

  • origin (String) 


294
295
296
 
# File 'lib/sentry/span.rb', line 294

def set_origin(origin)
  @origin = origin
end

#set_status(status) ⇒ Object

Sets the span’s status.

Parameters:

  • satus (String) —

    status of the span.



253
254
255
 
# File 'lib/sentry/span.rb', line 253

def set_status(status)
  @status = status
end

#set_tag(key, value) ⇒ Object

Sets a tag to the span.

Parameters:

  • key (String, Symbol)
  • value (String) 


288
289
290
 
# File 'lib/sentry/span.rb', line 288

def set_tag(key, value)
  @tags[key] = value
end

#set_timestamp(timestamp) ⇒ Object

Sets the span’s finish timestamp.

Parameters:

  • timestamp (Float) —

    finished time in float format (most precise).



259
260
261
 
# File 'lib/sentry/span.rb', line 259

def set_timestamp(timestamp)
  @timestamp = timestamp
end

#start_child(**attributes) ⇒ Object

Starts a child span with given attributes.

Parameters:

  • attributes (Hash) —

    the attributes for the child span.



201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/sentry/span.rb', line 201

def start_child(**attributes)
  attributes = attributes.dup.merge(transaction: @transaction, trace_id: @trace_id, parent_span_id: @span_id, sampled: @sampled)
  new_span = Span.new(**attributes)
  new_span.span_recorder = span_recorder

  if span_recorder
    span_recorder.add(new_span)
  end

  new_span
end

#to_baggage ⇒ String?

Generates a W3C Baggage header string for distributed tracing from the incoming baggage stored on the transaction.

Returns:

  • (String, nil) 


159
160
161
 
# File 'lib/sentry/span.rb', line 159

def to_baggage
  transaction.get_baggage&.serialize
end

#to_hash ⇒ Hash

Returns:

  • (Hash) 


164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/sentry/span.rb', line 164

def to_hash
  hash = {
    trace_id: @trace_id,
    span_id: @span_id,
    parent_span_id: @parent_span_id,
    start_timestamp: @start_timestamp,
    timestamp: @timestamp,
    description: @description,
    op: @op,
    status: @status,
    tags: @tags,
    data: @data,
    origin: @origin
  }

  summary = metrics_summary
  hash[:_metrics_summary] = summary if summary

  hash
end

#to_sentry_trace ⇒ String

Generates a trace string that can be used to connect other transactions.

Returns:

  • (String) 


149
150
151
152
153
154
 
# File 'lib/sentry/span.rb', line 149

def to_sentry_trace
  sampled_flag = ""
  sampled_flag = @sampled ? 1 : 0 unless @sampled.nil?

  "#{@trace_id}-#{@span_id}-#{sampled_flag}"
end

#with_child_span(**attributes, &block) {|child_span| ... } ⇒ Object

Starts a child span, yield it to the given block, and then finish the span after the block is executed.

Examples:

span.with_child_span do |child_span|
  # things happen here will be recorded in a child span
end

Parameters:

  • attributes (Hash) —

    the attributes for the child span.

  • block (Proc) —

    the action to be recorded in the child span.

Yield Parameters:



222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/sentry/span.rb', line 222

def with_child_span(**attributes, &block)
  child_span = start_child(**attributes)

  yield(child_span)

  child_span.finish
rescue
  child_span.set_http_status(500)
  child_span.finish
  raise
end