Class: Google::Apis::ServicecontrolV1::TraceSpan
- Inherits:
-
Object
- Object
- Google::Apis::ServicecontrolV1::TraceSpan
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/servicecontrol_v1/classes.rb,
generated/google/apis/servicecontrol_v1/representations.rb,
generated/google/apis/servicecontrol_v1/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
-
#attributes ⇒ Google::Apis::ServicecontrolV1::Attributes
A set of attributes, each in the format
[KEY]:[VALUE]
. -
#child_span_count ⇒ Fixnum
An optional number of child spans that were generated while this span was active.
-
#display_name ⇒ Google::Apis::ServicecontrolV1::TruncatableString
Represents a string that might be shortened to a specified length.
-
#end_time ⇒ String
The end time of the span.
-
#name ⇒ String
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.
-
#parent_span_id ⇒ String
The [SPAN_ID] of this span's parent span.
-
#same_process_as_parent_span ⇒ Boolean
(also: #same_process_as_parent_span?)
(Optional) Set this parameter to indicate whether this span is in the same process as its parent.
-
#span_id ⇒ String
The [SPAN_ID] portion of the span's resource name.
-
#span_kind ⇒ String
Distinguishes between spans generated in a particular context.
-
#start_time ⇒ String
The start time of the span.
-
#status ⇒ Google::Apis::ServicecontrolV1::Status
The
Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
Instance Method Summary collapse
-
#initialize(**args) ⇒ TraceSpan
constructor
A new instance of TraceSpan.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ TraceSpan
Returns a new instance of TraceSpan.
2444 2445 2446 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 2444 def initialize(**args) update!(**args) end |
Instance Attribute Details
#attributes ⇒ Google::Apis::ServicecontrolV1::Attributes
A set of attributes, each in the format [KEY]:[VALUE]
.
Corresponds to the JSON property attributes
2370 2371 2372 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 2370 def attributes @attributes end |
#child_span_count ⇒ Fixnum
An optional 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
2376 2377 2378 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 2376 def child_span_count @child_span_count end |
#display_name ⇒ Google::Apis::ServicecontrolV1::TruncatableString
Represents a string that might be shortened to a specified length.
Corresponds to the JSON property displayName
2381 2382 2383 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 2381 def display_name @display_name end |
#end_time ⇒ String
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
2388 2389 2390 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 2388 def end_time @end_time end |
#name ⇒ String
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
2398 2399 2400 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 2398 def name @name end |
#parent_span_id ⇒ String
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
2404 2405 2406 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 2404 def parent_span_id @parent_span_id end |
#same_process_as_parent_span ⇒ Boolean 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
2412 2413 2414 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 2412 def same_process_as_parent_span @same_process_as_parent_span end |
#span_id ⇒ String
The [SPAN_ID] portion of the span's resource name.
Corresponds to the JSON property spanId
2418 2419 2420 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 2418 def span_id @span_id end |
#span_kind ⇒ String
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
2425 2426 2427 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 2425 def span_kind @span_kind end |
#start_time ⇒ String
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
2432 2433 2434 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 2432 def start_time @start_time end |
#status ⇒ Google::Apis::ServicecontrolV1::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
2442 2443 2444 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 2442 def status @status end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 2449 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) @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) @start_time = args[:start_time] if args.key?(:start_time) @status = args[:status] if args.key?(:status) end |