1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="cloudtrace_v1.html">Stackdriver Trace API</a> . <a href="cloudtrace_v1.projects.html">projects</a> . <a href="cloudtrace_v1.projects.traces.html">traces</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(projectId, traceId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a single trace by its ID.</p>
<p class="toc_element">
<code><a href="#list">list(projectId, orderBy=None, startTime=None, pageSize=None, x__xgafv=None, pageToken=None, filter=None, endTime=None, view=None)</a></code></p>
<p class="firstline">Returns of a list of traces that match the specified filter conditions.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(projectId, traceId, x__xgafv=None)</code>
<pre>Gets a single trace by its ID.
Args:
projectId: string, ID of the Cloud project where the trace data is stored. (required)
traceId: string, ID of the trace to return. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A trace describes how long it takes for an application to perform an
# operation. It consists of a set of spans, each of which represent a single
# timed event within the operation.
"projectId": "A String", # Project ID of the Cloud project where the trace data is stored.
"traceId": "A String", # Globally unique identifier for the trace. This identifier is a 128-bit
# numeric value formatted as a 32-byte hex string. For example,
# `382d4f4c6b7bb2f4a972559d9085001d`.
"spans": [ # Collection of spans in the trace.
{ # A span represents a single timed event within a trace. Spans can be nested
# and form a trace tree. Often, a trace contains a root span that describes the
# end-to-end latency of an operation and, optionally, one or more subspans for
# its suboperations. Spans do not need to be contiguous. There may be gaps
# between spans in a trace.
"kind": "A String", # Distinguishes between spans generated in a particular context. For example,
# two spans with the same name may be distinguished using `RPC_CLIENT`
# and `RPC_SERVER` to identify queueing latency associated with the span.
"name": "A String", # Name of the span. Must be less than 128 bytes. The span name is sanitized
# and displayed in the Stackdriver Trace tool in the
# Google Cloud Platform Console.
# The name may be a method name or some other per-call site name.
# For the same executable and the same call point, a best practice is
# to use a consistent name, which makes it easier to correlate
# cross-trace spans.
"labels": { # Collection of labels associated with the span. Label keys must be less than
# 128 bytes. Label values must be less than 16 kilobytes (10MB for
# `/stacktrace` values).
#
# Some predefined label keys exist, or you may create your own. When creating
# your own, we recommend the following formats:
#
# * `/category/product/key` for agents of well-known products (e.g.
# `/db/mongodb/read_size`).
# * `short_host/path/key` for domain-specific keys (e.g.
# `foo.com/myproduct/bar`)
#
# Predefined labels include:
#
# * `/agent`
# * `/component`
# * `/error/message`
# * `/error/name`
# * `/http/client_city`
# * `/http/client_country`
# * `/http/client_protocol`
# * `/http/client_region`
# * `/http/host`
# * `/http/method`
# * `/http/path`
# * `/http/redirected_url`
# * `/http/request/size`
# * `/http/response/size`
# * `/http/route`
# * `/http/status_code`
# * `/http/url`
# * `/http/user_agent`
# * `/pid`
# * `/stacktrace`
# * `/tid`
"a_key": "A String",
},
"parentSpanId": "A String", # ID of the parent span, if any. Optional.
"startTime": "A String", # Start time of the span in nanoseconds from the UNIX epoch.
"spanId": "A String", # Identifier for the span. Must be a 64-bit integer other than 0 and
# unique within a trace. For example, `2205310701640571284`.
"endTime": "A String", # End time of the span in nanoseconds from the UNIX epoch.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(projectId, orderBy=None, startTime=None, pageSize=None, x__xgafv=None, pageToken=None, filter=None, endTime=None, view=None)</code>
<pre>Returns of a list of traces that match the specified filter conditions.
Args:
projectId: string, ID of the Cloud project where the trace data is stored. (required)
orderBy: string, Field used to sort the returned traces. Optional.
Can be one of the following:
* `trace_id`
* `name` (`name` field of root span in the trace)
* `duration` (difference between `end_time` and `start_time` fields of
the root span)
* `start` (`start_time` field of the root span)
Descending order can be specified by appending `desc` to the sort field
(for example, `name desc`).
Only one sort field is permitted.
startTime: string, Start of the time interval (inclusive) during which the trace data was
collected from the application.
pageSize: integer, Maximum number of traces to return. If not specified or <= 0, the
implementation selects a reasonable value. The implementation may
return fewer traces than the requested page size. Optional.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
pageToken: string, Token identifying the page of results to return. If provided, use the
value of the `next_page_token` field from a previous request. Optional.
filter: string, An optional filter against labels for the request.
By default, searches use prefix matching. To specify exact match, prepend
a plus symbol (`+`) to the search term.
Multiple terms are ANDed. Syntax:
* `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root
span starts with `NAME_PREFIX`.
* `+root:NAME` or `+NAME`: Return traces where any root span's name is
exactly `NAME`.
* `span:NAME_PREFIX`: Return traces where any span starts with
`NAME_PREFIX`.
* `+span:NAME`: Return traces where any span's name is exactly
`NAME`.
* `latency:DURATION`: Return traces whose overall latency is
greater or equal to than `DURATION`. Accepted units are nanoseconds
(`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For
example, `latency:24ms` returns traces whose overall latency
is greater than or equal to 24 milliseconds.
* `label:LABEL_KEY`: Return all traces containing the specified
label key (exact match, case-sensitive) regardless of the key:value
pair's value (including empty values).
* `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified
label key (exact match, case-sensitive) whose value starts with
`VALUE_PREFIX`. Both a key and a value must be specified.
* `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair
exactly matching the specified text. Both a key and a value must be
specified.
* `method:VALUE`: Equivalent to `/http/method:VALUE`.
* `url:VALUE`: Equivalent to `/http/url:VALUE`.
endTime: string, End of the time interval (inclusive) during which the trace data was
collected from the application.
view: string, Type of data returned for traces in the list. Optional. Default is
`MINIMAL`.
Returns:
An object of the form:
{ # The response message for the `ListTraces` method.
"nextPageToken": "A String", # If defined, indicates that there are more traces that match the request
# and that this value should be passed to the next request to continue
# retrieving additional traces.
"traces": [ # List of trace records as specified by the view parameter.
{ # A trace describes how long it takes for an application to perform an
# operation. It consists of a set of spans, each of which represent a single
# timed event within the operation.
"projectId": "A String", # Project ID of the Cloud project where the trace data is stored.
"traceId": "A String", # Globally unique identifier for the trace. This identifier is a 128-bit
# numeric value formatted as a 32-byte hex string. For example,
# `382d4f4c6b7bb2f4a972559d9085001d`.
"spans": [ # Collection of spans in the trace.
{ # A span represents a single timed event within a trace. Spans can be nested
# and form a trace tree. Often, a trace contains a root span that describes the
# end-to-end latency of an operation and, optionally, one or more subspans for
# its suboperations. Spans do not need to be contiguous. There may be gaps
# between spans in a trace.
"kind": "A String", # Distinguishes between spans generated in a particular context. For example,
# two spans with the same name may be distinguished using `RPC_CLIENT`
# and `RPC_SERVER` to identify queueing latency associated with the span.
"name": "A String", # Name of the span. Must be less than 128 bytes. The span name is sanitized
# and displayed in the Stackdriver Trace tool in the
# Google Cloud Platform Console.
# The name may be a method name or some other per-call site name.
# For the same executable and the same call point, a best practice is
# to use a consistent name, which makes it easier to correlate
# cross-trace spans.
"labels": { # Collection of labels associated with the span. Label keys must be less than
# 128 bytes. Label values must be less than 16 kilobytes (10MB for
# `/stacktrace` values).
#
# Some predefined label keys exist, or you may create your own. When creating
# your own, we recommend the following formats:
#
# * `/category/product/key` for agents of well-known products (e.g.
# `/db/mongodb/read_size`).
# * `short_host/path/key` for domain-specific keys (e.g.
# `foo.com/myproduct/bar`)
#
# Predefined labels include:
#
# * `/agent`
# * `/component`
# * `/error/message`
# * `/error/name`
# * `/http/client_city`
# * `/http/client_country`
# * `/http/client_protocol`
# * `/http/client_region`
# * `/http/host`
# * `/http/method`
# * `/http/path`
# * `/http/redirected_url`
# * `/http/request/size`
# * `/http/response/size`
# * `/http/route`
# * `/http/status_code`
# * `/http/url`
# * `/http/user_agent`
# * `/pid`
# * `/stacktrace`
# * `/tid`
"a_key": "A String",
},
"parentSpanId": "A String", # ID of the parent span, if any. Optional.
"startTime": "A String", # Start time of the span in nanoseconds from the UNIX epoch.
"spanId": "A String", # Identifier for the span. Must be a 64-bit integer other than 0 and
# unique within a trace. For example, `2205310701640571284`.
"endTime": "A String", # End time of the span in nanoseconds from the UNIX epoch.
},
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
