Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c482712935d1c1331e33bd7f9968bd3b2be223bb / . / docs / dyn / cloudtrace_v2.projects.traces.spans.html
blob: 445a6109045ebed12ce5616b512ffb073e89a782 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]75<h1><a href="cloudtrace_v2.html">Cloud Trace API</a> . <a href="cloudtrace_v2.projects.html">projects</a> . <a href="cloudtrace_v2.projects.traces.html">traces</a> . <a href="cloudtrace_v2.projects.traces.spans.html">spans</a></h1>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#createSpan">createSpan(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Creates a new span.</p>
80<h3>Method Details</h3>
81<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]82 <code class="details" id="createSpan">createSpan(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83 <pre>Creates a new span.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]84In this case, writing traces is not considered an active developer
85method since traces are machine generated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86
87Args:
88 name: string, The resource name of the span in the following format:
89
90 projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project;
91it is a 32-character hexadecimal encoding of a 16-byte array.
92
93[SPAN_ID] is a unique identifier for a span within a trace; it
94is a 16-character hexadecimal encoding of an 8-byte array. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]95 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]96 The object takes the form of:
97
98{ # A span represents a single operation within a trace. Spans can be
99 # nested to form a trace tree. Often, a trace contains a root span
100 # that describes the end-to-end latency, and one or more subspans for
101 # its sub-operations. A trace can also contain multiple root spans,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]102 # or none at all. Spans do not need to be contiguous&amp;mdash;there may be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103 # gaps or overlaps between spans in a trace.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]104 &quot;childSpanCount&quot;: 42, # Optional. The number of child spans that were generated while this span
105 # was active. If set, allows implementation to detect missing child spans.
106 &quot;sameProcessAsParentSpan&quot;: True or False, # Optional. Set this parameter to indicate whether this span is in
107 # the same process as its parent. If you do not set this parameter,
108 # Stackdriver Trace is unable to take advantage of this helpful
109 # information.
110 &quot;status&quot;: { # The `Status` type defines a logical error model that is suitable for # Optional. The final status for this span.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]111 # different programming environments, including REST APIs and RPC APIs. It is
112 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
113 # three pieces of data: error code, error message, and error details.
114 #
115 # You can find out more about this error model and how to work with it in the
116 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]117 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]118 # user-facing error message should be localized and sent in the
119 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]120 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121 # message types for APIs to use.
122 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 },
125 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]126 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]128 &quot;name&quot;: &quot;A String&quot;, # The resource name of the span in the following format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]129 #
130 # projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project;
131 # it is a 32-character hexadecimal encoding of a 16-byte array.
132 #
133 # [SPAN_ID] is a unique identifier for a span within a trace; it
134 # is a 16-character hexadecimal encoding of an 8-byte array.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]135 &quot;stackTrace&quot;: { # A call stack appearing in a trace. # Stack trace captured at the start of the span.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]136 &quot;stackFrames&quot;: { # A collection of stack frames, which can be truncated. # Stack frames in this stack trace. A maximum of 128 frames are allowed.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]137 &quot;frame&quot;: [ # Stack frames in this call stack.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]138 { # Represents a single stack frame in a stack trace.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]139 &quot;lineNumber&quot;: &quot;A String&quot;, # The line number in `file_name` where the function call appears.
140 &quot;loadModule&quot;: { # Binary module. # The binary module from where the code was loaded.
141 &quot;module&quot;: { # Represents a string that might be shortened to a specified length. # For example: main binary, kernel modules, and dynamic libraries
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]142 # such as libc.so, sharedlib.so (up to 256 bytes).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]143 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
144 # value is 0, then the string was not shortened.
145 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146 # bytes long and the limit of the string is 128 bytes, then
147 # `value` contains the first 128 bytes of the 500-byte string.
148 #
149 # Truncation always happens on a UTF8 character boundary. If there
150 # are multi-byte characters in the string, then the length of the
151 # shortened string might be less than the size limit.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]152 },
153 &quot;buildId&quot;: { # Represents a string that might be shortened to a specified length. # A unique identifier for the module, usually a hash of its
154 # contents (up to 128 bytes).
155 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156 # value is 0, then the string was not shortened.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]157 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
158 # bytes long and the limit of the string is 128 bytes, then
159 # `value` contains the first 128 bytes of the 500-byte string.
160 #
161 # Truncation always happens on a UTF8 character boundary. If there
162 # are multi-byte characters in the string, then the length of the
163 # shortened string might be less than the size limit.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 },
165 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]166 &quot;columnNumber&quot;: &quot;A String&quot;, # The column number where the function call appears, if available.
167 # This is important in JavaScript because of its anonymous functions.
168 &quot;fileName&quot;: { # Represents a string that might be shortened to a specified length. # The name of the source file where the function call appears (up to 256
169 # bytes).
170 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
171 # value is 0, then the string was not shortened.
172 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
173 # bytes long and the limit of the string is 128 bytes, then
174 # `value` contains the first 128 bytes of the 500-byte string.
175 #
176 # Truncation always happens on a UTF8 character boundary. If there
177 # are multi-byte characters in the string, then the length of the
178 # shortened string might be less than the size limit.
179 },
180 &quot;sourceVersion&quot;: { # Represents a string that might be shortened to a specified length. # The version of the deployed source code (up to 128 bytes).
181 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
182 # value is 0, then the string was not shortened.
183 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
184 # bytes long and the limit of the string is 128 bytes, then
185 # `value` contains the first 128 bytes of the 500-byte string.
186 #
187 # Truncation always happens on a UTF8 character boundary. If there
188 # are multi-byte characters in the string, then the length of the
189 # shortened string might be less than the size limit.
190 },
191 &quot;originalFunctionName&quot;: { # Represents a string that might be shortened to a specified length. # An un-mangled function name, if `function_name` is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]192 # [mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can
193 # be fully-qualified (up to 1024 bytes).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]194 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
195 # value is 0, then the string was not shortened.
196 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]197 # bytes long and the limit of the string is 128 bytes, then
198 # `value` contains the first 128 bytes of the 500-byte string.
199 #
200 # Truncation always happens on a UTF8 character boundary. If there
201 # are multi-byte characters in the string, then the length of the
202 # shortened string might be less than the size limit.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]203 },
204 &quot;functionName&quot;: { # Represents a string that might be shortened to a specified length. # The fully-qualified name that uniquely identifies the function or
205 # method that is active in this frame (up to 1024 bytes).
206 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]207 # value is 0, then the string was not shortened.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]208 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
209 # bytes long and the limit of the string is 128 bytes, then
210 # `value` contains the first 128 bytes of the 500-byte string.
211 #
212 # Truncation always happens on a UTF8 character boundary. If there
213 # are multi-byte characters in the string, then the length of the
214 # shortened string might be less than the size limit.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]215 },
216 },
217 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]218 &quot;droppedFramesCount&quot;: 42, # The number of stack frames that were dropped because there
219 # were too many stack frames.
220 # If this value is 0, then no stack frames were dropped.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]221 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]222 &quot;stackTraceHashId&quot;: &quot;A String&quot;, # The hash ID is used to conserve network bandwidth for duplicate
223 # stack traces within a single trace.
224 #
225 # Often multiple spans will have identical stack traces.
226 # The first occurrence of a stack trace should contain both the
227 # `stackFrame` content and a value in `stackTraceHashId`.
228 #
229 # Subsequent spans within the same request can refer
230 # to that stack trace by only setting `stackTraceHashId`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]231 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]232 &quot;parentSpanId&quot;: &quot;A String&quot;, # The [SPAN_ID] of this span&#x27;s parent span. If this is a root span,
233 # then this field must be empty.
234 &quot;endTime&quot;: &quot;A String&quot;, # Required. The end time of the span. On the client side, this is the time kept by
235 # the local machine where the span execution ends. On the server side, this
236 # is the time when the server application handler stops running.
237 &quot;spanKind&quot;: &quot;A String&quot;, # Distinguishes between spans generated in a particular context. For example,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]238 # two spans with the same name may be distinguished using `CLIENT` (caller)
239 # and `SERVER` (callee) to identify an RPC call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]240 &quot;startTime&quot;: &quot;A String&quot;, # Required. The start time of the span. On the client side, this is the time kept by
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]241 # the local machine where the span execution starts. On the server side, this
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]242 # is the time when the server&#x27;s application handler starts running.
243 &quot;displayName&quot;: { # Represents a string that might be shortened to a specified length. # Required. A description of the span&#x27;s operation (up to 128 bytes).
244 # Stackdriver Trace displays the description in the
245 # Google Cloud Platform Console.
246 # For example, the display name can be a qualified method name or a file name
247 # and a line number where the operation is called. A best practice is to use
248 # the same display name within an application and at the same call point.
249 # This makes it easier to correlate spans in different traces.
250 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
251 # value is 0, then the string was not shortened.
252 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
253 # bytes long and the limit of the string is 128 bytes, then
254 # `value` contains the first 128 bytes of the 500-byte string.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]255 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]256 # Truncation always happens on a UTF8 character boundary. If there
257 # are multi-byte characters in the string, then the length of the
258 # shortened string might be less than the size limit.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]259 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]260 &quot;timeEvents&quot;: { # A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation # A set of time events. You can have up to 32 annotations and 128 message
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]261 # events per span.
262 # on the span, consisting of either user-supplied key:value pairs, or
263 # details of a message sent/received between Spans.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]264 &quot;droppedMessageEventsCount&quot;: 42, # The number of dropped message events in all the included time events.
265 # If the value is 0, then no message events were dropped.
266 &quot;timeEvent&quot;: [ # A collection of `TimeEvent`s.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]267 { # A time-stamped annotation or message event in the Span.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]268 &quot;annotation&quot;: { # Text annotation with a set of attributes. # Text annotation with a set of attributes.
269 &quot;description&quot;: { # Represents a string that might be shortened to a specified length. # A user-supplied message describing the event. The maximum length for
270 # the description is 256 bytes.
271 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
272 # value is 0, then the string was not shortened.
273 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
274 # bytes long and the limit of the string is 128 bytes, then
275 # `value` contains the first 128 bytes of the 500-byte string.
276 #
277 # Truncation always happens on a UTF8 character boundary. If there
278 # are multi-byte characters in the string, then the length of the
279 # shortened string might be less than the size limit.
280 },
281 &quot;attributes&quot;: { # A set of attributes, each in the format `[KEY]:[VALUE]`. # A set of attributes on the annotation. You can have up to 4 attributes
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]282 # per Annotation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]283 &quot;droppedAttributesCount&quot;: 42, # The number of attributes that were discarded. Attributes can be discarded
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]284 # because their keys are too long or because there are too many attributes.
285 # If this value is 0 then all attributes are valid.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]286 &quot;attributeMap&quot;: { # The set of attributes. Each attribute&#x27;s key can be up to 128 bytes
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]287 # long. The value can be a string up to 256 bytes, a signed 64-bit integer,
288 # or the Boolean values `true` and `false`. For example:
289 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]290 # &quot;/instance_id&quot;: { &quot;string_value&quot;: { &quot;value&quot;: &quot;my-instance&quot; } }
291 # &quot;/http/request_bytes&quot;: { &quot;int_value&quot;: 300 }
292 # &quot;abc.com/myattribute&quot;: { &quot;bool_value&quot;: false }
293 &quot;a_key&quot;: { # The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.
294 &quot;intValue&quot;: &quot;A String&quot;, # A 64-bit signed integer.
295 &quot;stringValue&quot;: { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long.
296 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
297 # value is 0, then the string was not shortened.
298 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]299 # bytes long and the limit of the string is 128 bytes, then
300 # `value` contains the first 128 bytes of the 500-byte string.
301 #
302 # Truncation always happens on a UTF8 character boundary. If there
303 # are multi-byte characters in the string, then the length of the
304 # shortened string might be less than the size limit.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]305 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]306 &quot;boolValue&quot;: True or False, # A Boolean value represented by `true` or `false`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]307 },
308 },
309 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]310 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]311 &quot;messageEvent&quot;: { # An event describing a message sent/received between Spans. # An event describing a message sent/received between Spans.
312 &quot;id&quot;: &quot;A String&quot;, # An identifier for the MessageEvent&#x27;s message that can be used to match
313 # SENT and RECEIVED MessageEvents. It is recommended to be unique within
314 # a Span.
315 &quot;compressedSizeBytes&quot;: &quot;A String&quot;, # The number of compressed bytes sent or received. If missing assumed to
316 # be the same size as uncompressed.
317 &quot;uncompressedSizeBytes&quot;: &quot;A String&quot;, # The number of uncompressed bytes sent or received.
318 &quot;type&quot;: &quot;A String&quot;, # Type of MessageEvent. Indicates whether the message was sent or
319 # received.
320 },
321 &quot;time&quot;: &quot;A String&quot;, # The timestamp indicating the time the event occurred.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]322 },
323 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]324 &quot;droppedAnnotationsCount&quot;: 42, # The number of dropped annotations in all the included time events.
325 # If the value is 0, then no annotations were dropped.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]326 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]327 &quot;links&quot;: { # A collection of links, which are references from this span to a span # Links associated with the span. You can have up to 128 links per Span.
328 # in the same or different trace.
329 &quot;link&quot;: [ # A collection of links.
330 { # A pointer from the current span to another span in the same trace or in a
331 # different trace. For example, this can be used in batching operations,
332 # where a single batch handler processes multiple requests from different
333 # traces or when the handler receives a request from a different project.
334 &quot;type&quot;: &quot;A String&quot;, # The relationship of the current span relative to the linked span.
335 &quot;traceId&quot;: &quot;A String&quot;, # The [TRACE_ID] for a trace within a project.
336 &quot;attributes&quot;: { # A set of attributes, each in the format `[KEY]:[VALUE]`. # A set of attributes on the link. You have have up to 32 attributes per
337 # link.
338 &quot;droppedAttributesCount&quot;: 42, # The number of attributes that were discarded. Attributes can be discarded
339 # because their keys are too long or because there are too many attributes.
340 # If this value is 0 then all attributes are valid.
341 &quot;attributeMap&quot;: { # The set of attributes. Each attribute&#x27;s key can be up to 128 bytes
342 # long. The value can be a string up to 256 bytes, a signed 64-bit integer,
343 # or the Boolean values `true` and `false`. For example:
344 #
345 # &quot;/instance_id&quot;: { &quot;string_value&quot;: { &quot;value&quot;: &quot;my-instance&quot; } }
346 # &quot;/http/request_bytes&quot;: { &quot;int_value&quot;: 300 }
347 # &quot;abc.com/myattribute&quot;: { &quot;bool_value&quot;: false }
348 &quot;a_key&quot;: { # The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.
349 &quot;intValue&quot;: &quot;A String&quot;, # A 64-bit signed integer.
350 &quot;stringValue&quot;: { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long.
351 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
352 # value is 0, then the string was not shortened.
353 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
354 # bytes long and the limit of the string is 128 bytes, then
355 # `value` contains the first 128 bytes of the 500-byte string.
356 #
357 # Truncation always happens on a UTF8 character boundary. If there
358 # are multi-byte characters in the string, then the length of the
359 # shortened string might be less than the size limit.
360 },
361 &quot;boolValue&quot;: True or False, # A Boolean value represented by `true` or `false`.
362 },
363 },
364 },
365 &quot;spanId&quot;: &quot;A String&quot;, # The [SPAN_ID] for a span within a trace.
366 },
367 ],
368 &quot;droppedLinksCount&quot;: 42, # The number of dropped links after the maximum size was enforced. If
369 # this value is 0, then no links were dropped.
370 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]371 &quot;attributes&quot;: { # A set of attributes, each in the format `[KEY]:[VALUE]`. # A set of attributes on the span. You can have up to 32 attributes per
372 # span.
373 &quot;droppedAttributesCount&quot;: 42, # The number of attributes that were discarded. Attributes can be discarded
374 # because their keys are too long or because there are too many attributes.
375 # If this value is 0 then all attributes are valid.
376 &quot;attributeMap&quot;: { # The set of attributes. Each attribute&#x27;s key can be up to 128 bytes
377 # long. The value can be a string up to 256 bytes, a signed 64-bit integer,
378 # or the Boolean values `true` and `false`. For example:
379 #
380 # &quot;/instance_id&quot;: { &quot;string_value&quot;: { &quot;value&quot;: &quot;my-instance&quot; } }
381 # &quot;/http/request_bytes&quot;: { &quot;int_value&quot;: 300 }
382 # &quot;abc.com/myattribute&quot;: { &quot;bool_value&quot;: false }
383 &quot;a_key&quot;: { # The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.
384 &quot;intValue&quot;: &quot;A String&quot;, # A 64-bit signed integer.
385 &quot;stringValue&quot;: { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long.
386 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
387 # value is 0, then the string was not shortened.
388 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
389 # bytes long and the limit of the string is 128 bytes, then
390 # `value` contains the first 128 bytes of the 500-byte string.
391 #
392 # Truncation always happens on a UTF8 character boundary. If there
393 # are multi-byte characters in the string, then the length of the
394 # shortened string might be less than the size limit.
395 },
396 &quot;boolValue&quot;: True or False, # A Boolean value represented by `true` or `false`.
397 },
398 },
399 },
400 &quot;spanId&quot;: &quot;A String&quot;, # Required. The [SPAN_ID] portion of the span&#x27;s resource name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]401}
402
403 x__xgafv: string, V1 error format.
404 Allowed values
405 1 - v1 error format
406 2 - v2 error format
407
408Returns:
409 An object of the form:
410
411 { # A span represents a single operation within a trace. Spans can be
412 # nested to form a trace tree. Often, a trace contains a root span
413 # that describes the end-to-end latency, and one or more subspans for
414 # its sub-operations. A trace can also contain multiple root spans,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]415 # or none at all. Spans do not need to be contiguous&amp;mdash;there may be
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]416 # gaps or overlaps between spans in a trace.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]417 &quot;childSpanCount&quot;: 42, # Optional. The number of child spans that were generated while this span
418 # was active. If set, allows implementation to detect missing child spans.
419 &quot;sameProcessAsParentSpan&quot;: True or False, # Optional. Set this parameter to indicate whether this span is in
420 # the same process as its parent. If you do not set this parameter,
421 # Stackdriver Trace is unable to take advantage of this helpful
422 # information.
423 &quot;status&quot;: { # The `Status` type defines a logical error model that is suitable for # Optional. The final status for this span.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]424 # different programming environments, including REST APIs and RPC APIs. It is
425 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
426 # three pieces of data: error code, error message, and error details.
427 #
428 # You can find out more about this error model and how to work with it in the
429 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]430 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]431 # user-facing error message should be localized and sent in the
432 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]433 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]434 # message types for APIs to use.
435 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]436 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]437 },
438 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]439 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]440 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]441 &quot;name&quot;: &quot;A String&quot;, # The resource name of the span in the following format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]442 #
443 # projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project;
444 # it is a 32-character hexadecimal encoding of a 16-byte array.
445 #
446 # [SPAN_ID] is a unique identifier for a span within a trace; it
447 # is a 16-character hexadecimal encoding of an 8-byte array.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]448 &quot;stackTrace&quot;: { # A call stack appearing in a trace. # Stack trace captured at the start of the span.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]449 &quot;stackFrames&quot;: { # A collection of stack frames, which can be truncated. # Stack frames in this stack trace. A maximum of 128 frames are allowed.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]450 &quot;frame&quot;: [ # Stack frames in this call stack.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]451 { # Represents a single stack frame in a stack trace.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]452 &quot;lineNumber&quot;: &quot;A String&quot;, # The line number in `file_name` where the function call appears.
453 &quot;loadModule&quot;: { # Binary module. # The binary module from where the code was loaded.
454 &quot;module&quot;: { # Represents a string that might be shortened to a specified length. # For example: main binary, kernel modules, and dynamic libraries
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]455 # such as libc.so, sharedlib.so (up to 256 bytes).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]456 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
457 # value is 0, then the string was not shortened.
458 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]459 # bytes long and the limit of the string is 128 bytes, then
460 # `value` contains the first 128 bytes of the 500-byte string.
461 #
462 # Truncation always happens on a UTF8 character boundary. If there
463 # are multi-byte characters in the string, then the length of the
464 # shortened string might be less than the size limit.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]465 },
466 &quot;buildId&quot;: { # Represents a string that might be shortened to a specified length. # A unique identifier for the module, usually a hash of its
467 # contents (up to 128 bytes).
468 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]469 # value is 0, then the string was not shortened.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]470 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
471 # bytes long and the limit of the string is 128 bytes, then
472 # `value` contains the first 128 bytes of the 500-byte string.
473 #
474 # Truncation always happens on a UTF8 character boundary. If there
475 # are multi-byte characters in the string, then the length of the
476 # shortened string might be less than the size limit.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]477 },
478 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]479 &quot;columnNumber&quot;: &quot;A String&quot;, # The column number where the function call appears, if available.
480 # This is important in JavaScript because of its anonymous functions.
481 &quot;fileName&quot;: { # Represents a string that might be shortened to a specified length. # The name of the source file where the function call appears (up to 256
482 # bytes).
483 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
484 # value is 0, then the string was not shortened.
485 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
486 # bytes long and the limit of the string is 128 bytes, then
487 # `value` contains the first 128 bytes of the 500-byte string.
488 #
489 # Truncation always happens on a UTF8 character boundary. If there
490 # are multi-byte characters in the string, then the length of the
491 # shortened string might be less than the size limit.
492 },
493 &quot;sourceVersion&quot;: { # Represents a string that might be shortened to a specified length. # The version of the deployed source code (up to 128 bytes).
494 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
495 # value is 0, then the string was not shortened.
496 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
497 # bytes long and the limit of the string is 128 bytes, then
498 # `value` contains the first 128 bytes of the 500-byte string.
499 #
500 # Truncation always happens on a UTF8 character boundary. If there
501 # are multi-byte characters in the string, then the length of the
502 # shortened string might be less than the size limit.
503 },
504 &quot;originalFunctionName&quot;: { # Represents a string that might be shortened to a specified length. # An un-mangled function name, if `function_name` is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]505 # [mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can
506 # be fully-qualified (up to 1024 bytes).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]507 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
508 # value is 0, then the string was not shortened.
509 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]510 # bytes long and the limit of the string is 128 bytes, then
511 # `value` contains the first 128 bytes of the 500-byte string.
512 #
513 # Truncation always happens on a UTF8 character boundary. If there
514 # are multi-byte characters in the string, then the length of the
515 # shortened string might be less than the size limit.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]516 },
517 &quot;functionName&quot;: { # Represents a string that might be shortened to a specified length. # The fully-qualified name that uniquely identifies the function or
518 # method that is active in this frame (up to 1024 bytes).
519 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]520 # value is 0, then the string was not shortened.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]521 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
522 # bytes long and the limit of the string is 128 bytes, then
523 # `value` contains the first 128 bytes of the 500-byte string.
524 #
525 # Truncation always happens on a UTF8 character boundary. If there
526 # are multi-byte characters in the string, then the length of the
527 # shortened string might be less than the size limit.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]528 },
529 },
530 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]531 &quot;droppedFramesCount&quot;: 42, # The number of stack frames that were dropped because there
532 # were too many stack frames.
533 # If this value is 0, then no stack frames were dropped.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]534 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]535 &quot;stackTraceHashId&quot;: &quot;A String&quot;, # The hash ID is used to conserve network bandwidth for duplicate
536 # stack traces within a single trace.
537 #
538 # Often multiple spans will have identical stack traces.
539 # The first occurrence of a stack trace should contain both the
540 # `stackFrame` content and a value in `stackTraceHashId`.
541 #
542 # Subsequent spans within the same request can refer
543 # to that stack trace by only setting `stackTraceHashId`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]544 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]545 &quot;parentSpanId&quot;: &quot;A String&quot;, # The [SPAN_ID] of this span&#x27;s parent span. If this is a root span,
546 # then this field must be empty.
547 &quot;endTime&quot;: &quot;A String&quot;, # Required. The end time of the span. On the client side, this is the time kept by
548 # the local machine where the span execution ends. On the server side, this
549 # is the time when the server application handler stops running.
550 &quot;spanKind&quot;: &quot;A String&quot;, # Distinguishes between spans generated in a particular context. For example,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]551 # two spans with the same name may be distinguished using `CLIENT` (caller)
552 # and `SERVER` (callee) to identify an RPC call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]553 &quot;startTime&quot;: &quot;A String&quot;, # Required. The start time of the span. On the client side, this is the time kept by
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]554 # the local machine where the span execution starts. On the server side, this
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]555 # is the time when the server&#x27;s application handler starts running.
556 &quot;displayName&quot;: { # Represents a string that might be shortened to a specified length. # Required. A description of the span&#x27;s operation (up to 128 bytes).
557 # Stackdriver Trace displays the description in the
558 # Google Cloud Platform Console.
559 # For example, the display name can be a qualified method name or a file name
560 # and a line number where the operation is called. A best practice is to use
561 # the same display name within an application and at the same call point.
562 # This makes it easier to correlate spans in different traces.
563 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
564 # value is 0, then the string was not shortened.
565 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
566 # bytes long and the limit of the string is 128 bytes, then
567 # `value` contains the first 128 bytes of the 500-byte string.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]568 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]569 # Truncation always happens on a UTF8 character boundary. If there
570 # are multi-byte characters in the string, then the length of the
571 # shortened string might be less than the size limit.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]572 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]573 &quot;timeEvents&quot;: { # A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation # A set of time events. You can have up to 32 annotations and 128 message
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]574 # events per span.
575 # on the span, consisting of either user-supplied key:value pairs, or
576 # details of a message sent/received between Spans.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]577 &quot;droppedMessageEventsCount&quot;: 42, # The number of dropped message events in all the included time events.
578 # If the value is 0, then no message events were dropped.
579 &quot;timeEvent&quot;: [ # A collection of `TimeEvent`s.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]580 { # A time-stamped annotation or message event in the Span.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]581 &quot;annotation&quot;: { # Text annotation with a set of attributes. # Text annotation with a set of attributes.
582 &quot;description&quot;: { # Represents a string that might be shortened to a specified length. # A user-supplied message describing the event. The maximum length for
583 # the description is 256 bytes.
584 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
585 # value is 0, then the string was not shortened.
586 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
587 # bytes long and the limit of the string is 128 bytes, then
588 # `value` contains the first 128 bytes of the 500-byte string.
589 #
590 # Truncation always happens on a UTF8 character boundary. If there
591 # are multi-byte characters in the string, then the length of the
592 # shortened string might be less than the size limit.
593 },
594 &quot;attributes&quot;: { # A set of attributes, each in the format `[KEY]:[VALUE]`. # A set of attributes on the annotation. You can have up to 4 attributes
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]595 # per Annotation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]596 &quot;droppedAttributesCount&quot;: 42, # The number of attributes that were discarded. Attributes can be discarded
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]597 # because their keys are too long or because there are too many attributes.
598 # If this value is 0 then all attributes are valid.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]599 &quot;attributeMap&quot;: { # The set of attributes. Each attribute&#x27;s key can be up to 128 bytes
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]600 # long. The value can be a string up to 256 bytes, a signed 64-bit integer,
601 # or the Boolean values `true` and `false`. For example:
602 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]603 # &quot;/instance_id&quot;: { &quot;string_value&quot;: { &quot;value&quot;: &quot;my-instance&quot; } }
604 # &quot;/http/request_bytes&quot;: { &quot;int_value&quot;: 300 }
605 # &quot;abc.com/myattribute&quot;: { &quot;bool_value&quot;: false }
606 &quot;a_key&quot;: { # The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.
607 &quot;intValue&quot;: &quot;A String&quot;, # A 64-bit signed integer.
608 &quot;stringValue&quot;: { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long.
609 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
610 # value is 0, then the string was not shortened.
611 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]612 # bytes long and the limit of the string is 128 bytes, then
613 # `value` contains the first 128 bytes of the 500-byte string.
614 #
615 # Truncation always happens on a UTF8 character boundary. If there
616 # are multi-byte characters in the string, then the length of the
617 # shortened string might be less than the size limit.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]618 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]619 &quot;boolValue&quot;: True or False, # A Boolean value represented by `true` or `false`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]620 },
621 },
622 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]623 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]624 &quot;messageEvent&quot;: { # An event describing a message sent/received between Spans. # An event describing a message sent/received between Spans.
625 &quot;id&quot;: &quot;A String&quot;, # An identifier for the MessageEvent&#x27;s message that can be used to match
626 # SENT and RECEIVED MessageEvents. It is recommended to be unique within
627 # a Span.
628 &quot;compressedSizeBytes&quot;: &quot;A String&quot;, # The number of compressed bytes sent or received. If missing assumed to
629 # be the same size as uncompressed.
630 &quot;uncompressedSizeBytes&quot;: &quot;A String&quot;, # The number of uncompressed bytes sent or received.
631 &quot;type&quot;: &quot;A String&quot;, # Type of MessageEvent. Indicates whether the message was sent or
632 # received.
633 },
634 &quot;time&quot;: &quot;A String&quot;, # The timestamp indicating the time the event occurred.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]635 },
636 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]637 &quot;droppedAnnotationsCount&quot;: 42, # The number of dropped annotations in all the included time events.
638 # If the value is 0, then no annotations were dropped.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]639 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]640 &quot;links&quot;: { # A collection of links, which are references from this span to a span # Links associated with the span. You can have up to 128 links per Span.
641 # in the same or different trace.
642 &quot;link&quot;: [ # A collection of links.
643 { # A pointer from the current span to another span in the same trace or in a
644 # different trace. For example, this can be used in batching operations,
645 # where a single batch handler processes multiple requests from different
646 # traces or when the handler receives a request from a different project.
647 &quot;type&quot;: &quot;A String&quot;, # The relationship of the current span relative to the linked span.
648 &quot;traceId&quot;: &quot;A String&quot;, # The [TRACE_ID] for a trace within a project.
649 &quot;attributes&quot;: { # A set of attributes, each in the format `[KEY]:[VALUE]`. # A set of attributes on the link. You have have up to 32 attributes per
650 # link.
651 &quot;droppedAttributesCount&quot;: 42, # The number of attributes that were discarded. Attributes can be discarded
652 # because their keys are too long or because there are too many attributes.
653 # If this value is 0 then all attributes are valid.
654 &quot;attributeMap&quot;: { # The set of attributes. Each attribute&#x27;s key can be up to 128 bytes
655 # long. The value can be a string up to 256 bytes, a signed 64-bit integer,
656 # or the Boolean values `true` and `false`. For example:
657 #
658 # &quot;/instance_id&quot;: { &quot;string_value&quot;: { &quot;value&quot;: &quot;my-instance&quot; } }
659 # &quot;/http/request_bytes&quot;: { &quot;int_value&quot;: 300 }
660 # &quot;abc.com/myattribute&quot;: { &quot;bool_value&quot;: false }
661 &quot;a_key&quot;: { # The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.
662 &quot;intValue&quot;: &quot;A String&quot;, # A 64-bit signed integer.
663 &quot;stringValue&quot;: { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long.
664 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
665 # value is 0, then the string was not shortened.
666 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
667 # bytes long and the limit of the string is 128 bytes, then
668 # `value` contains the first 128 bytes of the 500-byte string.
669 #
670 # Truncation always happens on a UTF8 character boundary. If there
671 # are multi-byte characters in the string, then the length of the
672 # shortened string might be less than the size limit.
673 },
674 &quot;boolValue&quot;: True or False, # A Boolean value represented by `true` or `false`.
675 },
676 },
677 },
678 &quot;spanId&quot;: &quot;A String&quot;, # The [SPAN_ID] for a span within a trace.
679 },
680 ],
681 &quot;droppedLinksCount&quot;: 42, # The number of dropped links after the maximum size was enforced. If
682 # this value is 0, then no links were dropped.
683 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]684 &quot;attributes&quot;: { # A set of attributes, each in the format `[KEY]:[VALUE]`. # A set of attributes on the span. You can have up to 32 attributes per
685 # span.
686 &quot;droppedAttributesCount&quot;: 42, # The number of attributes that were discarded. Attributes can be discarded
687 # because their keys are too long or because there are too many attributes.
688 # If this value is 0 then all attributes are valid.
689 &quot;attributeMap&quot;: { # The set of attributes. Each attribute&#x27;s key can be up to 128 bytes
690 # long. The value can be a string up to 256 bytes, a signed 64-bit integer,
691 # or the Boolean values `true` and `false`. For example:
692 #
693 # &quot;/instance_id&quot;: { &quot;string_value&quot;: { &quot;value&quot;: &quot;my-instance&quot; } }
694 # &quot;/http/request_bytes&quot;: { &quot;int_value&quot;: 300 }
695 # &quot;abc.com/myattribute&quot;: { &quot;bool_value&quot;: false }
696 &quot;a_key&quot;: { # The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.
697 &quot;intValue&quot;: &quot;A String&quot;, # A 64-bit signed integer.
698 &quot;stringValue&quot;: { # Represents a string that might be shortened to a specified length. # A string up to 256 bytes long.
699 &quot;truncatedByteCount&quot;: 42, # The number of bytes removed from the original string. If this
700 # value is 0, then the string was not shortened.
701 &quot;value&quot;: &quot;A String&quot;, # The shortened string. For example, if the original string is 500
702 # bytes long and the limit of the string is 128 bytes, then
703 # `value` contains the first 128 bytes of the 500-byte string.
704 #
705 # Truncation always happens on a UTF8 character boundary. If there
706 # are multi-byte characters in the string, then the length of the
707 # shortened string might be less than the size limit.
708 },
709 &quot;boolValue&quot;: True or False, # A Boolean value represented by `true` or `false`.
710 },
711 },
712 },
713 &quot;spanId&quot;: &quot;A String&quot;, # Required. The [SPAN_ID] portion of the span&#x27;s resource name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]714 }</pre>
715</div>
716
717</body></html>