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