Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 860a6378c538d8e2e424c7be150b41ba28120387 / . / docs / dyn / cloudtrace_v1.projects.traces.html
blob: 780a3a542ecf1796f0d0221f72371bda8f086e27 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]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_v1.html">Google Cloud Trace API</a> . <a href="cloudtrace_v1.projects.html">projects</a> . <a href="cloudtrace_v1.projects.traces.html">traces</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(projectId, traceId, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets a single trace by its ID.</p>
80<p class="toc_element">
81 <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>
82<p class="firstline">Returns of a list of traces that match the specified filter conditions.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(projectId, traceId, x__xgafv=None)</code>
89 <pre>Gets a single trace by its ID.
90
91Args:
92 projectId: string, ID of the Cloud project where the trace data is stored. (required)
93 traceId: string, ID of the trace to return. (required)
94 x__xgafv: string, V1 error format.
95
96Returns:
97 An object of the form:
98
99 { # 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.
100 "projectId": "A String", # Project ID of the Cloud project where the trace data is stored.
101 "traceId": "A String", # Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string.
102 "spans": [ # Collection of spans in the trace.
103 { # 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.
104 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]105 "name": "A String", # Name of the trace. The trace name is sanitized and displayed in the Stackdriver Trace tool in the {% dynamic print site_values.console_name %}. 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]106 "labels": { # Collection of labels associated with the span.
107 "a_key": "A String",
108 },
109 "parentSpanId": "A String", # ID of the parent span, if any. Optional.
110 "startTime": "A String", # Start time of the span in nanoseconds from the UNIX epoch.
111 "spanId": "A String", # Identifier for the span. This identifier must be unique within a trace.
112 "endTime": "A String", # End time of the span in nanoseconds from the UNIX epoch.
113 },
114 ],
115 }</pre>
116</div>
117
118<div class="method">
119 <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>
120 <pre>Returns of a list of traces that match the specified filter conditions.
121
122Args:
123 projectId: string, ID of the Cloud project where the trace data is stored. (required)
124 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.
125 startTime: string, End of the time interval (inclusive) during which the trace data was collected from the application.
126 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.
127 x__xgafv: string, V1 error format.
128 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.
129 filter: string, An optional filter for the request.
130 endTime: string, Start of the time interval (inclusive) during which the trace data was collected from the application.
131 view: string, Type of data returned for traces in the list. Optional. Default is `MINIMAL`.
132
133Returns:
134 An object of the form:
135
136 { # The response message for the `ListTraces` method.
137 "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.
138 "traces": [ # List of trace records returned.
139 { # 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.
140 "projectId": "A String", # Project ID of the Cloud project where the trace data is stored.
141 "traceId": "A String", # Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string.
142 "spans": [ # Collection of spans in the trace.
143 { # 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.
144 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]145 "name": "A String", # Name of the trace. The trace name is sanitized and displayed in the Stackdriver Trace tool in the {% dynamic print site_values.console_name %}. 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]146 "labels": { # Collection of labels associated with the span.
147 "a_key": "A String",
148 },
149 "parentSpanId": "A String", # ID of the parent span, if any. Optional.
150 "startTime": "A String", # Start time of the span in nanoseconds from the UNIX epoch.
151 "spanId": "A String", # Identifier for the span. This identifier must be unique within a trace.
152 "endTime": "A String", # End time of the span in nanoseconds from the UNIX epoch.
153 },
154 ],
155 },
156 ],
157 }</pre>
158</div>
159
160<div class="method">
161 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
162 <pre>Retrieves the next page of results.
163
164Args:
165 previous_request: The request for the previous page. (required)
166 previous_response: The response from the request for the previous page. (required)
167
168Returns:
169 A request object that you can call 'execute()' on to request the next
170 page. Returns None if there are no more items in the collection.
171 </pre>
172</div>
173
174</body></html>