Class: Google::Apis::CloudtraceV2::Span

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudtrace_v2/classes.rb,
generated/google/apis/cloudtrace_v2/representations.rb,
generated/google/apis/cloudtrace_v2/representations.rb

Overview

A span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency, and one or more subspans for its sub-operations. A trace can also contain multiple root spans, or none at all. Spans do not need to be contiguous—there may be gaps or overlaps between spans in a trace.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Span

Returns a new instance of Span.



392
393
394
# File 'generated/google/apis/cloudtrace_v2/classes.rb', line 392

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#attributesGoogle::Apis::CloudtraceV2::Attributes

A set of attributes, each in the format [KEY]:[VALUE]. Corresponds to the JSON property attributes



298
299
300
# File 'generated/google/apis/cloudtrace_v2/classes.rb', line 298

def attributes
  @attributes
end

#child_span_countFixnum

Optional. The number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans. Corresponds to the JSON property childSpanCount

Returns:

  • (Fixnum)


304
305
306
# File 'generated/google/apis/cloudtrace_v2/classes.rb', line 304

def child_span_count
  @child_span_count
end

#display_nameGoogle::Apis::CloudtraceV2::TruncatableString

Represents a string that might be shortened to a specified length. Corresponds to the JSON property displayName



309
310
311
# File 'generated/google/apis/cloudtrace_v2/classes.rb', line 309

def display_name
  @display_name
end

#end_timeString

Required. The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running. Corresponds to the JSON property endTime

Returns:

  • (String)


317
318
319
# File 'generated/google/apis/cloudtrace_v2/classes.rb', line 317

def end_time
  @end_time
end

A collection of links, which are references from this span to a span in the same or different trace. Corresponds to the JSON property links



323
324
325
# File 'generated/google/apis/cloudtrace_v2/classes.rb', line 323

def links
  @links
end

#nameString

The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. Corresponds to the JSON property name

Returns:

  • (String)


333
334
335
# File 'generated/google/apis/cloudtrace_v2/classes.rb', line 333

def name
  @name
end

#parent_span_idString

The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty. Corresponds to the JSON property parentSpanId

Returns:

  • (String)


339
340
341
# File 'generated/google/apis/cloudtrace_v2/classes.rb', line 339

def parent_span_id
  @parent_span_id
end

#same_process_as_parent_spanBoolean Also known as: same_process_as_parent_span?

Optional. Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Stackdriver Trace is unable to take advantage of this helpful information. Corresponds to the JSON property sameProcessAsParentSpan

Returns:

  • (Boolean)


347
348
349
# File 'generated/google/apis/cloudtrace_v2/classes.rb', line 347

def same_process_as_parent_span
  @same_process_as_parent_span
end

#span_idString

Required. The [SPAN_ID] portion of the span's resource name. Corresponds to the JSON property spanId

Returns:

  • (String)


353
354
355
# File 'generated/google/apis/cloudtrace_v2/classes.rb', line 353

def span_id
  @span_id
end

#span_kindString

Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using CLIENT (caller) and SERVER (callee) to identify an RPC call. Corresponds to the JSON property spanKind

Returns:

  • (String)


360
361
362
# File 'generated/google/apis/cloudtrace_v2/classes.rb', line 360

def span_kind
  @span_kind
end

#stack_traceGoogle::Apis::CloudtraceV2::StackTrace

A call stack appearing in a trace. Corresponds to the JSON property stackTrace



365
366
367
# File 'generated/google/apis/cloudtrace_v2/classes.rb', line 365

def stack_trace
  @stack_trace
end

#start_timeString

Required. The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running. Corresponds to the JSON property startTime

Returns:

  • (String)


373
374
375
# File 'generated/google/apis/cloudtrace_v2/classes.rb', line 373

def start_time
  @start_time
end

#statusGoogle::Apis::CloudtraceV2::Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property status



383
384
385
# File 'generated/google/apis/cloudtrace_v2/classes.rb', line 383

def status
  @status
end

#time_eventsGoogle::Apis::CloudtraceV2::TimeEvents

A collection of TimeEvents. A TimeEvent is a time-stamped annotation on the span, consisting of either user-supplied key:value pairs, or details of a message sent/received between Spans. Corresponds to the JSON property timeEvents



390
391
392
# File 'generated/google/apis/cloudtrace_v2/classes.rb', line 390

def time_events
  @time_events
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
# File 'generated/google/apis/cloudtrace_v2/classes.rb', line 397

def update!(**args)
  @attributes = args[:attributes] if args.key?(:attributes)
  @child_span_count = args[:child_span_count] if args.key?(:child_span_count)
  @display_name = args[:display_name] if args.key?(:display_name)
  @end_time = args[:end_time] if args.key?(:end_time)
  @links = args[:links] if args.key?(:links)
  @name = args[:name] if args.key?(:name)
  @parent_span_id = args[:parent_span_id] if args.key?(:parent_span_id)
  @same_process_as_parent_span = args[:same_process_as_parent_span] if args.key?(:same_process_as_parent_span)
  @span_id = args[:span_id] if args.key?(:span_id)
  @span_kind = args[:span_kind] if args.key?(:span_kind)
  @stack_trace = args[:stack_trace] if args.key?(:stack_trace)
  @start_time = args[:start_time] if args.key?(:start_time)
  @status = args[:status] if args.key?(:status)
  @time_events = args[:time_events] if args.key?(:time_events)
end