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