OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/trace.append": { | 5 "https://www.googleapis.com/auth/trace.append": { |
6 "description": "Write Trace data for a project or applicatio
n" | 6 "description": "Write Trace data for a project or applicatio
n" |
7 }, | 7 }, |
8 "https://www.googleapis.com/auth/cloud-platform": { | 8 "https://www.googleapis.com/auth/cloud-platform": { |
9 "description": "View and manage your data across Google Clou
d Platform services" | 9 "description": "View and manage your data across Google Clou
d Platform services" |
10 }, | 10 }, |
(...skipping 13 matching lines...) Expand all Loading... |
24 "icons": { | 24 "icons": { |
25 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 25 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
26 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 26 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
27 }, | 27 }, |
28 "id": "tracing:v2", | 28 "id": "tracing:v2", |
29 "kind": "discovery#restDescription", | 29 "kind": "discovery#restDescription", |
30 "name": "tracing", | 30 "name": "tracing", |
31 "ownerDomain": "google.com", | 31 "ownerDomain": "google.com", |
32 "ownerName": "Google", | 32 "ownerName": "Google", |
33 "parameters": { | 33 "parameters": { |
34 "key": { | |
35 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | |
36 "location": "query", | |
37 "type": "string" | |
38 }, | |
39 "access_token": { | |
40 "description": "OAuth access token.", | |
41 "location": "query", | |
42 "type": "string" | |
43 }, | |
44 "quotaUser": { | 34 "quotaUser": { |
45 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | 35 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
46 "location": "query", | 36 "location": "query", |
47 "type": "string" | 37 "type": "string" |
48 }, | 38 }, |
49 "pp": { | 39 "pp": { |
50 "default": "true", | 40 "default": "true", |
51 "description": "Pretty-print response.", | 41 "description": "Pretty-print response.", |
52 "location": "query", | 42 "location": "query", |
53 "type": "boolean" | 43 "type": "boolean" |
(...skipping 55 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
109 "media", | 99 "media", |
110 "proto" | 100 "proto" |
111 ], | 101 ], |
112 "enumDescriptions": [ | 102 "enumDescriptions": [ |
113 "Responses with Content-Type of application/json", | 103 "Responses with Content-Type of application/json", |
114 "Media download with context-dependent Content-Type", | 104 "Media download with context-dependent Content-Type", |
115 "Responses with Content-Type of application/x-protobuf" | 105 "Responses with Content-Type of application/x-protobuf" |
116 ], | 106 ], |
117 "location": "query", | 107 "location": "query", |
118 "type": "string" | 108 "type": "string" |
| 109 }, |
| 110 "key": { |
| 111 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 112 "location": "query", |
| 113 "type": "string" |
| 114 }, |
| 115 "access_token": { |
| 116 "description": "OAuth access token.", |
| 117 "location": "query", |
| 118 "type": "string" |
119 } | 119 } |
120 }, | 120 }, |
121 "protocol": "rest", | 121 "protocol": "rest", |
122 "resources": { | 122 "resources": { |
123 "projects": { | 123 "projects": { |
124 "resources": { | 124 "resources": { |
125 "traces": { | 125 "traces": { |
126 "methods": { | 126 "methods": { |
| 127 "batchWrite": { |
| 128 "description": "Sends new spans to Stackdriver Trace
or updates existing traces. If the\nname of a trace that you send matches that
of an existing trace, new spans\nare added to the existing trace. Attempt to upd
ate existing spans results\nundefined behavior. If the name does not match, a ne
w trace is created\nwith given set of spans.", |
| 129 "httpMethod": "POST", |
| 130 "id": "tracing.projects.traces.batchWrite", |
| 131 "parameterOrder": [ |
| 132 "name" |
| 133 ], |
| 134 "parameters": { |
| 135 "name": { |
| 136 "description": "Name of the project where th
e spans belong to. Format is\n`projects/PROJECT_ID`.", |
| 137 "location": "path", |
| 138 "pattern": "^projects/[^/]+$", |
| 139 "required": true, |
| 140 "type": "string" |
| 141 } |
| 142 }, |
| 143 "path": "v2/{+name}/traces:batchWrite", |
| 144 "request": { |
| 145 "$ref": "BatchWriteSpansRequest" |
| 146 }, |
| 147 "response": { |
| 148 "$ref": "Empty" |
| 149 }, |
| 150 "scopes": [ |
| 151 "https://www.googleapis.com/auth/cloud-platform"
, |
| 152 "https://www.googleapis.com/auth/trace.append" |
| 153 ] |
| 154 }, |
127 "listSpans": { | 155 "listSpans": { |
128 "description": "Returns a list of spans within a tra
ce.", | 156 "description": "Returns a list of spans within a tra
ce.", |
129 "httpMethod": "GET", | 157 "httpMethod": "GET", |
130 "id": "tracing.projects.traces.listSpans", | 158 "id": "tracing.projects.traces.listSpans", |
131 "parameterOrder": [ | 159 "parameterOrder": [ |
132 "parent" | 160 "parent" |
133 ], | 161 ], |
134 "parameters": { | 162 "parameters": { |
135 "pageToken": { | 163 "pageToken": { |
136 "description": "Token identifying the page o
f results to return. If provided, use the\nvalue of the `nextPageToken` field fr
om a previous request. Optional.", | 164 "description": "Token identifying the page o
f results to return. If provided, use the\nvalue of the `nextPageToken` field fr
om a previous request. Optional.", |
(...skipping 18 matching lines...) Expand all Loading... |
155 ] | 183 ] |
156 }, | 184 }, |
157 "list": { | 185 "list": { |
158 "description": "Returns of a list of traces that mat
ch the specified filter conditions.", | 186 "description": "Returns of a list of traces that mat
ch the specified filter conditions.", |
159 "httpMethod": "GET", | 187 "httpMethod": "GET", |
160 "id": "tracing.projects.traces.list", | 188 "id": "tracing.projects.traces.list", |
161 "parameterOrder": [ | 189 "parameterOrder": [ |
162 "parent" | 190 "parent" |
163 ], | 191 ], |
164 "parameters": { | 192 "parameters": { |
| 193 "orderBy": { |
| 194 "description": "Field used to sort the retur
ned traces. Optional.\nCan be one of the following:\n\n* `trace_id`\n* `name
` (`name` field of root span in the trace)\n* `duration` (difference between `
end_time` and `start_time` fields of\n the root span)\n* `start` (`start_t
ime` field of the root span)\n\nDescending order can be specified by appending `
desc` to the sort field\n(for example, `name desc`).\n\nOnly one sort field is p
ermitted.", |
| 195 "location": "query", |
| 196 "type": "string" |
| 197 }, |
165 "filter": { | 198 "filter": { |
166 "description": "An optional filter for the r
equest.\nExample:\n`version_label_key:a some_label:some_label_key`\nreturns trac
es from version `a` and has `some_label` with `some_label_key`.", | 199 "description": "An optional filter for the r
equest.\nExample:\n`version_label_key:a some_label:some_label_key`\nreturns trac
es from version `a` and has `some_label` with `some_label_key`.", |
167 "location": "query", | 200 "location": "query", |
168 "type": "string" | 201 "type": "string" |
169 }, | 202 }, |
170 "endTime": { | 203 "endTime": { |
171 "description": "End of the time interval (in
clusive) during which the trace data was\ncollected from the application.", | 204 "description": "End of the time interval (in
clusive) during which the trace data was\ncollected from the application.", |
172 "format": "google-datetime", | 205 "format": "google-datetime", |
173 "location": "query", | 206 "location": "query", |
174 "type": "string" | 207 "type": "string" |
(...skipping 14 matching lines...) Expand all Loading... |
189 "format": "int32", | 222 "format": "int32", |
190 "location": "query", | 223 "location": "query", |
191 "type": "integer" | 224 "type": "integer" |
192 }, | 225 }, |
193 "parent": { | 226 "parent": { |
194 "description": "ID of the Cloud project wher
e the trace data is stored which is\n`projects/PROJECT_ID`.", | 227 "description": "ID of the Cloud project wher
e the trace data is stored which is\n`projects/PROJECT_ID`.", |
195 "location": "path", | 228 "location": "path", |
196 "pattern": "^projects/[^/]+$", | 229 "pattern": "^projects/[^/]+$", |
197 "required": true, | 230 "required": true, |
198 "type": "string" | 231 "type": "string" |
199 }, | |
200 "orderBy": { | |
201 "description": "Field used to sort the retur
ned traces. Optional.\nCan be one of the following:\n\n* `trace_id`\n* `name
` (`name` field of root span in the trace)\n* `duration` (difference between `
end_time` and `start_time` fields of\n the root span)\n* `start` (`start_t
ime` field of the root span)\n\nDescending order can be specified by appending `
desc` to the sort field\n(for example, `name desc`).\n\nOnly one sort field is p
ermitted.", | |
202 "location": "query", | |
203 "type": "string" | |
204 } | 232 } |
205 }, | 233 }, |
206 "path": "v2/{+parent}/traces", | 234 "path": "v2/{+parent}/traces", |
207 "response": { | 235 "response": { |
208 "$ref": "ListTracesResponse" | 236 "$ref": "ListTracesResponse" |
209 }, | 237 }, |
210 "scopes": [ | 238 "scopes": [ |
211 "https://www.googleapis.com/auth/cloud-platform"
, | 239 "https://www.googleapis.com/auth/cloud-platform"
, |
212 "https://www.googleapis.com/auth/trace.readonly" | 240 "https://www.googleapis.com/auth/trace.readonly" |
213 ] | 241 ] |
214 }, | |
215 "batchWrite": { | |
216 "description": "Sends new spans to Stackdriver Trace
or updates existing traces. If the\nname of a trace that you send matches that
of an existing trace, new spans\nare added to the existing trace. Attempt to upd
ate existing spans results\nundefined behavior. If the name does not match, a ne
w trace is created\nwith given set of spans.", | |
217 "httpMethod": "POST", | |
218 "id": "tracing.projects.traces.batchWrite", | |
219 "parameterOrder": [ | |
220 "name" | |
221 ], | |
222 "parameters": { | |
223 "name": { | |
224 "description": "Name of the project where th
e spans belong to. Format is\n`projects/PROJECT_ID`.", | |
225 "location": "path", | |
226 "pattern": "^projects/[^/]+$", | |
227 "required": true, | |
228 "type": "string" | |
229 } | |
230 }, | |
231 "path": "v2/{+name}/traces:batchWrite", | |
232 "request": { | |
233 "$ref": "BatchWriteSpansRequest" | |
234 }, | |
235 "response": { | |
236 "$ref": "Empty" | |
237 }, | |
238 "scopes": [ | |
239 "https://www.googleapis.com/auth/cloud-platform"
, | |
240 "https://www.googleapis.com/auth/trace.append" | |
241 ] | |
242 } | 242 } |
243 }, | 243 }, |
244 "resources": { | 244 "resources": { |
245 "spans": { | 245 "spans": { |
246 "methods": { | 246 "methods": { |
247 "create": { | 247 "create": { |
248 "description": "Creates a new Span.", | 248 "description": "Creates a new Span.", |
249 "httpMethod": "PUT", | 249 "httpMethod": "PUT", |
250 "id": "tracing.projects.traces.spans.create"
, | 250 "id": "tracing.projects.traces.spans.create"
, |
251 "parameterOrder": [ | 251 "parameterOrder": [ |
(...skipping 20 matching lines...) Expand all Loading... |
272 "https://www.googleapis.com/auth/trace.a
ppend" | 272 "https://www.googleapis.com/auth/trace.a
ppend" |
273 ] | 273 ] |
274 } | 274 } |
275 } | 275 } |
276 } | 276 } |
277 } | 277 } |
278 } | 278 } |
279 } | 279 } |
280 } | 280 } |
281 }, | 281 }, |
282 "revision": "20170516", | 282 "revision": "20170531", |
283 "rootUrl": "https://tracing.googleapis.com/", | 283 "rootUrl": "https://tracing.googleapis.com/", |
284 "schemas": { | 284 "schemas": { |
285 "Module": { | |
286 "description": "Binary module.", | |
287 "id": "Module", | |
288 "properties": { | |
289 "module": { | |
290 "$ref": "TruncatableString", | |
291 "description": "E.g. main binary, kernel modules, and dynami
c libraries\nsuch as libc.so, sharedlib.so (up to 256 characters)." | |
292 }, | |
293 "buildId": { | |
294 "$ref": "TruncatableString", | |
295 "description": "Build_id is a unique identifier for the modu
le, usually a hash of its\ncontents (up to 128 characters)." | |
296 } | |
297 }, | |
298 "type": "object" | |
299 }, | |
300 "Status": { | |
301 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes
if needed. The\nerror message should be a developer-facing English message tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\nerror message is needed, put the localized message in the error details or
\nlocalize it in the client. The optional error details may contain arbitrary\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` that can be used for common error conditions.\n\n# Lang
uage mapping\n\nThe `Status` message is the logical representation of the error
model, but it\nis not necessarily the actual wire format. When the `Status` mess
age is\nexposed in different client libraries and different wire protocols, it c
an be\nmapped differently. For example, it will likely be mapped to some excepti
ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n
\nThe error model and the `Status` message can be used in a variety of\nenvironm
ents, either with or without APIs, to provide a\nconsistent developer experience
across different environments.\n\nExample uses of this error model include:\n\n
- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m
ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a
client uses batch request and batch response, the\n `Status` message should
be used directly inside batch response, one for\n each error sub-response.\n\
n- Asynchronous operations. If an API call embeds asynchronous operation\n re
sults in its response, the status of those operations should be\n represented
directly using the `Status` message.\n\n- Logging. If some API errors are store
d in logs, the message `Status` could\n be used directly after any stripping
needed for security/privacy reasons.", | |
302 "id": "Status", | |
303 "properties": { | |
304 "code": { | |
305 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", | |
306 "format": "int32", | |
307 "type": "integer" | |
308 }, | |
309 "message": { | |
310 "description": "A developer-facing error message, which shou
ld be in English. Any\nuser-facing error message should be localized and sent in
the\ngoogle.rpc.Status.details field, or localized by the client.", | |
311 "type": "string" | |
312 }, | |
313 "details": { | |
314 "description": "A list of messages that carry the error deta
ils. There will be a\ncommon set of message types for APIs to use.", | |
315 "items": { | |
316 "additionalProperties": { | |
317 "description": "Properties of the object. Contains f
ield @type with type URL.", | |
318 "type": "any" | |
319 }, | |
320 "type": "object" | |
321 }, | |
322 "type": "array" | |
323 } | |
324 }, | |
325 "type": "object" | |
326 }, | |
327 "BatchWriteSpansRequest": { | |
328 "description": "The request message for the `BatchWriteSpans` method
.", | |
329 "id": "BatchWriteSpansRequest", | |
330 "properties": { | |
331 "spans": { | |
332 "description": "A collection of spans.", | |
333 "items": { | |
334 "$ref": "Span" | |
335 }, | |
336 "type": "array" | |
337 } | |
338 }, | |
339 "type": "object" | |
340 }, | |
341 "Empty": { | |
342 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", | |
343 "id": "Empty", | |
344 "properties": {}, | |
345 "type": "object" | |
346 }, | |
347 "Span": { | |
348 "description": "A span represents a single operation within a trace.
Spans can be nested\nto form a trace tree. Often, a trace contains a root span
that\ndescribes the end-to-end latency and, optionally, one or more subspans for
\nits sub-operations. (A trace could alternatively contain multiple root spans,\
nor none at all.) Spans do not need to be contiguous. There may be gaps\nand/or
overlaps between spans in a trace.", | |
349 "id": "Span", | |
350 "properties": { | |
351 "timeEvents": { | |
352 "$ref": "TimeEvents", | |
353 "description": "A maximum of 32 annotations and 128 network
events are allowed per Span." | |
354 }, | |
355 "status": { | |
356 "$ref": "Status", | |
357 "description": "An optional final status for this span." | |
358 }, | |
359 "name": { | |
360 "description": "The resource name of Span in the format\n`pr
ojects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID`.\n`TRACE_ID` is a unique identi
fier for a trace within a project and is a\nbase16-encoded, case-insensitive str
ing and is required to be 32 char long.\n`SPAN_ID` is a unique identifier for a
span within a trace. It is a\nbase 16-encoded, case-insensitive string of a 8-by
tes array and is required\nto be 16 char long.", | |
361 "type": "string" | |
362 }, | |
363 "stackTrace": { | |
364 "$ref": "StackTrace", | |
365 "description": "Stack trace captured at the start of the spa
n." | |
366 }, | |
367 "links": { | |
368 "$ref": "Links", | |
369 "description": "A maximum of 128 links are allowed per Span.
" | |
370 }, | |
371 "attributes": { | |
372 "$ref": "Attributes", | |
373 "description": "A set of attributes on the span. A maximum o
f 32 attributes are allowed per\nSpan." | |
374 }, | |
375 "spanId": { | |
376 "description": "Unique identifier for a span within a trace.
It is a base 16-encoded,\ncase-insensitive string of a 8-bytes array and is req
uired.", | |
377 "type": "string" | |
378 }, | |
379 "parentSpanId": { | |
380 "description": "ID of parent span which is a base 16-encoded
, case-insensitive string of\na 8-bytes array and is required to be 16 char long
. If this is a root span,\nthe value must be empty.", | |
381 "type": "string" | |
382 }, | |
383 "endTime": { | |
384 "description": "End time of the span.\nOn the client side, t
his is the local machine clock time at which the span\nexecution was ended; on t
he server\nside, this is the time at which the server application handler stoppe
d\nrunning.", | |
385 "format": "google-datetime", | |
386 "type": "string" | |
387 }, | |
388 "startTime": { | |
389 "description": "Start time of the span.\nOn the client side,
this is the local machine clock time at which the span\nexecution was started;
on the server\nside, this is the time at which the server application handler st
arted\nrunning.", | |
390 "format": "google-datetime", | |
391 "type": "string" | |
392 }, | |
393 "displayName": { | |
394 "$ref": "TruncatableString", | |
395 "description": "Description of the operation in the span. It
is sanitized and displayed in\nthe Stackdriver Trace tool in the\n{% dynamic pr
int site_values.console_name %}.\nThe display_name may be a method name or some
other per-call site\nname. For the same executable and the same call point, a be
st practice is\nto use a consistent operation name, which makes it easier to cor
relate\ncross-trace spans.\nThe maximum length for the display_name is 128 bytes
." | |
396 } | |
397 }, | |
398 "type": "object" | |
399 }, | |
400 "ListTracesResponse": { | |
401 "description": "The response message for the `ListTraces` method.", | |
402 "id": "ListTracesResponse", | |
403 "properties": { | |
404 "traces": { | |
405 "description": "List of trace records returned.", | |
406 "items": { | |
407 "$ref": "Trace" | |
408 }, | |
409 "type": "array" | |
410 }, | |
411 "nextPageToken": { | |
412 "description": "If defined, indicates that there are more tr
aces that match the request\nand that this value should be passed to the next re
quest to continue\nretrieving additional traces.", | |
413 "type": "string" | |
414 } | |
415 }, | |
416 "type": "object" | |
417 }, | |
418 "AttributeValue": { | |
419 "description": "The allowed types for the value side of an attribute
key:value pair.", | |
420 "id": "AttributeValue", | |
421 "properties": { | |
422 "intValue": { | |
423 "description": "An integer value.", | |
424 "format": "int64", | |
425 "type": "string" | |
426 }, | |
427 "stringValue": { | |
428 "$ref": "TruncatableString", | |
429 "description": "A string value (up to 256 bytes)." | |
430 }, | |
431 "boolValue": { | |
432 "description": "A boolean value.", | |
433 "type": "boolean" | |
434 } | |
435 }, | |
436 "type": "object" | |
437 }, | |
438 "Attributes": { | 285 "Attributes": { |
439 "description": "Attributes of a span with a key:value format.", | 286 "description": "Attributes of a span with a key:value format.", |
440 "id": "Attributes", | 287 "id": "Attributes", |
441 "properties": { | 288 "properties": { |
442 "droppedAttributesCount": { | 289 "droppedAttributesCount": { |
443 "description": "The number of dropped attributes after the m
aximum size was enforced. If\n0 then no attributes were dropped.", | 290 "description": "The number of dropped attributes after the m
aximum size was enforced. If\n0 then no attributes were dropped.", |
444 "format": "int32", | 291 "format": "int32", |
445 "type": "integer" | 292 "type": "integer" |
446 }, | 293 }, |
447 "attributeMap": { | 294 "attributeMap": { |
(...skipping 18 matching lines...) Expand all Loading... |
466 "type": "array" | 313 "type": "array" |
467 }, | 314 }, |
468 "droppedLinksCount": { | 315 "droppedLinksCount": { |
469 "description": "The number of dropped links after the maximu
m size was enforced. If\n0 then no links were dropped.", | 316 "description": "The number of dropped links after the maximu
m size was enforced. If\n0 then no links were dropped.", |
470 "format": "int32", | 317 "format": "int32", |
471 "type": "integer" | 318 "type": "integer" |
472 } | 319 } |
473 }, | 320 }, |
474 "type": "object" | 321 "type": "object" |
475 }, | 322 }, |
476 "StackTrace": { | |
477 "description": "StackTrace collected in a trace.", | |
478 "id": "StackTrace", | |
479 "properties": { | |
480 "stackTraceHashId": { | |
481 "description": "The hash ID is used to conserve network band
width for duplicate\nstack traces within a single trace.\n\nOften multiple spans
will have identical stack traces.\nThe first occurance of a stack trace should
contain both the\n`stackFrame` content and a value in `stackTraceHashId`.\n\nSub
sequent spans within the same request can refer\nto that stack trace by only set
ting `stackTraceHashId`.", | |
482 "format": "uint64", | |
483 "type": "string" | |
484 }, | |
485 "stackFrames": { | |
486 "$ref": "StackFrames", | |
487 "description": "Stack frames in this stack trace. A maximum
of 128 frames are allowed." | |
488 } | |
489 }, | |
490 "type": "object" | |
491 }, | |
492 "TruncatableString": { | 323 "TruncatableString": { |
493 "description": "Represents a string value that might be truncated.", | 324 "description": "Represents a string value that might be truncated.", |
494 "id": "TruncatableString", | 325 "id": "TruncatableString", |
495 "properties": { | 326 "properties": { |
496 "truncatedCharacterCount": { | 327 "truncatedCharacterCount": { |
497 "description": "The number of characters truncated from the
original string value. If 0 it\nmeans that the string value was not truncated.", | 328 "description": "The number of characters truncated from the
original string value. If 0 it\nmeans that the string value was not truncated.", |
498 "format": "int32", | 329 "format": "int32", |
499 "type": "integer" | 330 "type": "integer" |
500 }, | 331 }, |
501 "value": { | 332 "value": { |
502 "description": "The truncated string value. E.g. for a strin
g attribute this may have up to\n256 bytes.", | 333 "description": "The truncated string value. E.g. for a strin
g attribute this may have up to\n256 bytes.", |
503 "type": "string" | 334 "type": "string" |
504 } | 335 } |
505 }, | 336 }, |
506 "type": "object" | 337 "type": "object" |
507 }, | 338 }, |
| 339 "StackTrace": { |
| 340 "description": "StackTrace collected in a trace.", |
| 341 "id": "StackTrace", |
| 342 "properties": { |
| 343 "stackTraceHashId": { |
| 344 "description": "The hash ID is used to conserve network band
width for duplicate\nstack traces within a single trace.\n\nOften multiple spans
will have identical stack traces.\nThe first occurrence of a stack trace should
contain both the\n`stackFrame` content and a value in `stackTraceHashId`.\n\nSu
bsequent spans within the same request can refer\nto that stack trace by only se
tting `stackTraceHashId`.", |
| 345 "format": "uint64", |
| 346 "type": "string" |
| 347 }, |
| 348 "stackFrames": { |
| 349 "$ref": "StackFrames", |
| 350 "description": "Stack frames in this stack trace. A maximum
of 128 frames are allowed." |
| 351 } |
| 352 }, |
| 353 "type": "object" |
| 354 }, |
508 "TimeEvent": { | 355 "TimeEvent": { |
509 "description": "A time-stamped annotation in the Span.", | 356 "description": "A time-stamped annotation in the Span.", |
510 "id": "TimeEvent", | 357 "id": "TimeEvent", |
511 "properties": { | 358 "properties": { |
| 359 "time": { |
| 360 "description": "The timestamp indicating the time the event
occurred.", |
| 361 "format": "google-datetime", |
| 362 "type": "string" |
| 363 }, |
512 "networkEvent": { | 364 "networkEvent": { |
513 "$ref": "NetworkEvent", | 365 "$ref": "NetworkEvent", |
514 "description": "An event describing an RPC message sent/rece
ived on the network." | 366 "description": "An event describing an RPC message sent/rece
ived on the network." |
515 }, | 367 }, |
516 "annotation": { | 368 "annotation": { |
517 "$ref": "Annotation", | 369 "$ref": "Annotation", |
518 "description": "One or more key:value pairs." | 370 "description": "One or more key:value pairs." |
519 }, | |
520 "time": { | |
521 "description": "The timestamp indicating the time the event
occurred.", | |
522 "format": "google-datetime", | |
523 "type": "string" | |
524 } | 371 } |
525 }, | 372 }, |
526 "type": "object" | 373 "type": "object" |
527 }, | |
528 "ListSpansResponse": { | |
529 "description": "The response message for the `ListSpans` method.", | |
530 "id": "ListSpansResponse", | |
531 "properties": { | |
532 "spans": { | |
533 "description": "The requested spans if there are any in the
specified trace.", | |
534 "items": { | |
535 "$ref": "Span" | |
536 }, | |
537 "type": "array" | |
538 }, | |
539 "nextPageToken": { | |
540 "description": "If defined, indicates that there are more sp
ans that match the request.\nPass this as the value of `pageToken` in a subseque
nt request to retrieve\nadditional spans.", | |
541 "type": "string" | |
542 } | |
543 }, | |
544 "type": "object" | |
545 }, | 374 }, |
546 "NetworkEvent": { | 375 "NetworkEvent": { |
547 "description": "An event describing an RPC message sent/received on
the network. A\nmaximum of 128 network events are allowed per Span.", | 376 "description": "An event describing an RPC message sent/received on
the network. A\nmaximum of 128 network events are allowed per Span.", |
548 "id": "NetworkEvent", | 377 "id": "NetworkEvent", |
549 "properties": { | 378 "properties": { |
550 "messageSize": { | 379 "messageSize": { |
551 "description": "The number of bytes sent or received.", | 380 "description": "The number of bytes sent or received.", |
552 "format": "uint64", | 381 "format": "uint64", |
553 "type": "string" | 382 "type": "string" |
554 }, | 383 }, |
(...skipping 17 matching lines...) Expand all Loading... |
572 "type": "string" | 401 "type": "string" |
573 }, | 402 }, |
574 "messageId": { | 403 "messageId": { |
575 "description": "An identifier for the message, which must be
unique in this span.", | 404 "description": "An identifier for the message, which must be
unique in this span.", |
576 "format": "uint64", | 405 "format": "uint64", |
577 "type": "string" | 406 "type": "string" |
578 } | 407 } |
579 }, | 408 }, |
580 "type": "object" | 409 "type": "object" |
581 }, | 410 }, |
| 411 "ListSpansResponse": { |
| 412 "description": "The response message for the `ListSpans` method.", |
| 413 "id": "ListSpansResponse", |
| 414 "properties": { |
| 415 "nextPageToken": { |
| 416 "description": "If defined, indicates that there are more sp
ans that match the request.\nPass this as the value of `pageToken` in a subseque
nt request to retrieve\nadditional spans.", |
| 417 "type": "string" |
| 418 }, |
| 419 "spans": { |
| 420 "description": "The requested spans if there are any in the
specified trace.", |
| 421 "items": { |
| 422 "$ref": "Span" |
| 423 }, |
| 424 "type": "array" |
| 425 } |
| 426 }, |
| 427 "type": "object" |
| 428 }, |
582 "StackFrame": { | 429 "StackFrame": { |
583 "description": "Represents a single stack frame in a stack trace.", | 430 "description": "Represents a single stack frame in a stack trace.", |
584 "id": "StackFrame", | 431 "id": "StackFrame", |
585 "properties": { | 432 "properties": { |
586 "originalFunctionName": { | |
587 "$ref": "TruncatableString", | |
588 "description": "Used when the function name is\n[mangled](ht
tp://www.avabodh.com/cxxin/namemangling.html). May be\nfully-qualified (up to 10
24 characters)." | |
589 }, | |
590 "functionName": { | |
591 "$ref": "TruncatableString", | |
592 "description": "The fully-qualified name that uniquely ident
ifies this function or\nmethod (up to 1024 characters)." | |
593 }, | |
594 "lineNumber": { | 433 "lineNumber": { |
595 "description": "Line number of the frame.", | 434 "description": "Line number of the frame.", |
596 "format": "int64", | 435 "format": "int64", |
597 "type": "string" | 436 "type": "string" |
598 }, | 437 }, |
599 "loadModule": { | 438 "loadModule": { |
600 "$ref": "Module", | 439 "$ref": "Module", |
601 "description": "Binary module the code is loaded from." | 440 "description": "Binary module the code is loaded from." |
602 }, | 441 }, |
603 "columnNumber": { | 442 "columnNumber": { |
604 "description": "Column number is important in JavaScript (an
onymous functions).\nMay not be available in some languages.", | 443 "description": "Column number is important in JavaScript (an
onymous functions).\nMay not be available in some languages.", |
605 "format": "int64", | 444 "format": "int64", |
606 "type": "string" | 445 "type": "string" |
607 }, | 446 }, |
608 "fileName": { | 447 "fileName": { |
609 "$ref": "TruncatableString", | 448 "$ref": "TruncatableString", |
610 "description": "The filename of the file containing this fra
me (up to 256 characters)." | 449 "description": "The filename of the file containing this fra
me (up to 256 characters)." |
611 }, | 450 }, |
612 "sourceVersion": { | 451 "sourceVersion": { |
613 "$ref": "TruncatableString", | 452 "$ref": "TruncatableString", |
614 "description": "The version of the deployed source code (up
to 128 characters)." | 453 "description": "The version of the deployed source code (up
to 128 characters)." |
| 454 }, |
| 455 "originalFunctionName": { |
| 456 "$ref": "TruncatableString", |
| 457 "description": "Used when the function name is\n[mangled](ht
tp://www.avabodh.com/cxxin/namemangling.html). May be\nfully-qualified (up to 10
24 characters)." |
| 458 }, |
| 459 "functionName": { |
| 460 "$ref": "TruncatableString", |
| 461 "description": "The fully-qualified name that uniquely ident
ifies this function or\nmethod (up to 1024 characters)." |
615 } | 462 } |
616 }, | 463 }, |
617 "type": "object" | 464 "type": "object" |
618 }, | 465 }, |
619 "Link": { | 466 "Link": { |
620 "description": "A pointer from this span to another span in a differ
ent `Trace` within\nthe same service project or within a different service proje
ct. Used\n(for example) in batching operations, where a single batch handler\npr
ocesses multiple requests from different traces or when receives a\nrequest from
a different service project.", | 467 "description": "A pointer from this span to another span in a differ
ent `Trace` within\nthe same service project or within a different service proje
ct. Used\n(for example) in batching operations, where a single batch handler\npr
ocesses multiple requests from different traces or when receives a\nrequest from
a different service project.", |
621 "id": "Link", | 468 "id": "Link", |
622 "properties": { | 469 "properties": { |
623 "type": { | 470 "type": { |
624 "description": "The relationship of the current span relativ
e to the linked span.", | 471 "description": "The relationship of the current span relativ
e to the linked span.", |
(...skipping 81 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
706 }, | 553 }, |
707 "type": "array" | 554 "type": "array" |
708 }, | 555 }, |
709 "droppedNetworkEventsCount": { | 556 "droppedNetworkEventsCount": { |
710 "description": "The number of dropped network events after t
he maximum size was enforced.\nIf 0 then no annotations were dropped.", | 557 "description": "The number of dropped network events after t
he maximum size was enforced.\nIf 0 then no annotations were dropped.", |
711 "format": "int32", | 558 "format": "int32", |
712 "type": "integer" | 559 "type": "integer" |
713 } | 560 } |
714 }, | 561 }, |
715 "type": "object" | 562 "type": "object" |
| 563 }, |
| 564 "Module": { |
| 565 "description": "Binary module.", |
| 566 "id": "Module", |
| 567 "properties": { |
| 568 "module": { |
| 569 "$ref": "TruncatableString", |
| 570 "description": "E.g. main binary, kernel modules, and dynami
c libraries\nsuch as libc.so, sharedlib.so (up to 256 characters)." |
| 571 }, |
| 572 "buildId": { |
| 573 "$ref": "TruncatableString", |
| 574 "description": "Build_id is a unique identifier for the modu
le, usually a hash of its\ncontents (up to 128 characters)." |
| 575 } |
| 576 }, |
| 577 "type": "object" |
| 578 }, |
| 579 "Status": { |
| 580 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes
if needed. The\nerror message should be a developer-facing English message tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\nerror message is needed, put the localized message in the error details or
\nlocalize it in the client. The optional error details may contain arbitrary\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` that can be used for common error conditions.\n\n# Lang
uage mapping\n\nThe `Status` message is the logical representation of the error
model, but it\nis not necessarily the actual wire format. When the `Status` mess
age is\nexposed in different client libraries and different wire protocols, it c
an be\nmapped differently. For example, it will likely be mapped to some excepti
ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n
\nThe error model and the `Status` message can be used in a variety of\nenvironm
ents, either with or without APIs, to provide a\nconsistent developer experience
across different environments.\n\nExample uses of this error model include:\n\n
- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m
ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a
client uses batch request and batch response, the\n `Status` message should
be used directly inside batch response, one for\n each error sub-response.\n\
n- Asynchronous operations. If an API call embeds asynchronous operation\n re
sults in its response, the status of those operations should be\n represented
directly using the `Status` message.\n\n- Logging. If some API errors are store
d in logs, the message `Status` could\n be used directly after any stripping
needed for security/privacy reasons.", |
| 581 "id": "Status", |
| 582 "properties": { |
| 583 "code": { |
| 584 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
| 585 "format": "int32", |
| 586 "type": "integer" |
| 587 }, |
| 588 "message": { |
| 589 "description": "A developer-facing error message, which shou
ld be in English. Any\nuser-facing error message should be localized and sent in
the\ngoogle.rpc.Status.details field, or localized by the client.", |
| 590 "type": "string" |
| 591 }, |
| 592 "details": { |
| 593 "description": "A list of messages that carry the error deta
ils. There will be a\ncommon set of message types for APIs to use.", |
| 594 "items": { |
| 595 "additionalProperties": { |
| 596 "description": "Properties of the object. Contains f
ield @type with type URL.", |
| 597 "type": "any" |
| 598 }, |
| 599 "type": "object" |
| 600 }, |
| 601 "type": "array" |
| 602 } |
| 603 }, |
| 604 "type": "object" |
| 605 }, |
| 606 "BatchWriteSpansRequest": { |
| 607 "description": "The request message for the `BatchWriteSpans` method
.", |
| 608 "id": "BatchWriteSpansRequest", |
| 609 "properties": { |
| 610 "spans": { |
| 611 "description": "A collection of spans.", |
| 612 "items": { |
| 613 "$ref": "Span" |
| 614 }, |
| 615 "type": "array" |
| 616 } |
| 617 }, |
| 618 "type": "object" |
| 619 }, |
| 620 "ListTracesResponse": { |
| 621 "description": "The response message for the `ListTraces` method.", |
| 622 "id": "ListTracesResponse", |
| 623 "properties": { |
| 624 "traces": { |
| 625 "description": "List of trace records returned.", |
| 626 "items": { |
| 627 "$ref": "Trace" |
| 628 }, |
| 629 "type": "array" |
| 630 }, |
| 631 "nextPageToken": { |
| 632 "description": "If defined, indicates that there are more tr
aces that match the request\nand that this value should be passed to the next re
quest to continue\nretrieving additional traces.", |
| 633 "type": "string" |
| 634 } |
| 635 }, |
| 636 "type": "object" |
| 637 }, |
| 638 "Span": { |
| 639 "description": "A span represents a single operation within a trace.
Spans can be nested\nto form a trace tree. Often, a trace contains a root span
that\ndescribes the end-to-end latency and, optionally, one or more subspans for
\nits sub-operations. (A trace could alternatively contain multiple root spans,\
nor none at all.) Spans do not need to be contiguous. There may be gaps\nand/or
overlaps between spans in a trace.", |
| 640 "id": "Span", |
| 641 "properties": { |
| 642 "parentSpanId": { |
| 643 "description": "ID of parent span which is a base 16-encoded
, case-insensitive string of\na 8-bytes array and is required to be 16 char long
. If this is a root span,\nthe value must be empty.", |
| 644 "type": "string" |
| 645 }, |
| 646 "endTime": { |
| 647 "description": "End time of the span.\nOn the client side, t
his is the local machine clock time at which the span\nexecution was ended; on t
he server\nside, this is the time at which the server application handler stoppe
d\nrunning.", |
| 648 "format": "google-datetime", |
| 649 "type": "string" |
| 650 }, |
| 651 "startTime": { |
| 652 "description": "Start time of the span.\nOn the client side,
this is the local machine clock time at which the span\nexecution was started;
on the server\nside, this is the time at which the server application handler st
arted\nrunning.", |
| 653 "format": "google-datetime", |
| 654 "type": "string" |
| 655 }, |
| 656 "displayName": { |
| 657 "$ref": "TruncatableString", |
| 658 "description": "Description of the operation in the span. It
is sanitized and displayed in\nthe Stackdriver Trace tool in the\n{% dynamic pr
int site_values.console_name %}.\nThe display_name may be a method name or some
other per-call site\nname. For the same executable and the same call point, a be
st practice is\nto use a consistent operation name, which makes it easier to cor
relate\ncross-trace spans.\nThe maximum length for the display_name is 128 bytes
." |
| 659 }, |
| 660 "timeEvents": { |
| 661 "$ref": "TimeEvents", |
| 662 "description": "A maximum of 32 annotations and 128 network
events are allowed per Span." |
| 663 }, |
| 664 "status": { |
| 665 "$ref": "Status", |
| 666 "description": "An optional final status for this span." |
| 667 }, |
| 668 "name": { |
| 669 "description": "The resource name of Span in the format\n`pr
ojects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID`.\n`TRACE_ID` is a unique identi
fier for a trace within a project and is a\nbase16-encoded, case-insensitive str
ing and is required to be 32 char long.\n`SPAN_ID` is a unique identifier for a
span within a trace. It is a\nbase 16-encoded, case-insensitive string of a 8-by
tes array and is required\nto be 16 char long.", |
| 670 "type": "string" |
| 671 }, |
| 672 "stackTrace": { |
| 673 "$ref": "StackTrace", |
| 674 "description": "Stack trace captured at the start of the spa
n." |
| 675 }, |
| 676 "links": { |
| 677 "$ref": "Links", |
| 678 "description": "A maximum of 128 links are allowed per Span.
" |
| 679 }, |
| 680 "attributes": { |
| 681 "$ref": "Attributes", |
| 682 "description": "A set of attributes on the span. A maximum o
f 32 attributes are allowed per\nSpan." |
| 683 }, |
| 684 "spanId": { |
| 685 "description": "Unique identifier for a span within a trace.
It is a base 16-encoded,\ncase-insensitive string of a 8-bytes array and is req
uired.", |
| 686 "type": "string" |
| 687 } |
| 688 }, |
| 689 "type": "object" |
| 690 }, |
| 691 "Empty": { |
| 692 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
| 693 "id": "Empty", |
| 694 "properties": {}, |
| 695 "type": "object" |
| 696 }, |
| 697 "AttributeValue": { |
| 698 "description": "The allowed types for the value side of an attribute
key:value pair.", |
| 699 "id": "AttributeValue", |
| 700 "properties": { |
| 701 "intValue": { |
| 702 "description": "An integer value.", |
| 703 "format": "int64", |
| 704 "type": "string" |
| 705 }, |
| 706 "stringValue": { |
| 707 "$ref": "TruncatableString", |
| 708 "description": "A string value (up to 256 bytes)." |
| 709 }, |
| 710 "boolValue": { |
| 711 "description": "A boolean value.", |
| 712 "type": "boolean" |
| 713 } |
| 714 }, |
| 715 "type": "object" |
716 } | 716 } |
717 }, | 717 }, |
718 "servicePath": "", | 718 "servicePath": "", |
719 "title": "Google Tracing API", | 719 "title": "Google Tracing API", |
720 "version": "v2" | 720 "version": "v2" |
721 } | 721 } |
OLD | NEW |