1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="tracing_v2.projects.traces.spans.html">spans()</a></code> 79 </p> 80 <p class="firstline">Returns the spans Resource.</p> 81 82 <p class="toc_element"> 83 <code><a href="#batchWrite">batchWrite(name, body, x__xgafv=None)</a></code></p> 84 <p class="firstline">Sends new spans to Stackdriver Trace or updates existing traces. If the</p> 85 <p class="toc_element"> 86 <code><a href="#list">list(parent, orderBy=None, startTime=None, pageSize=None, x__xgafv=None, pageToken=None, filter=None, endTime=None)</a></code></p> 87 <p class="firstline">Returns of a list of traces that match the specified filter conditions.</p> 88 <p class="toc_element"> 89 <code><a href="#listSpans">listSpans(parent, pageToken=None, x__xgafv=None)</a></code></p> 90 <p class="firstline">Returns a list of spans within a trace.</p> 91 <p class="toc_element"> 92 <code><a href="#listSpans_next">listSpans_next(previous_request, previous_response)</a></code></p> 93 <p class="firstline">Retrieves the next page of results.</p> 94 <p class="toc_element"> 95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 96 <p class="firstline">Retrieves the next page of results.</p> 97 <h3>Method Details</h3> 98 <div class="method"> 99 <code class="details" id="batchWrite">batchWrite(name, body, x__xgafv=None)</code> 100 <pre>Sends new spans to Stackdriver Trace or updates existing traces. If the 101 name of a trace that you send matches that of an existing trace, new spans 102 are added to the existing trace. Attempt to update existing spans results 103 undefined behavior. If the name does not match, a new trace is created 104 with given set of spans. 105 106 Args: 107 name: string, Name of the project where the spans belong to. Format is 108 `projects/PROJECT_ID`. (required) 109 body: object, The request body. (required) 110 The object takes the form of: 111 112 { # The request message for the `BatchWriteSpans` method. 113 "spans": [ # A collection of spans. 114 { # A span represents a single operation within a trace. Spans can be nested 115 # to form a trace tree. Often, a trace contains a root span that 116 # describes the end-to-end latency and, optionally, one or more subspans for 117 # its sub-operations. (A trace could alternatively contain multiple root spans, 118 # or none at all.) Spans do not need to be contiguous. There may be gaps 119 # and/or overlaps between spans in a trace. 120 "status": { # The `Status` type defines a logical error model that is suitable for different # An optional final status for this span. 121 # programming environments, including REST APIs and RPC APIs. It is used by 122 # [gRPC](https://github.com/grpc). The error model is designed to be: 123 # 124 # - Simple to use and understand for most users 125 # - Flexible enough to meet unexpected needs 126 # 127 # # Overview 128 # 129 # The `Status` message contains three pieces of data: error code, error message, 130 # and error details. The error code should be an enum value of 131 # google.rpc.Code, but it may accept additional error codes if needed. The 132 # error message should be a developer-facing English message that helps 133 # developers *understand* and *resolve* the error. If a localized user-facing 134 # error message is needed, put the localized message in the error details or 135 # localize it in the client. The optional error details may contain arbitrary 136 # information about the error. There is a predefined set of error detail types 137 # in the package `google.rpc` that can be used for common error conditions. 138 # 139 # # Language mapping 140 # 141 # The `Status` message is the logical representation of the error model, but it 142 # is not necessarily the actual wire format. When the `Status` message is 143 # exposed in different client libraries and different wire protocols, it can be 144 # mapped differently. For example, it will likely be mapped to some exceptions 145 # in Java, but more likely mapped to some error codes in C. 146 # 147 # # Other uses 148 # 149 # The error model and the `Status` message can be used in a variety of 150 # environments, either with or without APIs, to provide a 151 # consistent developer experience across different environments. 152 # 153 # Example uses of this error model include: 154 # 155 # - Partial errors. If a service needs to return partial errors to the client, 156 # it may embed the `Status` in the normal response to indicate the partial 157 # errors. 158 # 159 # - Workflow errors. A typical workflow has multiple steps. Each step may 160 # have a `Status` message for error reporting. 161 # 162 # - Batch operations. If a client uses batch request and batch response, the 163 # `Status` message should be used directly inside batch response, one for 164 # each error sub-response. 165 # 166 # - Asynchronous operations. If an API call embeds asynchronous operation 167 # results in its response, the status of those operations should be 168 # represented directly using the `Status` message. 169 # 170 # - Logging. If some API errors are stored in logs, the message `Status` could 171 # be used directly after any stripping needed for security/privacy reasons. 172 "message": "A String", # A developer-facing error message, which should be in English. Any 173 # user-facing error message should be localized and sent in the 174 # google.rpc.Status.details field, or localized by the client. 175 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 176 "details": [ # A list of messages that carry the error details. There will be a 177 # common set of message types for APIs to use. 178 { 179 "a_key": "", # Properties of the object. Contains field @type with type URL. 180 }, 181 ], 182 }, 183 "stackTrace": { # StackTrace collected in a trace. # Stack trace captured at the start of the span. 184 "stackTraceHashId": "A String", # The hash ID is used to conserve network bandwidth for duplicate 185 # stack traces within a single trace. 186 # 187 # Often multiple spans will have identical stack traces. 188 # The first occurrence of a stack trace should contain both the 189 # `stackFrame` content and a value in `stackTraceHashId`. 190 # 191 # Subsequent spans within the same request can refer 192 # to that stack trace by only setting `stackTraceHashId`. 193 "stackFrames": { # Represents collection of StackFrames that can be truncated. # Stack frames in this stack trace. A maximum of 128 frames are allowed. 194 "frame": [ # Stack frames in this stack trace. 195 { # Represents a single stack frame in a stack trace. 196 "columnNumber": "A String", # Column number is important in JavaScript (anonymous functions). 197 # May not be available in some languages. 198 "functionName": { # Represents a string value that might be truncated. # The fully-qualified name that uniquely identifies this function or 199 # method (up to 1024 characters). 200 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it 201 # means that the string value was not truncated. 202 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to 203 # 256 bytes. 204 }, 205 "fileName": { # Represents a string value that might be truncated. # The filename of the file containing this frame (up to 256 characters). 206 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it 207 # means that the string value was not truncated. 208 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to 209 # 256 bytes. 210 }, 211 "originalFunctionName": { # Represents a string value that might be truncated. # Used when the function name is 212 # [mangled](http://www.avabodh.com/cxxin/namemangling.html). May be 213 # fully-qualified (up to 1024 characters). 214 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it 215 # means that the string value was not truncated. 216 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to 217 # 256 bytes. 218 }, 219 "loadModule": { # Binary module. # Binary module the code is loaded from. 220 "buildId": { # Represents a string value that might be truncated. # Build_id is a unique identifier for the module, usually a hash of its 221 # contents (up to 128 characters). 222 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it 223 # means that the string value was not truncated. 224 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to 225 # 256 bytes. 226 }, 227 "module": { # Represents a string value that might be truncated. # E.g. main binary, kernel modules, and dynamic libraries 228 # such as libc.so, sharedlib.so (up to 256 characters). 229 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it 230 # means that the string value was not truncated. 231 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to 232 # 256 bytes. 233 }, 234 }, 235 "lineNumber": "A String", # Line number of the frame. 236 "sourceVersion": { # Represents a string value that might be truncated. # The version of the deployed source code (up to 128 characters). 237 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it 238 # means that the string value was not truncated. 239 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to 240 # 256 bytes. 241 }, 242 }, 243 ], 244 "droppedFramesCount": 42, # The number of dropped stack frames after the maximum size was enforced. 245 # If 0 then no frames were dropped. 246 }, 247 }, 248 "displayName": { # Represents a string value that might be truncated. # Description of the operation in the span. It is sanitized and displayed in 249 # the Stackdriver Trace tool in the 250 # {% dynamic print site_values.console_name %}. 251 # The display_name may be a method name or some other per-call site 252 # name. For the same executable and the same call point, a best practice is 253 # to use a consistent operation name, which makes it easier to correlate 254 # cross-trace spans. 255 # The maximum length for the display_name is 128 bytes. 256 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it 257 # means that the string value was not truncated. 258 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to 259 # 256 bytes. 260 }, 261 "name": "A String", # The resource name of Span in the format 262 # `projects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID`. 263 # `TRACE_ID` is a unique identifier for a trace within a project and is a 264 # base16-encoded, case-insensitive string and is required to be 32 char long. 265 # `SPAN_ID` is a unique identifier for a span within a trace. It is a 266 # base 16-encoded, case-insensitive string of a 8-bytes array and is required 267 # to be 16 char long. 268 "links": { # A collection of links, which are references from this span to a span # A maximum of 128 links are allowed per Span. 269 # in the same or different trace. 270 "droppedLinksCount": 42, # The number of dropped links after the maximum size was enforced. If 271 # 0 then no links were dropped. 272 "link": [ # A collection of links. 273 { # A pointer from this span to another span in a different `Trace` within 274 # the same service project or within a different service project. Used 275 # (for example) in batching operations, where a single batch handler 276 # processes multiple requests from different traces or when receives a 277 # request from a different service project. 278 "spanId": "A String", # `SPAN_ID` is a unique identifier for a span within a trace. It is a 279 # base16-encoded, case-insensitive string of a 8-bytes array and is 280 # required to be 16 char long. 281 "traceId": "A String", # `TRACE_ID` is a unique identifier for a trace within a project. It is 282 # a base16-encoded, case-insensitive string of a 16-bytes array and is 283 # required to be 32 char long. 284 "type": "A String", # The relationship of the current span relative to the linked span. 285 }, 286 ], 287 }, 288 "parentSpanId": "A String", # ID of parent span which is a base 16-encoded, case-insensitive string of 289 # a 8-bytes array and is required to be 16 char long. If this is a root span, 290 # the value must be empty. 291 "startTime": "A String", # Start time of the span. 292 # On the client side, this is the local machine clock time at which the span 293 # execution was started; on the server 294 # side, this is the time at which the server application handler started 295 # running. 296 "spanId": "A String", # Unique identifier for a span within a trace. It is a base 16-encoded, 297 # case-insensitive string of a 8-bytes array and is required. 298 "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 299 # Span. 300 "droppedAttributesCount": 42, # The number of dropped attributes after the maximum size was enforced. If 301 # 0 then no attributes were dropped. 302 "attributeMap": { # The maximum key length is 128 bytes (attributes are dropped if the 303 # key size is larger than the maximum allowed). The value can be a string 304 # (up to 256 bytes), integer, or boolean (true/false). Some common pair 305 # examples: 306 # 307 # "/instance_id": "my-instance" 308 # "/zone": "us-central1-a" 309 # "/grpc/peer_address": "ip:port" (dns, etc.) 310 # "/grpc/deadline": "Duration" 311 # "/http/user_agent" 312 # "/http/request_bytes": 300 313 # "/http/response_bytes": 1200 314 # "/http/url": google.com/apis 315 # "abc.com/myattribute": true 316 "a_key": { # The allowed types for the value side of an attribute key:value pair. 317 "stringValue": { # Represents a string value that might be truncated. # A string value (up to 256 bytes). 318 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it 319 # means that the string value was not truncated. 320 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to 321 # 256 bytes. 322 }, 323 "intValue": "A String", # An integer value. 324 "boolValue": True or False, # A boolean value. 325 }, 326 }, 327 }, 328 "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. 329 # on the span, consisting of either user-supplied key:value pairs, or 330 # details of an RPC message sent/received on the network. 331 "timeEvent": [ # A collection of `TimeEvent`s. 332 { # A time-stamped annotation in the Span. 333 "networkEvent": { # An event describing an RPC message sent/received on the network. A # An event describing an RPC message sent/received on the network. 334 # maximum of 128 network events are allowed per Span. 335 "messageSize": "A String", # The number of bytes sent or received. 336 "messageId": "A String", # An identifier for the message, which must be unique in this span. 337 "type": "A String", # Type of NetworkEvent. Indicates whether the RPC message was sent or 338 # received. 339 "time": "A String", # If available, this is the kernel time: 340 # 341 # * For sent messages, this is the time at which the first bit was sent. 342 # * For received messages, this is the time at which the last bit was 343 # received. 344 }, 345 "annotation": { # Text annotation with a set of attributes. A maximum of 32 annotations are # One or more key:value pairs. 346 # allowed per Span. 347 "attributes": { # Attributes of a span with a key:value format. # A set of attributes on the annotation. A maximum of 4 attributes are 348 # allowed per Annotation. 349 "droppedAttributesCount": 42, # The number of dropped attributes after the maximum size was enforced. If 350 # 0 then no attributes were dropped. 351 "attributeMap": { # The maximum key length is 128 bytes (attributes are dropped if the 352 # key size is larger than the maximum allowed). The value can be a string 353 # (up to 256 bytes), integer, or boolean (true/false). Some common pair 354 # examples: 355 # 356 # "/instance_id": "my-instance" 357 # "/zone": "us-central1-a" 358 # "/grpc/peer_address": "ip:port" (dns, etc.) 359 # "/grpc/deadline": "Duration" 360 # "/http/user_agent" 361 # "/http/request_bytes": 300 362 # "/http/response_bytes": 1200 363 # "/http/url": google.com/apis 364 # "abc.com/myattribute": true 365 "a_key": { # The allowed types for the value side of an attribute key:value pair. 366 "stringValue": { # Represents a string value that might be truncated. # A string value (up to 256 bytes). 367 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it 368 # means that the string value was not truncated. 369 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to 370 # 256 bytes. 371 }, 372 "intValue": "A String", # An integer value. 373 "boolValue": True or False, # A boolean value. 374 }, 375 }, 376 }, 377 "description": { # Represents a string value that might be truncated. # A user-supplied message describing the event. The maximum length for 378 # the description is 256 bytes. 379 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it 380 # means that the string value was not truncated. 381 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to 382 # 256 bytes. 383 }, 384 }, 385 "time": "A String", # The timestamp indicating the time the event occurred. 386 }, 387 ], 388 "droppedNetworkEventsCount": 42, # The number of dropped network events after the maximum size was enforced. 389 # If 0 then no annotations were dropped. 390 "droppedAnnotationsCount": 42, # The number of dropped annotations after the maximum size was enforced. If 391 # 0 then no annotations were dropped. 392 }, 393 "endTime": "A String", # End time of the span. 394 # On the client side, this is the local machine clock time at which the span 395 # execution was ended; on the server 396 # side, this is the time at which the server application handler stopped 397 # running. 398 }, 399 ], 400 } 401 402 x__xgafv: string, V1 error format. 403 Allowed values 404 1 - v1 error format 405 2 - v2 error format 406 407 Returns: 408 An object of the form: 409 410 { # A generic empty message that you can re-use to avoid defining duplicated 411 # empty messages in your APIs. A typical example is to use it as the request 412 # or the response type of an API method. For instance: 413 # 414 # service Foo { 415 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 416 # } 417 # 418 # The JSON representation for `Empty` is empty JSON object `{}`. 419 }</pre> 420 </div> 421 422 <div class="method"> 423 <code class="details" id="list">list(parent, orderBy=None, startTime=None, pageSize=None, x__xgafv=None, pageToken=None, filter=None, endTime=None)</code> 424 <pre>Returns of a list of traces that match the specified filter conditions. 425 426 Args: 427 parent: string, ID of the Cloud project where the trace data is stored which is 428 `projects/PROJECT_ID`. (required) 429 orderBy: string, Field used to sort the returned traces. Optional. 430 Can be one of the following: 431 432 * `trace_id` 433 * `name` (`name` field of root span in the trace) 434 * `duration` (difference between `end_time` and `start_time` fields of 435 the root span) 436 * `start` (`start_time` field of the root span) 437 438 Descending order can be specified by appending `desc` to the sort field 439 (for example, `name desc`). 440 441 Only one sort field is permitted. 442 startTime: string, Start of the time interval (inclusive) during which the trace data was 443 collected from the application. 444 pageSize: integer, Maximum number of traces to return. If not specified or <= 0, the 445 implementation selects a reasonable value. The implementation may 446 return fewer traces than the requested page size. Optional. 447 x__xgafv: string, V1 error format. 448 Allowed values 449 1 - v1 error format 450 2 - v2 error format 451 pageToken: string, Token identifying the page of results to return. If provided, use the 452 value of the `next_page_token` field from a previous request. Optional. 453 filter: string, An optional filter for the request. 454 Example: 455 `version_label_key:a some_label:some_label_key` 456 returns traces from version `a` and has `some_label` with `some_label_key`. 457 endTime: string, End of the time interval (inclusive) during which the trace data was 458 collected from the application. 459 460 Returns: 461 An object of the form: 462 463 { # The response message for the `ListTraces` method. 464 "nextPageToken": "A String", # If defined, indicates that there are more traces that match the request 465 # and that this value should be passed to the next request to continue 466 # retrieving additional traces. 467 "traces": [ # List of trace records returned. 468 { # A trace describes how long it takes for an application to perform some 469 # operations. It consists of a set of spans, each representing 470 # an operation and including time information and operation details. 471 "name": "A String", # The resource name of Trace in the format 472 # `projects/PROJECT_ID/traces/TRACE_ID`. `TRACE_ID` is a unique identifier 473 # for a trace within a project and is a base16-encoded, case-insensitive 474 # string and is required to be 32 char long. 475 }, 476 ], 477 }</pre> 478 </div> 479 480 <div class="method"> 481 <code class="details" id="listSpans">listSpans(parent, pageToken=None, x__xgafv=None)</code> 482 <pre>Returns a list of spans within a trace. 483 484 Args: 485 parent: string, ID of the trace for which to list child spans. Format is 486 `projects/PROJECT_ID/traces/TRACE_ID`. (required) 487 pageToken: string, Token identifying the page of results to return. If provided, use the 488 value of the `nextPageToken` field from a previous request. Optional. 489 x__xgafv: string, V1 error format. 490 Allowed values 491 1 - v1 error format 492 2 - v2 error format 493 494 Returns: 495 An object of the form: 496 497 { # The response message for the `ListSpans` method. 498 "nextPageToken": "A String", # If defined, indicates that there are more spans that match the request. 499 # Pass this as the value of `pageToken` in a subsequent request to retrieve 500 # additional spans. 501 "spans": [ # The requested spans if there are any in the specified trace. 502 { # A span represents a single operation within a trace. Spans can be nested 503 # to form a trace tree. Often, a trace contains a root span that 504 # describes the end-to-end latency and, optionally, one or more subspans for 505 # its sub-operations. (A trace could alternatively contain multiple root spans, 506 # or none at all.) Spans do not need to be contiguous. There may be gaps 507 # and/or overlaps between spans in a trace. 508 "status": { # The `Status` type defines a logical error model that is suitable for different # An optional final status for this span. 509 # programming environments, including REST APIs and RPC APIs. It is used by 510 # [gRPC](https://github.com/grpc). The error model is designed to be: 511 # 512 # - Simple to use and understand for most users 513 # - Flexible enough to meet unexpected needs 514 # 515 # # Overview 516 # 517 # The `Status` message contains three pieces of data: error code, error message, 518 # and error details. The error code should be an enum value of 519 # google.rpc.Code, but it may accept additional error codes if needed. The 520 # error message should be a developer-facing English message that helps 521 # developers *understand* and *resolve* the error. If a localized user-facing 522 # error message is needed, put the localized message in the error details or 523 # localize it in the client. The optional error details may contain arbitrary 524 # information about the error. There is a predefined set of error detail types 525 # in the package `google.rpc` that can be used for common error conditions. 526 # 527 # # Language mapping 528 # 529 # The `Status` message is the logical representation of the error model, but it 530 # is not necessarily the actual wire format. When the `Status` message is 531 # exposed in different client libraries and different wire protocols, it can be 532 # mapped differently. For example, it will likely be mapped to some exceptions 533 # in Java, but more likely mapped to some error codes in C. 534 # 535 # # Other uses 536 # 537 # The error model and the `Status` message can be used in a variety of 538 # environments, either with or without APIs, to provide a 539 # consistent developer experience across different environments. 540 # 541 # Example uses of this error model include: 542 # 543 # - Partial errors. If a service needs to return partial errors to the client, 544 # it may embed the `Status` in the normal response to indicate the partial 545 # errors. 546 # 547 # - Workflow errors. A typical workflow has multiple steps. Each step may 548 # have a `Status` message for error reporting. 549 # 550 # - Batch operations. If a client uses batch request and batch response, the 551 # `Status` message should be used directly inside batch response, one for 552 # each error sub-response. 553 # 554 # - Asynchronous operations. If an API call embeds asynchronous operation 555 # results in its response, the status of those operations should be 556 # represented directly using the `Status` message. 557 # 558 # - Logging. If some API errors are stored in logs, the message `Status` could 559 # be used directly after any stripping needed for security/privacy reasons. 560 "message": "A String", # A developer-facing error message, which should be in English. Any 561 # user-facing error message should be localized and sent in the 562 # google.rpc.Status.details field, or localized by the client. 563 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 564 "details": [ # A list of messages that carry the error details. There will be a 565 # common set of message types for APIs to use. 566 { 567 "a_key": "", # Properties of the object. Contains field @type with type URL. 568 }, 569 ], 570 }, 571 "stackTrace": { # StackTrace collected in a trace. # Stack trace captured at the start of the span. 572 "stackTraceHashId": "A String", # The hash ID is used to conserve network bandwidth for duplicate 573 # stack traces within a single trace. 574 # 575 # Often multiple spans will have identical stack traces. 576 # The first occurrence of a stack trace should contain both the 577 # `stackFrame` content and a value in `stackTraceHashId`. 578 # 579 # Subsequent spans within the same request can refer 580 # to that stack trace by only setting `stackTraceHashId`. 581 "stackFrames": { # Represents collection of StackFrames that can be truncated. # Stack frames in this stack trace. A maximum of 128 frames are allowed. 582 "frame": [ # Stack frames in this stack trace. 583 { # Represents a single stack frame in a stack trace. 584 "columnNumber": "A String", # Column number is important in JavaScript (anonymous functions). 585 # May not be available in some languages. 586 "functionName": { # Represents a string value that might be truncated. # The fully-qualified name that uniquely identifies this function or 587 # method (up to 1024 characters). 588 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it 589 # means that the string value was not truncated. 590 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to 591 # 256 bytes. 592 }, 593 "fileName": { # Represents a string value that might be truncated. # The filename of the file containing this frame (up to 256 characters). 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 "originalFunctionName": { # Represents a string value that might be truncated. # Used when the function name is 600 # [mangled](http://www.avabodh.com/cxxin/namemangling.html). May be 601 # fully-qualified (up to 1024 characters). 602 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it 603 # means that the string value was not truncated. 604 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to 605 # 256 bytes. 606 }, 607 "loadModule": { # Binary module. # Binary module the code is loaded from. 608 "buildId": { # Represents a string value that might be truncated. # Build_id is a unique identifier for the module, usually a hash of its 609 # contents (up to 128 characters). 610 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it 611 # means that the string value was not truncated. 612 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to 613 # 256 bytes. 614 }, 615 "module": { # Represents a string value that might be truncated. # E.g. main binary, kernel modules, and dynamic libraries 616 # such as libc.so, sharedlib.so (up to 256 characters). 617 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it 618 # means that the string value was not truncated. 619 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to 620 # 256 bytes. 621 }, 622 }, 623 "lineNumber": "A String", # Line number of the frame. 624 "sourceVersion": { # Represents a string value that might be truncated. # The version of the deployed source code (up to 128 characters). 625 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it 626 # means that the string value was not truncated. 627 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to 628 # 256 bytes. 629 }, 630 }, 631 ], 632 "droppedFramesCount": 42, # The number of dropped stack frames after the maximum size was enforced. 633 # If 0 then no frames were dropped. 634 }, 635 }, 636 "displayName": { # Represents a string value that might be truncated. # Description of the operation in the span. It is sanitized and displayed in 637 # the Stackdriver Trace tool in the 638 # {% dynamic print site_values.console_name %}. 639 # The display_name may be a method name or some other per-call site 640 # name. For the same executable and the same call point, a best practice is 641 # to use a consistent operation name, which makes it easier to correlate 642 # cross-trace spans. 643 # The maximum length for the display_name is 128 bytes. 644 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it 645 # means that the string value was not truncated. 646 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to 647 # 256 bytes. 648 }, 649 "name": "A String", # The resource name of Span in the format 650 # `projects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID`. 651 # `TRACE_ID` is a unique identifier for a trace within a project and is a 652 # base16-encoded, case-insensitive string and is required to be 32 char long. 653 # `SPAN_ID` is a unique identifier for a span within a trace. It is a 654 # base 16-encoded, case-insensitive string of a 8-bytes array and is required 655 # to be 16 char long. 656 "links": { # A collection of links, which are references from this span to a span # A maximum of 128 links are allowed per Span. 657 # in the same or different trace. 658 "droppedLinksCount": 42, # The number of dropped links after the maximum size was enforced. If 659 # 0 then no links were dropped. 660 "link": [ # A collection of links. 661 { # A pointer from this span to another span in a different `Trace` within 662 # the same service project or within a different service project. Used 663 # (for example) in batching operations, where a single batch handler 664 # processes multiple requests from different traces or when receives a 665 # request from a different service project. 666 "spanId": "A String", # `SPAN_ID` is a unique identifier for a span within a trace. It is a 667 # base16-encoded, case-insensitive string of a 8-bytes array and is 668 # required to be 16 char long. 669 "traceId": "A String", # `TRACE_ID` is a unique identifier for a trace within a project. It is 670 # a base16-encoded, case-insensitive string of a 16-bytes array and is 671 # required to be 32 char long. 672 "type": "A String", # The relationship of the current span relative to the linked span. 673 }, 674 ], 675 }, 676 "parentSpanId": "A String", # ID of parent span which is a base 16-encoded, case-insensitive string of 677 # a 8-bytes array and is required to be 16 char long. If this is a root span, 678 # the value must be empty. 679 "startTime": "A String", # Start time of the span. 680 # On the client side, this is the local machine clock time at which the span 681 # execution was started; on the server 682 # side, this is the time at which the server application handler started 683 # running. 684 "spanId": "A String", # Unique identifier for a span within a trace. It is a base 16-encoded, 685 # case-insensitive string of a 8-bytes array and is required. 686 "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 687 # Span. 688 "droppedAttributesCount": 42, # The number of dropped attributes after the maximum size was enforced. If 689 # 0 then no attributes were dropped. 690 "attributeMap": { # The maximum key length is 128 bytes (attributes are dropped if the 691 # key size is larger than the maximum allowed). The value can be a string 692 # (up to 256 bytes), integer, or boolean (true/false). Some common pair 693 # examples: 694 # 695 # "/instance_id": "my-instance" 696 # "/zone": "us-central1-a" 697 # "/grpc/peer_address": "ip:port" (dns, etc.) 698 # "/grpc/deadline": "Duration" 699 # "/http/user_agent" 700 # "/http/request_bytes": 300 701 # "/http/response_bytes": 1200 702 # "/http/url": google.com/apis 703 # "abc.com/myattribute": true 704 "a_key": { # The allowed types for the value side of an attribute key:value pair. 705 "stringValue": { # Represents a string value that might be truncated. # A string value (up to 256 bytes). 706 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it 707 # means that the string value was not truncated. 708 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to 709 # 256 bytes. 710 }, 711 "intValue": "A String", # An integer value. 712 "boolValue": True or False, # A boolean value. 713 }, 714 }, 715 }, 716 "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. 717 # on the span, consisting of either user-supplied key:value pairs, or 718 # details of an RPC message sent/received on the network. 719 "timeEvent": [ # A collection of `TimeEvent`s. 720 { # A time-stamped annotation in the Span. 721 "networkEvent": { # An event describing an RPC message sent/received on the network. A # An event describing an RPC message sent/received on the network. 722 # maximum of 128 network events are allowed per Span. 723 "messageSize": "A String", # The number of bytes sent or received. 724 "messageId": "A String", # An identifier for the message, which must be unique in this span. 725 "type": "A String", # Type of NetworkEvent. Indicates whether the RPC message was sent or 726 # received. 727 "time": "A String", # If available, this is the kernel time: 728 # 729 # * For sent messages, this is the time at which the first bit was sent. 730 # * For received messages, this is the time at which the last bit was 731 # received. 732 }, 733 "annotation": { # Text annotation with a set of attributes. A maximum of 32 annotations are # One or more key:value pairs. 734 # allowed per Span. 735 "attributes": { # Attributes of a span with a key:value format. # A set of attributes on the annotation. A maximum of 4 attributes are 736 # allowed per Annotation. 737 "droppedAttributesCount": 42, # The number of dropped attributes after the maximum size was enforced. If 738 # 0 then no attributes were dropped. 739 "attributeMap": { # The maximum key length is 128 bytes (attributes are dropped if the 740 # key size is larger than the maximum allowed). The value can be a string 741 # (up to 256 bytes), integer, or boolean (true/false). Some common pair 742 # examples: 743 # 744 # "/instance_id": "my-instance" 745 # "/zone": "us-central1-a" 746 # "/grpc/peer_address": "ip:port" (dns, etc.) 747 # "/grpc/deadline": "Duration" 748 # "/http/user_agent" 749 # "/http/request_bytes": 300 750 # "/http/response_bytes": 1200 751 # "/http/url": google.com/apis 752 # "abc.com/myattribute": true 753 "a_key": { # The allowed types for the value side of an attribute key:value pair. 754 "stringValue": { # Represents a string value that might be truncated. # A string value (up to 256 bytes). 755 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it 756 # means that the string value was not truncated. 757 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to 758 # 256 bytes. 759 }, 760 "intValue": "A String", # An integer value. 761 "boolValue": True or False, # A boolean value. 762 }, 763 }, 764 }, 765 "description": { # Represents a string value that might be truncated. # A user-supplied message describing the event. The maximum length for 766 # the description is 256 bytes. 767 "truncatedCharacterCount": 42, # The number of characters truncated from the original string value. If 0 it 768 # means that the string value was not truncated. 769 "value": "A String", # The truncated string value. E.g. for a string attribute this may have up to 770 # 256 bytes. 771 }, 772 }, 773 "time": "A String", # The timestamp indicating the time the event occurred. 774 }, 775 ], 776 "droppedNetworkEventsCount": 42, # The number of dropped network events after the maximum size was enforced. 777 # If 0 then no annotations were dropped. 778 "droppedAnnotationsCount": 42, # The number of dropped annotations after the maximum size was enforced. If 779 # 0 then no annotations were dropped. 780 }, 781 "endTime": "A String", # End time of the span. 782 # On the client side, this is the local machine clock time at which the span 783 # execution was ended; on the server 784 # side, this is the time at which the server application handler stopped 785 # running. 786 }, 787 ], 788 }</pre> 789 </div> 790 791 <div class="method"> 792 <code class="details" id="listSpans_next">listSpans_next(previous_request, previous_response)</code> 793 <pre>Retrieves the next page of results. 794 795 Args: 796 previous_request: The request for the previous page. (required) 797 previous_response: The response from the request for the previous page. (required) 798 799 Returns: 800 A request object that you can call 'execute()' on to request the next 801 page. Returns None if there are no more items in the collection. 802 </pre> 803 </div> 804 805 <div class="method"> 806 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 807 <pre>Retrieves the next page of results. 808 809 Args: 810 previous_request: The request for the previous page. (required) 811 previous_response: The response from the request for the previous page. (required) 812 813 Returns: 814 A request object that you can call 'execute()' on to request the next 815 page. Returns None if there are no more items in the collection. 816 </pre> 817 </div> 818 819 </body></html>
