Class: Google::Apis::PrivatecaV1beta1::GoogleApiServicecontrolV1TraceSpan
- Inherits:
-
Object
- Object
- Google::Apis::PrivatecaV1beta1::GoogleApiServicecontrolV1TraceSpan
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/privateca_v1beta1/classes.rb,
lib/google/apis/privateca_v1beta1/representations.rb,
lib/google/apis/privateca_v1beta1/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::PrivatecaV1beta1::GoogleApiServicecontrolV1Attributes
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::PrivatecaV1beta1::GoogleApiServicecontrolV1TruncatableString
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::PrivatecaV1beta1::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) ⇒ GoogleApiServicecontrolV1TraceSpan
constructor
A new instance of GoogleApiServicecontrolV1TraceSpan.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleApiServicecontrolV1TraceSpan
Returns a new instance of GoogleApiServicecontrolV1TraceSpan.
2078 2079 2080 |
# File 'lib/google/apis/privateca_v1beta1/classes.rb', line 2078 def initialize(**args) update!(**args) end |
Instance Attribute Details
#attributes ⇒ Google::Apis::PrivatecaV1beta1::GoogleApiServicecontrolV1Attributes
A set of attributes, each in the format [KEY]:[VALUE]
.
Corresponds to the JSON property attributes
2006 2007 2008 |
# File 'lib/google/apis/privateca_v1beta1/classes.rb', line 2006 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
2012 2013 2014 |
# File 'lib/google/apis/privateca_v1beta1/classes.rb', line 2012 def child_span_count @child_span_count end |
#display_name ⇒ Google::Apis::PrivatecaV1beta1::GoogleApiServicecontrolV1TruncatableString
Represents a string that might be shortened to a specified length.
Corresponds to the JSON property displayName
2017 2018 2019 |
# File 'lib/google/apis/privateca_v1beta1/classes.rb', line 2017 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
2024 2025 2026 |
# File 'lib/google/apis/privateca_v1beta1/classes.rb', line 2024 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
2033 2034 2035 |
# File 'lib/google/apis/privateca_v1beta1/classes.rb', line 2033 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
2039 2040 2041 |
# File 'lib/google/apis/privateca_v1beta1/classes.rb', line 2039 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
2046 2047 2048 |
# File 'lib/google/apis/privateca_v1beta1/classes.rb', line 2046 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
2052 2053 2054 |
# File 'lib/google/apis/privateca_v1beta1/classes.rb', line 2052 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
2059 2060 2061 |
# File 'lib/google/apis/privateca_v1beta1/classes.rb', line 2059 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
2066 2067 2068 |
# File 'lib/google/apis/privateca_v1beta1/classes.rb', line 2066 def start_time @start_time end |
#status ⇒ Google::Apis::PrivatecaV1beta1::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
2076 2077 2078 |
# File 'lib/google/apis/privateca_v1beta1/classes.rb', line 2076 def status @status end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 |
# File 'lib/google/apis/privateca_v1beta1/classes.rb', line 2083 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 |