blob: fa182a81429f669823dc719b33932d8fe9332ec8 [file] [log] [blame]
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001<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
75<h1><a href="tracing_v2.html">Google Tracing API</a> . <a href="tracing_v2.projects.html">projects</a> . <a href="tracing_v2.projects.traces.html">traces</a> . <a href="tracing_v2.projects.traces.spans.html">spans</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(name, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a new Span.</p>
80<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="create">create(name, body, x__xgafv=None)</code>
83 <pre>Creates a new Span.
84
85Args:
86 name: string, The resource name of Span in the format
87`projects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID`.
88`TRACE_ID` is a unique identifier for a trace within a project and is a
89base16-encoded, case-insensitive string and is required to be 32 char long.
90`SPAN_ID` is a unique identifier for a span within a trace. It is a
91base 16-encoded, case-insensitive string of a 8-bytes array and is required
92to be 16 char long. (required)
93 body: object, The request body. (required)
94 The object takes the form of:
95
96{ # A span represents a single operation within a trace. Spans can be nested
97 # to form a trace tree. Often, a trace contains a root span that
98 # describes the end-to-end latency and, optionally, one or more subspans for
99 # its sub-operations. (A trace could alternatively contain multiple root spans,
100 # or none at all.) Spans do not need to be contiguous. There may be gaps
101 # and/or overlaps between spans in a trace.
102 "status": { # The `Status` type defines a logical error model that is suitable for different # An optional final status for this span.
103 # programming environments, including REST APIs and RPC APIs. It is used by
104 # [gRPC](https://github.com/grpc). The error model is designed to be:
105 #
106 # - Simple to use and understand for most users
107 # - Flexible enough to meet unexpected needs
108 #
109 # # Overview
110 #
111 # The `Status` message contains three pieces of data: error code, error message,
112 # and error details. The error code should be an enum value of
113 # google.rpc.Code, but it may accept additional error codes if needed. The
114 # error message should be a developer-facing English message that helps
115 # developers *understand* and *resolve* the error. If a localized user-facing
116 # error message is needed, put the localized message in the error details or
117 # localize it in the client. The optional error details may contain arbitrary
118 # information about the error. There is a predefined set of error detail types
119 # in the package `google.rpc` that can be used for common error conditions.
120 #
121 # # Language mapping
122 #
123 # The `Status` message is the logical representation of the error model, but it
124 # is not necessarily the actual wire format. When the `Status` message is
125 # exposed in different client libraries and different wire protocols, it can be
126 # mapped differently. For example, it will likely be mapped to some exceptions
127 # in Java, but more likely mapped to some error codes in C.
128 #
129 # # Other uses
130 #
131 # The error model and the `Status` message can be used in a variety of
132 # environments, either with or without APIs, to provide a
133 # consistent developer experience across different environments.
134 #
135 # Example uses of this error model include:
136 #
137 # - Partial errors. If a service needs to return partial errors to the client,
138 # it may embed the `Status` in the normal response to indicate the partial
139 # errors.
140 #
141 # - Workflow errors. A typical workflow has multiple steps. Each step may
142 # have a `Status` message for error reporting.
143 #
144 # - Batch operations. If a client uses batch request and batch response, the
145 # `Status` message should be used directly inside batch response, one for
146 # each error sub-response.
147 #
148 # - Asynchronous operations. If an API call embeds asynchronous operation
149 # results in its response, the status of those operations should be
150 # represented directly using the `Status` message.
151 #
152 # - Logging. If some API errors are stored in logs, the message `Status` could
153 # be used directly after any stripping needed for security/privacy reasons.
154 "message": "A String", # A developer-facing error message, which should be in English. Any
155 # user-facing error message should be localized and sent in the
156 # google.rpc.Status.details field, or localized by the client.
157 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
158 "details": [ # A list of messages that carry the error details. There will be a
159 # common set of message types for APIs to use.
160 {
161 "a_key": "", # Properties of the object. Contains field @type with type URL.
162 },
163 ],
164 },
165 "stackTrace": { # StackTrace collected in a trace. # Stack trace captured at the start of the span.
166 "stackTraceHashId": "A String", # The hash ID is used to conserve network bandwidth for duplicate
167 # stack traces within a single trace.
168 #
169 # Often multiple spans will have identical stack traces.
170 # The first occurrence of a stack trace should contain both the
171 # `stackFrame` content and a value in `stackTraceHashId`.
172 #
173 # Subsequent spans within the same request can refer
174 # to that stack trace by only setting `stackTraceHashId`.
175 "stackFrames": { # Represents collection of StackFrames that can be truncated. # Stack frames in this stack trace. A maximum of 128 frames are allowed.
176 "frame": [ # Stack frames in this stack trace.
177 { # Represents a single stack frame in a stack trace.
178 "columnNumber": "A String", # Column number is important in JavaScript (anonymous functions).
179 # May not be available in some languages.
180 "functionName": { # Represents a string value that might be truncated. # The fully-qualified name that uniquely identifies this function or
181 # method (up to 1024 characters).
182 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it
183 # means that the string value was not truncated.
184 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to
185 # 256 bytes.
186 },
187 "fileName": { # Represents a string value that might be truncated. # The filename of the file containing this frame (up to 256 characters).
188 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it
189 # means that the string value was not truncated.
190 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to
191 # 256 bytes.
192 },
193 "originalFunctionName": { # Represents a string value that might be truncated. # Used when the function name is
194 # [mangled](http://www.avabodh.com/cxxin/namemangling.html). May be
195 # fully-qualified (up to 1024 characters).
196 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it
197 # means that the string value was not truncated.
198 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to
199 # 256 bytes.
200 },
201 "loadModule": { # Binary module. # Binary module the code is loaded from.
202 "buildId": { # Represents a string value that might be truncated. # Build_id is a unique identifier for the module, usually a hash of its
203 # contents (up to 128 characters).
204 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it
205 # means that the string value was not truncated.
206 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to
207 # 256 bytes.
208 },
209 "module": { # Represents a string value that might be truncated. # E.g. main binary, kernel modules, and dynamic libraries
210 # such as libc.so, sharedlib.so (up to 256 characters).
211 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it
212 # means that the string value was not truncated.
213 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to
214 # 256 bytes.
215 },
216 },
217 "lineNumber": "A String", # Line number of the frame.
218 "sourceVersion": { # Represents a string value that might be truncated. # The version of the deployed source code (up to 128 characters).
219 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it
220 # means that the string value was not truncated.
221 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to
222 # 256 bytes.
223 },
224 },
225 ],
226 "droppedFramesCount": 42, # The number of dropped stack frames after the maximum size was enforced.
227 # If 0 then no frames were dropped.
228 },
229 },
230 "displayName": { # Represents a string value that might be truncated. # Description of the operation in the span. It is sanitized and displayed in
231 # the Stackdriver Trace tool in the
232 # {% dynamic print site_values.console_name %}.
233 # The display_name may be a method name or some other per-call site
234 # name. For the same executable and the same call point, a best practice is
235 # to use a consistent operation name, which makes it easier to correlate
236 # cross-trace spans.
237 # The maximum length for the display_name is 128 bytes.
238 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it
239 # means that the string value was not truncated.
240 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to
241 # 256 bytes.
242 },
243 "name": "A String", # The resource name of Span in the format
244 # `projects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID`.
245 # `TRACE_ID` is a unique identifier for a trace within a project and is a
246 # base16-encoded, case-insensitive string and is required to be 32 char long.
247 # `SPAN_ID` is a unique identifier for a span within a trace. It is a
248 # base 16-encoded, case-insensitive string of a 8-bytes array and is required
249 # to be 16 char long.
250 "links": { # A collection of links, which are references from this span to a span # A maximum of 128 links are allowed per Span.
251 # in the same or different trace.
252 "droppedLinksCount": 42, # The number of dropped links after the maximum size was enforced. If
253 # 0 then no links were dropped.
254 "link": [ # A collection of links.
255 { # A pointer from this span to another span in a different `Trace` within
256 # the same service project or within a different service project. Used
257 # (for example) in batching operations, where a single batch handler
258 # processes multiple requests from different traces or when receives a
259 # request from a different service project.
260 "spanId": "A String", # `SPAN_ID` is a unique identifier for a span within a trace. It is a
261 # base16-encoded, case-insensitive string of a 8-bytes array and is
262 # required to be 16 char long.
263 "traceId": "A String", # `TRACE_ID` is a unique identifier for a trace within a project. It is
264 # a base16-encoded, case-insensitive string of a 16-bytes array and is
265 # required to be 32 char long.
266 "type": "A String", # The relationship of the current span relative to the linked span.
267 },
268 ],
269 },
270 "parentSpanId": "A String", # ID of parent span which is a base 16-encoded, case-insensitive string of
271 # a 8-bytes array and is required to be 16 char long. If this is a root span,
272 # the value must be empty.
273 "startTime": "A String", # Start time of the span.
274 # On the client side, this is the local machine clock time at which the span
275 # execution was started; on the server
276 # side, this is the time at which the server application handler started
277 # running.
278 "spanId": "A String", # Unique identifier for a span within a trace. It is a base 16-encoded,
279 # case-insensitive string of a 8-bytes array and is required.
280 "attributes": { # Attributes of a span with a key:value format. # A set of attributes on the span. A maximum of 32 attributes are allowed per
281 # Span.
282 "droppedAttributesCount": 42, # The number of dropped attributes after the maximum size was enforced. If
283 # 0 then no attributes were dropped.
284 "attributeMap": { # The maximum key length is 128 bytes (attributes are dropped if the
285 # key size is larger than the maximum allowed). The value can be a string
286 # (up to 256 bytes), integer, or boolean (true/false). Some common pair
287 # examples:
288 #
289 # "/instance_id": "my-instance"
290 # "/zone": "us-central1-a"
291 # "/grpc/peer_address": "ip:port" (dns, etc.)
292 # "/grpc/deadline": "Duration"
293 # "/http/user_agent"
294 # "/http/request_bytes": 300
295 # "/http/response_bytes": 1200
296 # "/http/url": google.com/apis
297 # "abc.com/myattribute": true
298 "a_key": { # The allowed types for the value side of an attribute key:value pair.
299 "stringValue": { # Represents a string value that might be truncated. # A string value (up to 256 bytes).
300 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it
301 # means that the string value was not truncated.
302 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to
303 # 256 bytes.
304 },
305 "intValue": "A String", # An integer value.
306 "boolValue": True or False, # A boolean value.
307 },
308 },
309 },
310 "timeEvents": { # A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation # A maximum of 32 annotations and 128 network events are allowed per Span.
311 # on the span, consisting of either user-supplied key:value pairs, or
312 # details of an RPC message sent/received on the network.
313 "timeEvent": [ # A collection of `TimeEvent`s.
314 { # A time-stamped annotation in the Span.
315 "networkEvent": { # An event describing an RPC message sent/received on the network. A # An event describing an RPC message sent/received on the network.
316 # maximum of 128 network events are allowed per Span.
317 "messageSize": "A String", # The number of bytes sent or received.
318 "messageId": "A String", # An identifier for the message, which must be unique in this span.
319 "type": "A String", # Type of NetworkEvent. Indicates whether the RPC message was sent or
320 # received.
321 "time": "A String", # If available, this is the kernel time:
322 #
323 # * For sent messages, this is the time at which the first bit was sent.
324 # * For received messages, this is the time at which the last bit was
325 # received.
326 },
327 "annotation": { # Text annotation with a set of attributes. A maximum of 32 annotations are # One or more key:value pairs.
328 # allowed per Span.
329 "attributes": { # Attributes of a span with a key:value format. # A set of attributes on the annotation. A maximum of 4 attributes are
330 # allowed per Annotation.
331 "droppedAttributesCount": 42, # The number of dropped attributes after the maximum size was enforced. If
332 # 0 then no attributes were dropped.
333 "attributeMap": { # The maximum key length is 128 bytes (attributes are dropped if the
334 # key size is larger than the maximum allowed). The value can be a string
335 # (up to 256 bytes), integer, or boolean (true/false). Some common pair
336 # examples:
337 #
338 # "/instance_id": "my-instance"
339 # "/zone": "us-central1-a"
340 # "/grpc/peer_address": "ip:port" (dns, etc.)
341 # "/grpc/deadline": "Duration"
342 # "/http/user_agent"
343 # "/http/request_bytes": 300
344 # "/http/response_bytes": 1200
345 # "/http/url": google.com/apis
346 # "abc.com/myattribute": true
347 "a_key": { # The allowed types for the value side of an attribute key:value pair.
348 "stringValue": { # Represents a string value that might be truncated. # A string value (up to 256 bytes).
349 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it
350 # means that the string value was not truncated.
351 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to
352 # 256 bytes.
353 },
354 "intValue": "A String", # An integer value.
355 "boolValue": True or False, # A boolean value.
356 },
357 },
358 },
359 "description": { # Represents a string value that might be truncated. # A user-supplied message describing the event. The maximum length for
360 # the description is 256 bytes.
361 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it
362 # means that the string value was not truncated.
363 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to
364 # 256 bytes.
365 },
366 },
367 "time": "A String", # The timestamp indicating the time the event occurred.
368 },
369 ],
370 "droppedNetworkEventsCount": 42, # The number of dropped network events after the maximum size was enforced.
371 # If 0 then no annotations were dropped.
372 "droppedAnnotationsCount": 42, # The number of dropped annotations after the maximum size was enforced. If
373 # 0 then no annotations were dropped.
374 },
375 "endTime": "A String", # End time of the span.
376 # On the client side, this is the local machine clock time at which the span
377 # execution was ended; on the server
378 # side, this is the time at which the server application handler stopped
379 # running.
380}
381
382 x__xgafv: string, V1 error format.
383 Allowed values
384 1 - v1 error format
385 2 - v2 error format
386
387Returns:
388 An object of the form:
389
390 { # A span represents a single operation within a trace. Spans can be nested
391 # to form a trace tree. Often, a trace contains a root span that
392 # describes the end-to-end latency and, optionally, one or more subspans for
393 # its sub-operations. (A trace could alternatively contain multiple root spans,
394 # or none at all.) Spans do not need to be contiguous. There may be gaps
395 # and/or overlaps between spans in a trace.
396 "status": { # The `Status` type defines a logical error model that is suitable for different # An optional final status for this span.
397 # programming environments, including REST APIs and RPC APIs. It is used by
398 # [gRPC](https://github.com/grpc). The error model is designed to be:
399 #
400 # - Simple to use and understand for most users
401 # - Flexible enough to meet unexpected needs
402 #
403 # # Overview
404 #
405 # The `Status` message contains three pieces of data: error code, error message,
406 # and error details. The error code should be an enum value of
407 # google.rpc.Code, but it may accept additional error codes if needed. The
408 # error message should be a developer-facing English message that helps
409 # developers *understand* and *resolve* the error. If a localized user-facing
410 # error message is needed, put the localized message in the error details or
411 # localize it in the client. The optional error details may contain arbitrary
412 # information about the error. There is a predefined set of error detail types
413 # in the package `google.rpc` that can be used for common error conditions.
414 #
415 # # Language mapping
416 #
417 # The `Status` message is the logical representation of the error model, but it
418 # is not necessarily the actual wire format. When the `Status` message is
419 # exposed in different client libraries and different wire protocols, it can be
420 # mapped differently. For example, it will likely be mapped to some exceptions
421 # in Java, but more likely mapped to some error codes in C.
422 #
423 # # Other uses
424 #
425 # The error model and the `Status` message can be used in a variety of
426 # environments, either with or without APIs, to provide a
427 # consistent developer experience across different environments.
428 #
429 # Example uses of this error model include:
430 #
431 # - Partial errors. If a service needs to return partial errors to the client,
432 # it may embed the `Status` in the normal response to indicate the partial
433 # errors.
434 #
435 # - Workflow errors. A typical workflow has multiple steps. Each step may
436 # have a `Status` message for error reporting.
437 #
438 # - Batch operations. If a client uses batch request and batch response, the
439 # `Status` message should be used directly inside batch response, one for
440 # each error sub-response.
441 #
442 # - Asynchronous operations. If an API call embeds asynchronous operation
443 # results in its response, the status of those operations should be
444 # represented directly using the `Status` message.
445 #
446 # - Logging. If some API errors are stored in logs, the message `Status` could
447 # be used directly after any stripping needed for security/privacy reasons.
448 "message": "A String", # A developer-facing error message, which should be in English. Any
449 # user-facing error message should be localized and sent in the
450 # google.rpc.Status.details field, or localized by the client.
451 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
452 "details": [ # A list of messages that carry the error details. There will be a
453 # common set of message types for APIs to use.
454 {
455 "a_key": "", # Properties of the object. Contains field @type with type URL.
456 },
457 ],
458 },
459 "stackTrace": { # StackTrace collected in a trace. # Stack trace captured at the start of the span.
460 "stackTraceHashId": "A String", # The hash ID is used to conserve network bandwidth for duplicate
461 # stack traces within a single trace.
462 #
463 # Often multiple spans will have identical stack traces.
464 # The first occurrence of a stack trace should contain both the
465 # `stackFrame` content and a value in `stackTraceHashId`.
466 #
467 # Subsequent spans within the same request can refer
468 # to that stack trace by only setting `stackTraceHashId`.
469 "stackFrames": { # Represents collection of StackFrames that can be truncated. # Stack frames in this stack trace. A maximum of 128 frames are allowed.
470 "frame": [ # Stack frames in this stack trace.
471 { # Represents a single stack frame in a stack trace.
472 "columnNumber": "A String", # Column number is important in JavaScript (anonymous functions).
473 # May not be available in some languages.
474 "functionName": { # Represents a string value that might be truncated. # The fully-qualified name that uniquely identifies this function or
475 # method (up to 1024 characters).
476 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it
477 # means that the string value was not truncated.
478 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to
479 # 256 bytes.
480 },
481 "fileName": { # Represents a string value that might be truncated. # The filename of the file containing this frame (up to 256 characters).
482 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it
483 # means that the string value was not truncated.
484 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to
485 # 256 bytes.
486 },
487 "originalFunctionName": { # Represents a string value that might be truncated. # Used when the function name is
488 # [mangled](http://www.avabodh.com/cxxin/namemangling.html). May be
489 # fully-qualified (up to 1024 characters).
490 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it
491 # means that the string value was not truncated.
492 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to
493 # 256 bytes.
494 },
495 "loadModule": { # Binary module. # Binary module the code is loaded from.
496 "buildId": { # Represents a string value that might be truncated. # Build_id is a unique identifier for the module, usually a hash of its
497 # contents (up to 128 characters).
498 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it
499 # means that the string value was not truncated.
500 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to
501 # 256 bytes.
502 },
503 "module": { # Represents a string value that might be truncated. # E.g. main binary, kernel modules, and dynamic libraries
504 # such as libc.so, sharedlib.so (up to 256 characters).
505 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it
506 # means that the string value was not truncated.
507 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to
508 # 256 bytes.
509 },
510 },
511 "lineNumber": "A String", # Line number of the frame.
512 "sourceVersion": { # Represents a string value that might be truncated. # The version of the deployed source code (up to 128 characters).
513 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it
514 # means that the string value was not truncated.
515 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to
516 # 256 bytes.
517 },
518 },
519 ],
520 "droppedFramesCount": 42, # The number of dropped stack frames after the maximum size was enforced.
521 # If 0 then no frames were dropped.
522 },
523 },
524 "displayName": { # Represents a string value that might be truncated. # Description of the operation in the span. It is sanitized and displayed in
525 # the Stackdriver Trace tool in the
526 # {% dynamic print site_values.console_name %}.
527 # The display_name may be a method name or some other per-call site
528 # name. For the same executable and the same call point, a best practice is
529 # to use a consistent operation name, which makes it easier to correlate
530 # cross-trace spans.
531 # The maximum length for the display_name is 128 bytes.
532 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it
533 # means that the string value was not truncated.
534 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to
535 # 256 bytes.
536 },
537 "name": "A String", # The resource name of Span in the format
538 # `projects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID`.
539 # `TRACE_ID` is a unique identifier for a trace within a project and is a
540 # base16-encoded, case-insensitive string and is required to be 32 char long.
541 # `SPAN_ID` is a unique identifier for a span within a trace. It is a
542 # base 16-encoded, case-insensitive string of a 8-bytes array and is required
543 # to be 16 char long.
544 "links": { # A collection of links, which are references from this span to a span # A maximum of 128 links are allowed per Span.
545 # in the same or different trace.
546 "droppedLinksCount": 42, # The number of dropped links after the maximum size was enforced. If
547 # 0 then no links were dropped.
548 "link": [ # A collection of links.
549 { # A pointer from this span to another span in a different `Trace` within
550 # the same service project or within a different service project. Used
551 # (for example) in batching operations, where a single batch handler
552 # processes multiple requests from different traces or when receives a
553 # request from a different service project.
554 "spanId": "A String", # `SPAN_ID` is a unique identifier for a span within a trace. It is a
555 # base16-encoded, case-insensitive string of a 8-bytes array and is
556 # required to be 16 char long.
557 "traceId": "A String", # `TRACE_ID` is a unique identifier for a trace within a project. It is
558 # a base16-encoded, case-insensitive string of a 16-bytes array and is
559 # required to be 32 char long.
560 "type": "A String", # The relationship of the current span relative to the linked span.
561 },
562 ],
563 },
564 "parentSpanId": "A String", # ID of parent span which is a base 16-encoded, case-insensitive string of
565 # a 8-bytes array and is required to be 16 char long. If this is a root span,
566 # the value must be empty.
567 "startTime": "A String", # Start time of the span.
568 # On the client side, this is the local machine clock time at which the span
569 # execution was started; on the server
570 # side, this is the time at which the server application handler started
571 # running.
572 "spanId": "A String", # Unique identifier for a span within a trace. It is a base 16-encoded,
573 # case-insensitive string of a 8-bytes array and is required.
574 "attributes": { # Attributes of a span with a key:value format. # A set of attributes on the span. A maximum of 32 attributes are allowed per
575 # Span.
576 "droppedAttributesCount": 42, # The number of dropped attributes after the maximum size was enforced. If
577 # 0 then no attributes were dropped.
578 "attributeMap": { # The maximum key length is 128 bytes (attributes are dropped if the
579 # key size is larger than the maximum allowed). The value can be a string
580 # (up to 256 bytes), integer, or boolean (true/false). Some common pair
581 # examples:
582 #
583 # "/instance_id": "my-instance"
584 # "/zone": "us-central1-a"
585 # "/grpc/peer_address": "ip:port" (dns, etc.)
586 # "/grpc/deadline": "Duration"
587 # "/http/user_agent"
588 # "/http/request_bytes": 300
589 # "/http/response_bytes": 1200
590 # "/http/url": google.com/apis
591 # "abc.com/myattribute": true
592 "a_key": { # The allowed types for the value side of an attribute key:value pair.
593 "stringValue": { # Represents a string value that might be truncated. # A string value (up to 256 bytes).
594 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it
595 # means that the string value was not truncated.
596 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to
597 # 256 bytes.
598 },
599 "intValue": "A String", # An integer value.
600 "boolValue": True or False, # A boolean value.
601 },
602 },
603 },
604 "timeEvents": { # A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation # A maximum of 32 annotations and 128 network events are allowed per Span.
605 # on the span, consisting of either user-supplied key:value pairs, or
606 # details of an RPC message sent/received on the network.
607 "timeEvent": [ # A collection of `TimeEvent`s.
608 { # A time-stamped annotation in the Span.
609 "networkEvent": { # An event describing an RPC message sent/received on the network. A # An event describing an RPC message sent/received on the network.
610 # maximum of 128 network events are allowed per Span.
611 "messageSize": "A String", # The number of bytes sent or received.
612 "messageId": "A String", # An identifier for the message, which must be unique in this span.
613 "type": "A String", # Type of NetworkEvent. Indicates whether the RPC message was sent or
614 # received.
615 "time": "A String", # If available, this is the kernel time:
616 #
617 # * For sent messages, this is the time at which the first bit was sent.
618 # * For received messages, this is the time at which the last bit was
619 # received.
620 },
621 "annotation": { # Text annotation with a set of attributes. A maximum of 32 annotations are # One or more key:value pairs.
622 # allowed per Span.
623 "attributes": { # Attributes of a span with a key:value format. # A set of attributes on the annotation. A maximum of 4 attributes are
624 # allowed per Annotation.
625 "droppedAttributesCount": 42, # The number of dropped attributes after the maximum size was enforced. If
626 # 0 then no attributes were dropped.
627 "attributeMap": { # The maximum key length is 128 bytes (attributes are dropped if the
628 # key size is larger than the maximum allowed). The value can be a string
629 # (up to 256 bytes), integer, or boolean (true/false). Some common pair
630 # examples:
631 #
632 # "/instance_id": "my-instance"
633 # "/zone": "us-central1-a"
634 # "/grpc/peer_address": "ip:port" (dns, etc.)
635 # "/grpc/deadline": "Duration"
636 # "/http/user_agent"
637 # "/http/request_bytes": 300
638 # "/http/response_bytes": 1200
639 # "/http/url": google.com/apis
640 # "abc.com/myattribute": true
641 "a_key": { # The allowed types for the value side of an attribute key:value pair.
642 "stringValue": { # Represents a string value that might be truncated. # A string value (up to 256 bytes).
643 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it
644 # means that the string value was not truncated.
645 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to
646 # 256 bytes.
647 },
648 "intValue": "A String", # An integer value.
649 "boolValue": True or False, # A boolean value.
650 },
651 },
652 },
653 "description": { # Represents a string value that might be truncated. # A user-supplied message describing the event. The maximum length for
654 # the description is 256 bytes.
655 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it
656 # means that the string value was not truncated.
657 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to
658 # 256 bytes.
659 },
660 },
661 "time": "A String", # The timestamp indicating the time the event occurred.
662 },
663 ],
664 "droppedNetworkEventsCount": 42, # The number of dropped network events after the maximum size was enforced.
665 # If 0 then no annotations were dropped.
666 "droppedAnnotationsCount": 42, # The number of dropped annotations after the maximum size was enforced. If
667 # 0 then no annotations were dropped.
668 },
669 "endTime": "A String", # End time of the span.
670 # On the client side, this is the local machine clock time at which the span
671 # execution was ended; on the server
672 # side, this is the time at which the server application handler stopped
673 # running.
674 }</pre>
675</div>
676
677</body></html>