Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / cloudtrace_v1.projects.html
blob: fba8f4a88c074cf70e513e3239ee973a22e0e682 [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
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]75<h1><a href="cloudtrace_v1.html">Cloud Trace API</a> . <a href="cloudtrace_v1.projects.html">projects</a></h1>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="cloudtrace_v1.projects.traces.html">traces()</a></code>
79</p>
80<p class="firstline">Returns the traces Resource.</p>
81
82<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]83 <code><a href="#patchTraces">patchTraces(projectId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]84<p class="firstline">Sends new traces to Cloud Trace or updates existing traces. If the ID</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]85<h3>Method Details</h3>
86<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]87 <code class="details" id="patchTraces">patchTraces(projectId, body=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]88 <pre>Sends new traces to Cloud Trace or updates existing traces. If the ID
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]89of a trace that you send matches that of an existing trace, any fields
90in the existing trace and its spans are overwritten by the provided values,
91and any new fields provided are merged with the existing trace data. If the
92ID does not match, a new trace is created.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]93
94Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]95 projectId: string, Required. ID of the Cloud project where the trace data is stored. (required)
96 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]97 The object takes the form of:
98
99{ # List of new or updated traces.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]100 &quot;traces&quot;: [ # List of traces.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]101 { # A trace describes how long it takes for an application to perform an
102 # operation. It consists of a set of spans, each of which represent a single
103 # timed event within the operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]104 &quot;projectId&quot;: &quot;A String&quot;, # Project ID of the Cloud project where the trace data is stored.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]105 &quot;traceId&quot;: &quot;A String&quot;, # Globally unique identifier for the trace. This identifier is a 128-bit
106 # numeric value formatted as a 32-byte hex string. For example,
107 # `382d4f4c6b7bb2f4a972559d9085001d`. The numeric value should not be zero.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]108 &quot;spans&quot;: [ # Collection of spans in the trace.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]109 { # A span represents a single timed event within a trace. Spans can be nested
110 # and form a trace tree. Often, a trace contains a root span that describes the
111 # end-to-end latency of an operation and, optionally, one or more subspans for
112 # its suboperations. Spans do not need to be contiguous. There may be gaps
113 # between spans in a trace.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]114 &quot;spanId&quot;: &quot;A String&quot;, # Identifier for the span. Must be a 64-bit integer other than 0 and
115 # unique within a trace. For example, `2205310701640571284`.
116 &quot;kind&quot;: &quot;A String&quot;, # Distinguishes between spans generated in a particular context. For example,
117 # two spans with the same name may be distinguished using `RPC_CLIENT`
118 # and `RPC_SERVER` to identify queueing latency associated with the span.
119 &quot;startTime&quot;: &quot;A String&quot;, # Start time of the span in nanoseconds from the UNIX epoch.
120 &quot;name&quot;: &quot;A String&quot;, # Name of the span. Must be less than 128 bytes. The span name is sanitized
121 # and displayed in the Trace tool in the Google Cloud Platform Console.
122 # The name may be a method name or some other per-call site name.
123 # For the same executable and the same call point, a best practice is
124 # to use a consistent name, which makes it easier to correlate
125 # cross-trace spans.
126 &quot;endTime&quot;: &quot;A String&quot;, # End time of the span in nanoseconds from the UNIX epoch.
127 &quot;parentSpanId&quot;: &quot;A String&quot;, # Optional. ID of the parent span, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]128 &quot;labels&quot;: { # Collection of labels associated with the span. Label keys must be less than
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]129 # 128 bytes. Label values must be less than 16 kilobytes (10MB for
130 # `/stacktrace` values).
131 #
132 # Some predefined label keys exist, or you may create your own. When creating
133 # your own, we recommend the following formats:
134 #
135 # * `/category/product/key` for agents of well-known products (e.g.
136 # `/db/mongodb/read_size`).
137 # * `short_host/path/key` for domain-specific keys (e.g.
138 # `foo.com/myproduct/bar`)
139 #
140 # Predefined labels include:
141 #
142 # * `/agent`
143 # * `/component`
144 # * `/error/message`
145 # * `/error/name`
146 # * `/http/client_city`
147 # * `/http/client_country`
148 # * `/http/client_protocol`
149 # * `/http/client_region`
150 # * `/http/host`
151 # * `/http/method`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]152 # * `/http/path`
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]153 # * `/http/redirected_url`
154 # * `/http/request/size`
155 # * `/http/response/size`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156 # * `/http/route`
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]157 # * `/http/status_code`
158 # * `/http/url`
159 # * `/http/user_agent`
160 # * `/pid`
161 # * `/stacktrace`
162 # * `/tid`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]163 &quot;a_key&quot;: &quot;A String&quot;,
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]164 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]165 },
166 ],
167 },
168 ],
169 }
170
171 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]172 Allowed values
173 1 - v1 error format
174 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]175
176Returns:
177 An object of the form:
178
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]179 { # A generic empty message that you can re-use to avoid defining duplicated
180 # empty messages in your APIs. A typical example is to use it as the request
181 # or the response type of an API method. For instance:
182 #
183 # service Foo {
184 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
185 # }
186 #
187 # The JSON representation for `Empty` is empty JSON object `{}`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]188 }</pre>
189</div>
190
191</body></html>