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