OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/trace.readonly": { | |
6 "description": "Read Trace data for a project or application
" | |
7 }, | |
8 "https://www.googleapis.com/auth/trace.append": { | 5 "https://www.googleapis.com/auth/trace.append": { |
9 "description": "Write Trace data for a project or applicatio
n" | 6 "description": "Write Trace data for a project or applicatio
n" |
10 }, | 7 }, |
11 "https://www.googleapis.com/auth/cloud-platform": { | 8 "https://www.googleapis.com/auth/cloud-platform": { |
12 "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 }, |
| 11 "https://www.googleapis.com/auth/trace.readonly": { |
| 12 "description": "Read Trace data for a project or application
" |
13 } | 13 } |
14 } | 14 } |
15 } | 15 } |
16 }, | 16 }, |
17 "basePath": "", | 17 "basePath": "", |
18 "baseUrl": "https://tracing.googleapis.com/", | 18 "baseUrl": "https://tracing.googleapis.com/", |
19 "batchPath": "batch", | 19 "batchPath": "batch", |
20 "canonicalName": "Tracing", | 20 "canonicalName": "Tracing", |
21 "description": "Send and retrieve trace data from Google Stackdriver Trace.\
n", | 21 "description": "Send and retrieve trace data from Google Stackdriver Trace.\
n", |
22 "discoveryVersion": "v1", | 22 "discoveryVersion": "v1", |
(...skipping 66 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
89 "proto" | 89 "proto" |
90 ], | 90 ], |
91 "enumDescriptions": [ | 91 "enumDescriptions": [ |
92 "Responses with Content-Type of application/json", | 92 "Responses with Content-Type of application/json", |
93 "Media download with context-dependent Content-Type", | 93 "Media download with context-dependent Content-Type", |
94 "Responses with Content-Type of application/x-protobuf" | 94 "Responses with Content-Type of application/x-protobuf" |
95 ], | 95 ], |
96 "location": "query", | 96 "location": "query", |
97 "type": "string" | 97 "type": "string" |
98 }, | 98 }, |
| 99 "access_token": { |
| 100 "description": "OAuth access token.", |
| 101 "location": "query", |
| 102 "type": "string" |
| 103 }, |
99 "key": { | 104 "key": { |
100 "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.", | 105 "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.", |
101 "location": "query", | 106 "location": "query", |
102 "type": "string" | 107 "type": "string" |
103 }, | 108 }, |
104 "access_token": { | |
105 "description": "OAuth access token.", | |
106 "location": "query", | |
107 "type": "string" | |
108 }, | |
109 "quotaUser": { | 109 "quotaUser": { |
110 "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.", | 110 "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.", |
111 "location": "query", | 111 "location": "query", |
112 "type": "string" | 112 "type": "string" |
113 }, | 113 }, |
114 "pp": { | 114 "pp": { |
115 "default": "true", | 115 "default": "true", |
116 "description": "Pretty-print response.", | 116 "description": "Pretty-print response.", |
117 "location": "query", | 117 "location": "query", |
118 "type": "boolean" | 118 "type": "boolean" |
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 "listSpans": { |
| 128 "description": "Returns a list of spans within a tra
ce.", |
| 129 "httpMethod": "GET", |
| 130 "id": "tracing.projects.traces.listSpans", |
| 131 "parameterOrder": [ |
| 132 "name" |
| 133 ], |
| 134 "parameters": { |
| 135 "name": { |
| 136 "description": "ID of the trace for which to
list child spans. Format is\n`projects/PROJECT_ID/traces/TRACE_ID`.", |
| 137 "location": "path", |
| 138 "pattern": "^projects/[^/]+/traces/[^/]+$", |
| 139 "required": true, |
| 140 "type": "string" |
| 141 }, |
| 142 "pageToken": { |
| 143 "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.", |
| 144 "location": "query", |
| 145 "type": "string" |
| 146 } |
| 147 }, |
| 148 "path": "v1/{+name}:listSpans", |
| 149 "response": { |
| 150 "$ref": "ListSpansResponse" |
| 151 }, |
| 152 "scopes": [ |
| 153 "https://www.googleapis.com/auth/cloud-platform"
, |
| 154 "https://www.googleapis.com/auth/trace.readonly" |
| 155 ] |
| 156 }, |
127 "list": { | 157 "list": { |
128 "description": "Returns of a list of traces that mat
ch the specified filter conditions.", | 158 "description": "Returns of a list of traces that mat
ch the specified filter conditions.", |
129 "httpMethod": "GET", | 159 "httpMethod": "GET", |
130 "id": "tracing.projects.traces.list", | 160 "id": "tracing.projects.traces.list", |
131 "parameterOrder": [ | 161 "parameterOrder": [ |
132 "parent" | 162 "parent" |
133 ], | 163 ], |
134 "parameters": { | 164 "parameters": { |
135 "pageSize": { | 165 "filter": { |
136 "description": "Maximum number of traces to
return. If not specified or <= 0, the\nimplementation selects a reasonable value
. The implementation may\nreturn fewer traces than the requested page size. Opt
ional.", | 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`.", |
137 "format": "int32", | |
138 "location": "query", | |
139 "type": "integer" | |
140 }, | |
141 "parent": { | |
142 "description": "ID of the Cloud project wher
e the trace data is stored.", | |
143 "location": "path", | |
144 "pattern": "^projects/[^/]+$", | |
145 "required": true, | |
146 "type": "string" | |
147 }, | |
148 "orderBy": { | |
149 "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.", | |
150 "location": "query", | 167 "location": "query", |
151 "type": "string" | 168 "type": "string" |
152 }, | 169 }, |
153 "filter": { | |
154 "description": "An optional filter for the r
equest.\nExample:\n\"version_label_key:a some_label:some_label_key\"\nreturns tr
aces from version a and has some_label with some_label_key.", | |
155 "location": "query", | |
156 "type": "string" | |
157 }, | |
158 "endTime": { | 170 "endTime": { |
159 "description": "End of the time interval (in
clusive) during which the trace data was\ncollected from the application.", | 171 "description": "End of the time interval (in
clusive) during which the trace data was\ncollected from the application.", |
160 "format": "google-datetime", | 172 "format": "google-datetime", |
161 "location": "query", | 173 "location": "query", |
162 "type": "string" | 174 "type": "string" |
163 }, | 175 }, |
| 176 "startTime": { |
| 177 "description": "Start of the time interval (
inclusive) during which the trace data was\ncollected from the application.", |
| 178 "format": "google-datetime", |
| 179 "location": "query", |
| 180 "type": "string" |
| 181 }, |
164 "pageToken": { | 182 "pageToken": { |
165 "description": "Token identifying the page o
f results to return. If provided, use the\nvalue of the `next_page_token` field
from a previous request. Optional.", | 183 "description": "Token identifying the page o
f results to return. If provided, use the\nvalue of the `next_page_token` field
from a previous request. Optional.", |
166 "location": "query", | 184 "location": "query", |
167 "type": "string" | 185 "type": "string" |
168 }, | 186 }, |
169 "startTime": { | 187 "pageSize": { |
170 "description": "Start of the time interval (
inclusive) during which the trace data was\ncollected from the application.", | 188 "description": "Maximum number of traces to
return. If not specified or <= 0, the\nimplementation selects a reasonable value
. The implementation may\nreturn fewer traces than the requested page size. Opti
onal.", |
171 "format": "google-datetime", | 189 "format": "int32", |
| 190 "location": "query", |
| 191 "type": "integer" |
| 192 }, |
| 193 "parent": { |
| 194 "description": "ID of the Cloud project wher
e the trace data is stored.", |
| 195 "location": "path", |
| 196 "pattern": "^projects/[^/]+$", |
| 197 "required": true, |
| 198 "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.", |
172 "location": "query", | 202 "location": "query", |
173 "type": "string" | 203 "type": "string" |
174 } | 204 } |
175 }, | 205 }, |
176 "path": "v1/{+parent}/traces", | 206 "path": "v1/{+parent}/traces", |
177 "response": { | 207 "response": { |
178 "$ref": "ListTracesResponse" | 208 "$ref": "ListTracesResponse" |
179 }, | 209 }, |
180 "scopes": [ | 210 "scopes": [ |
181 "https://www.googleapis.com/auth/cloud-platform"
, | 211 "https://www.googleapis.com/auth/cloud-platform"
, |
182 "https://www.googleapis.com/auth/trace.readonly" | 212 "https://www.googleapis.com/auth/trace.readonly" |
183 ] | 213 ] |
184 }, | 214 }, |
185 "get": { | 215 "get": { |
186 "description": "Returns a specific trace.", | 216 "description": "Returns a specific trace.", |
187 "httpMethod": "GET", | 217 "httpMethod": "GET", |
188 "id": "tracing.projects.traces.get", | 218 "id": "tracing.projects.traces.get", |
189 "parameterOrder": [ | 219 "parameterOrder": [ |
190 "name" | 220 "name" |
191 ], | 221 ], |
192 "parameters": { | 222 "parameters": { |
193 "name": { | 223 "name": { |
194 "description": "ID of the trace which is \"p
rojects/<project_id>/traces/<trace_id>\".", | 224 "description": "ID of the trace. Format is `
projects/PROJECT_ID/traces/TRACE_ID`.", |
195 "location": "path", | 225 "location": "path", |
196 "pattern": "^projects/[^/]+/traces/[^/]+$", | 226 "pattern": "^projects/[^/]+/traces/[^/]+$", |
197 "required": true, | 227 "required": true, |
198 "type": "string" | 228 "type": "string" |
199 } | 229 } |
200 }, | 230 }, |
201 "path": "v1/{+name}", | 231 "path": "v1/{+name}", |
202 "response": { | 232 "response": { |
203 "$ref": "Trace" | 233 "$ref": "Trace" |
204 }, | 234 }, |
(...skipping 22 matching lines...) Expand all Loading... |
227 "request": { | 257 "request": { |
228 "$ref": "BatchUpdateSpansRequest" | 258 "$ref": "BatchUpdateSpansRequest" |
229 }, | 259 }, |
230 "response": { | 260 "response": { |
231 "$ref": "Empty" | 261 "$ref": "Empty" |
232 }, | 262 }, |
233 "scopes": [ | 263 "scopes": [ |
234 "https://www.googleapis.com/auth/cloud-platform"
, | 264 "https://www.googleapis.com/auth/cloud-platform"
, |
235 "https://www.googleapis.com/auth/trace.append" | 265 "https://www.googleapis.com/auth/trace.append" |
236 ] | 266 ] |
237 }, | |
238 "listSpans": { | |
239 "description": "Returns a list of spans within a tra
ce.", | |
240 "httpMethod": "GET", | |
241 "id": "tracing.projects.traces.listSpans", | |
242 "parameterOrder": [ | |
243 "name" | |
244 ], | |
245 "parameters": { | |
246 "name": { | |
247 "description": "ID of the span set where is
\"projects/<project_id>/traces/<trace_id>\".", | |
248 "location": "path", | |
249 "pattern": "^projects/[^/]+/traces/[^/]+$", | |
250 "required": true, | |
251 "type": "string" | |
252 }, | |
253 "pageToken": { | |
254 "description": "Token identifying the page o
f results to return. If provided, use the\nvalue of the `page_token` field from
a previous request. Optional.", | |
255 "location": "query", | |
256 "type": "string" | |
257 } | |
258 }, | |
259 "path": "v1/{+name}:listSpans", | |
260 "response": { | |
261 "$ref": "ListSpansResponse" | |
262 }, | |
263 "scopes": [ | |
264 "https://www.googleapis.com/auth/cloud-platform"
, | |
265 "https://www.googleapis.com/auth/trace.readonly" | |
266 ] | |
267 } | 267 } |
268 } | 268 } |
269 } | 269 } |
270 } | 270 } |
271 } | 271 } |
272 }, | 272 }, |
273 "revision": "20170225", | 273 "revision": "20170320", |
274 "rootUrl": "https://tracing.googleapis.com/", | 274 "rootUrl": "https://tracing.googleapis.com/", |
275 "schemas": { | 275 "schemas": { |
| 276 "StackTrace": { |
| 277 "description": "StackTrace collected in a trace.", |
| 278 "id": "StackTrace", |
| 279 "properties": { |
| 280 "stackFrame": { |
| 281 "description": "Stack frames of this stack trace.", |
| 282 "items": { |
| 283 "$ref": "StackFrame" |
| 284 }, |
| 285 "type": "array" |
| 286 }, |
| 287 "stackTraceHashId": { |
| 288 "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`.", |
| 289 "format": "uint64", |
| 290 "type": "string" |
| 291 } |
| 292 }, |
| 293 "type": "object" |
| 294 }, |
| 295 "TimeEvent": { |
| 296 "description": "A time-stamped annotation in the Span.", |
| 297 "id": "TimeEvent", |
| 298 "properties": { |
| 299 "localTime": { |
| 300 "description": "The timestamp indicating the time the event
occurred.", |
| 301 "format": "google-datetime", |
| 302 "type": "string" |
| 303 }, |
| 304 "networkEvent": { |
| 305 "$ref": "NetworkEvent", |
| 306 "description": "An event describing an RPC message sent/rece
ived on the network." |
| 307 }, |
| 308 "annotation": { |
| 309 "$ref": "Annotation", |
| 310 "description": "One or more key:value pairs." |
| 311 } |
| 312 }, |
| 313 "type": "object" |
| 314 }, |
| 315 "NetworkEvent": { |
| 316 "description": "An event describing an RPC message sent/received on
the network.", |
| 317 "id": "NetworkEvent", |
| 318 "properties": { |
| 319 "kernelTime": { |
| 320 "description": "If available, this is the kernel time:\n\n*
For sent messages, this is the time at which the first bit was sent.\n* For re
ceived messages, this is the time at which the last bit was\n received.", |
| 321 "format": "google-datetime", |
| 322 "type": "string" |
| 323 }, |
| 324 "type": { |
| 325 "description": "Type of NetworkEvent. Indicates whether the
RPC message was sent or\nreceived.", |
| 326 "enum": [ |
| 327 "TYPE_UNSPECIFIED", |
| 328 "SENT", |
| 329 "RECV" |
| 330 ], |
| 331 "enumDescriptions": [ |
| 332 "Unknown event type.", |
| 333 "Indicates a sent RPC message.", |
| 334 "Indicates a received RPC message." |
| 335 ], |
| 336 "type": "string" |
| 337 }, |
| 338 "messageId": { |
| 339 "description": "An identifier for the message, which must be
unique in this span.", |
| 340 "format": "uint64", |
| 341 "type": "string" |
| 342 }, |
| 343 "messageSize": { |
| 344 "description": "The number of bytes sent or received.", |
| 345 "format": "uint64", |
| 346 "type": "string" |
| 347 } |
| 348 }, |
| 349 "type": "object" |
| 350 }, |
| 351 "ListSpansResponse": { |
| 352 "description": "The response message for the `ListSpans` method.", |
| 353 "id": "ListSpansResponse", |
| 354 "properties": { |
| 355 "nextPageToken": { |
| 356 "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.", |
| 357 "type": "string" |
| 358 }, |
| 359 "spans": { |
| 360 "description": "The requested spans if there are any in the
specified trace.", |
| 361 "items": { |
| 362 "$ref": "Span" |
| 363 }, |
| 364 "type": "array" |
| 365 } |
| 366 }, |
| 367 "type": "object" |
| 368 }, |
| 369 "SpanUpdates": { |
| 370 "description": "Collection of spans to update.", |
| 371 "id": "SpanUpdates", |
| 372 "properties": { |
| 373 "spans": { |
| 374 "description": "A collection of spans.", |
| 375 "items": { |
| 376 "$ref": "Span" |
| 377 }, |
| 378 "type": "array" |
| 379 } |
| 380 }, |
| 381 "type": "object" |
| 382 }, |
| 383 "StackFrame": { |
| 384 "description": "Represents a single stack frame in a stack trace.", |
| 385 "id": "StackFrame", |
| 386 "properties": { |
| 387 "fileName": { |
| 388 "description": "The filename of the file containing this fra
me.", |
| 389 "type": "string" |
| 390 }, |
| 391 "sourceVersion": { |
| 392 "description": "The version of the deployed source code.", |
| 393 "type": "string" |
| 394 }, |
| 395 "originalFunctionName": { |
| 396 "description": "Used when the function name is\n[mangled](ht
tp://www.avabodh.com/cxxin/namemangling.html). May be\nfully-qualified.", |
| 397 "type": "string" |
| 398 }, |
| 399 "functionName": { |
| 400 "description": "The fully-qualified name that uniquely ident
ifies this function or\nmethod.", |
| 401 "type": "string" |
| 402 }, |
| 403 "lineNumber": { |
| 404 "description": "Line number of the frame.", |
| 405 "format": "int64", |
| 406 "type": "string" |
| 407 }, |
| 408 "loadModule": { |
| 409 "$ref": "Module", |
| 410 "description": "Binary module the code is loaded from." |
| 411 }, |
| 412 "columnNumber": { |
| 413 "description": "Column number is important in JavaScript (an
onymous functions).\nMay not be available in some languages.", |
| 414 "format": "int64", |
| 415 "type": "string" |
| 416 } |
| 417 }, |
| 418 "type": "object" |
| 419 }, |
276 "Link": { | 420 "Link": { |
277 "description": "Link one span with another which may be in a differe
nt Trace. Used (for\nexample) in batching operations, where a single batch handl
er processes\nmultiple requests from different traces.", | 421 "description": "A pointer from this span to another span in a differ
ent `Trace`. Used\n(for example) in batching operations, where a single batch ha
ndler\nprocesses multiple requests from different traces.", |
278 "id": "Link", | 422 "id": "Link", |
279 "properties": { | 423 "properties": { |
| 424 "traceId": { |
| 425 "description": "The ID of the parent trace of the linked spa
n.", |
| 426 "type": "string" |
| 427 }, |
| 428 "spanId": { |
| 429 "description": "The `id` of the linked span.", |
| 430 "format": "uint64", |
| 431 "type": "string" |
| 432 }, |
280 "type": { | 433 "type": { |
281 "description": "The type of the link.", | 434 "description": "The relationship of the current span relativ
e to the linked span.", |
282 "enum": [ | 435 "enum": [ |
283 "TYPE_UNSPECIFIED", | 436 "TYPE_UNSPECIFIED", |
284 "CHILD", | 437 "CHILD", |
285 "PARENT" | 438 "PARENT" |
286 ], | 439 ], |
287 "enumDescriptions": [ | 440 "enumDescriptions": [ |
288 "The relation of current span and linked span is unknown
.", | 441 "The relationship of the two spans is unknown.", |
289 "Current span is child of the linked span.", | 442 "The current span is a child of the linked span.", |
290 "Current span is parent of the linked span." | 443 "The current span is the parent of the linked span." |
291 ], | 444 ], |
292 "type": "string" | 445 "type": "string" |
293 }, | |
294 "traceId": { | |
295 "description": "The trace identifier of the linked span.", | |
296 "type": "string" | |
297 }, | |
298 "spanId": { | |
299 "description": "The span identifier of the linked span.", | |
300 "format": "uint64", | |
301 "type": "string" | |
302 } | 446 } |
303 }, | 447 }, |
304 "type": "object" | 448 "type": "object" |
305 }, | 449 }, |
306 "Annotation": { | 450 "Annotation": { |
307 "description": "Text annotation with a set of attributes.", | 451 "description": "Text annotation with a set of attributes.", |
308 "id": "Annotation", | 452 "id": "Annotation", |
309 "properties": { | 453 "properties": { |
310 "description": { | 454 "description": { |
311 "description": "A user-supplied message describing the event
.", | 455 "description": "A user-supplied message describing the event
.", |
312 "type": "string" | 456 "type": "string" |
313 }, | 457 }, |
314 "attributes": { | 458 "attributes": { |
315 "additionalProperties": { | 459 "additionalProperties": { |
316 "$ref": "AttributeValue" | 460 "$ref": "AttributeValue" |
317 }, | 461 }, |
318 "description": "A set of attributes on the annotation.", | 462 "description": "A set of attributes on the annotation.", |
319 "type": "object" | 463 "type": "object" |
320 } | 464 } |
321 }, | 465 }, |
322 "type": "object" | 466 "type": "object" |
323 }, | 467 }, |
324 "Trace": { | 468 "Trace": { |
325 "description": "A trace describes how long it takes for an applicati
on to perform some\noperations. It consists of a set of spans, each of which con
tains details\nabout an operation with time information and operation details.", | 469 "description": "A trace describes how long it takes for an applicati
on to perform some\noperations. It consists of a set of spans, each representing
\nan operation and including time information and operation details.", |
326 "id": "Trace", | 470 "id": "Trace", |
327 "properties": { | 471 "properties": { |
328 "name": { | 472 "name": { |
329 "description": "ID of the trace which is \"projects/<project
_id>/traces/<trace_id>\".\ntrace_id is globally unique identifier for the trace.
Common to all the\nspans. It is conceptually a 128-bit hex-encoded value.", | 473 "description": "A globally unique identifier for the trace i
n the format\n`projects/PROJECT_NUMBER/traces/TRACE_ID`. `TRACE_ID` is a base16-
encoded\nstring of a 128-bit number and is required to be 32 char long.", |
330 "type": "string" | 474 "type": "string" |
331 } | 475 } |
332 }, | 476 }, |
333 "type": "object" | 477 "type": "object" |
334 }, | 478 }, |
335 "Module": { | 479 "Module": { |
336 "description": "Binary module.", | 480 "description": "Binary module.", |
337 "id": "Module", | 481 "id": "Module", |
338 "properties": { | 482 "properties": { |
| 483 "buildId": { |
| 484 "description": "Build_id is a unique identifier for the modu
le,\nusually a hash of its contents", |
| 485 "type": "string" |
| 486 }, |
339 "module": { | 487 "module": { |
340 "description": "E.g. main binary, kernel modules, and dynami
c libraries\nsuch as libc.so, sharedlib.so", | 488 "description": "E.g. main binary, kernel modules, and dynami
c libraries\nsuch as libc.so, sharedlib.so", |
341 "type": "string" | 489 "type": "string" |
342 }, | |
343 "buildId": { | |
344 "description": "Build_id is a unique identifier for the modu
le,\nusually a hash of its contents", | |
345 "type": "string" | |
346 } | 490 } |
347 }, | 491 }, |
348 "type": "object" | 492 "type": "object" |
349 }, | 493 }, |
350 "Status": { | 494 "Status": { |
351 "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` which can be used for common error conditions.\n\n# Lan
guage 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` mes
sage is\nexposed in different client libraries and different wire protocols, it
can be\nmapped differently. For example, it will likely be mapped to some except
ions\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\nenviron
ments, either with or without APIs, to provide a\nconsistent developer experienc
e 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
may\n have a `Status` message for error reporting purpose.\n\n- Batch operati
ons. If a client uses batch request and batch response, the\n `Status` messag
e should be used directly inside batch response, one for\n each error sub-res
ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio
n\n results in its response, the status of those operations should be\n re
presented directly using the `Status` message.\n\n- Logging. If some API errors
are stored in logs, the message `Status` could\n be used directly after any s
tripping needed for security/privacy reasons.", | 495 "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` which can be used for common error conditions.\n\n# Lan
guage 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` mes
sage is\nexposed in different client libraries and different wire protocols, it
can be\nmapped differently. For example, it will likely be mapped to some except
ions\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\nenviron
ments, either with or without APIs, to provide a\nconsistent developer experienc
e 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
may\n have a `Status` message for error reporting purpose.\n\n- Batch operati
ons. If a client uses batch request and batch response, the\n `Status` messag
e should be used directly inside batch response, one for\n each error sub-res
ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio
n\n results in its response, the status of those operations should be\n re
presented directly using the `Status` message.\n\n- Logging. If some API errors
are stored in logs, the message `Status` could\n be used directly after any s
tripping needed for security/privacy reasons.", |
352 "id": "Status", | 496 "id": "Status", |
353 "properties": { | 497 "properties": { |
354 "code": { | |
355 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", | |
356 "format": "int32", | |
357 "type": "integer" | |
358 }, | |
359 "message": { | 498 "message": { |
360 "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.", | 499 "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.", |
361 "type": "string" | 500 "type": "string" |
362 }, | 501 }, |
363 "details": { | 502 "details": { |
364 "description": "A list of messages that carry the error deta
ils. There will be a\ncommon set of message types for APIs to use.", | 503 "description": "A list of messages that carry the error deta
ils. There will be a\ncommon set of message types for APIs to use.", |
365 "items": { | 504 "items": { |
366 "additionalProperties": { | 505 "additionalProperties": { |
367 "description": "Properties of the object. Contains f
ield @type with type URL.", | 506 "description": "Properties of the object. Contains f
ield @type with type URL.", |
368 "type": "any" | 507 "type": "any" |
369 }, | 508 }, |
370 "type": "object" | 509 "type": "object" |
371 }, | 510 }, |
372 "type": "array" | 511 "type": "array" |
| 512 }, |
| 513 "code": { |
| 514 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
| 515 "format": "int32", |
| 516 "type": "integer" |
373 } | 517 } |
374 }, | 518 }, |
375 "type": "object" | 519 "type": "object" |
376 }, | 520 }, |
377 "ListTracesResponse": { | 521 "ListTracesResponse": { |
378 "description": "The response message for the `ListTraces` method.", | 522 "description": "The response message for the `ListTraces` method.", |
379 "id": "ListTracesResponse", | 523 "id": "ListTracesResponse", |
380 "properties": { | 524 "properties": { |
381 "traces": { | 525 "traces": { |
382 "description": "List of trace records returned.", | 526 "description": "List of trace records returned.", |
383 "items": { | 527 "items": { |
384 "$ref": "Trace" | 528 "$ref": "Trace" |
385 }, | 529 }, |
386 "type": "array" | 530 "type": "array" |
387 }, | 531 }, |
388 "nextPageToken": { | 532 "nextPageToken": { |
389 "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.", | 533 "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.", |
390 "type": "string" | 534 "type": "string" |
391 } | 535 } |
392 }, | 536 }, |
393 "type": "object" | 537 "type": "object" |
394 }, | 538 }, |
395 "Span": { | 539 "Span": { |
396 "description": "A span represents a single operation within a trace.
Spans can be nested\nand form a trace tree. Often, a trace contains a root span
that describes the\nend-to-end latency and, optionally, one or more subspans fo
r\nits sub-operations. Spans do not need to be contiguous. There may be gaps\nbe
tween spans in a trace.", | 540 "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.", |
397 "id": "Span", | 541 "id": "Span", |
398 "properties": { | 542 "properties": { |
| 543 "name": { |
| 544 "description": "Name of the span. The span name is sanitized
and displayed in the\nStackdriver Trace tool in the {% dynamic print site_value
s.console_name %}.\nThe name may be a method name or some other per-call site na
me.\nFor the same executable and the same call point, a best practice is\nto use
a consistent name, which makes it easier to correlate\ncross-trace spans.", |
| 545 "type": "string" |
| 546 }, |
399 "stackTrace": { | 547 "stackTrace": { |
400 "$ref": "StackTrace", | 548 "$ref": "StackTrace", |
401 "description": "Stack trace captured at the start of the spa
n. This is optional." | 549 "description": "Stack trace captured at the start of the spa
n." |
402 }, | 550 }, |
403 "links": { | 551 "links": { |
404 "description": "A collection of links.", | 552 "description": "A collection of links, which are references
from this span to another span\nin a different trace.", |
405 "items": { | 553 "items": { |
406 "$ref": "Link" | 554 "$ref": "Link" |
407 }, | 555 }, |
408 "type": "array" | 556 "type": "array" |
409 }, | 557 }, |
410 "attributes": { | 558 "attributes": { |
411 "additionalProperties": { | 559 "additionalProperties": { |
412 "$ref": "AttributeValue" | 560 "$ref": "AttributeValue" |
413 }, | 561 }, |
414 "description": "Properties of a span. Attributes at the span
level.\nE.g.\n\"/instance_id\": \"my-instance\"\n\"/zone\": \"us-central1-a\"\n
\"/grpc/peer_address\": \"ip:port\" (dns, etc.)\n\"/grpc/deadline\": \"Duration\
"\n\"/http/user_agent\"\n\"/http/request_bytes\": 300\n\"/http/response_bytes\":
1200\n\"/http/url\": google.com/apis\n\"/pid\"\n\"abc.com/myattribute\": \"my a
ttribute value\"\n\nMaximum length for attribute key is 128 characters, for stri
ng attribute\nvalue is 2K characters.", | 562 "description": "Properties of a span in key:value format. Th
e maximum length for the\nkey is 128 characters. The value can be a string (up t
o 2000 characters),\nint, or boolean.\n\nSome common pair examples:\n\n \"/in
stance_id\": \"my-instance\"\n \"/zone\": \"us-central1-a\"\n \"/grpc/peer
_address\": \"ip:port\" (dns, etc.)\n \"/grpc/deadline\": \"Duration\"\n \
"/http/user_agent\"\n \"/http/request_bytes\": 300\n \"/http/response_byte
s\": 1200\n \"/http/url\": google.com/apis\n \"abc.com/myattribute\": true
", |
415 "type": "object" | 563 "type": "object" |
416 }, | 564 }, |
417 "id": { | 565 "id": { |
418 "description": "Identifier for the span. Must be a 64-bit in
teger other than 0 and\nunique within a trace.", | 566 "description": "Identifier for the span. Must be a 64-bit in
teger other than 0 and\nunique within a trace.", |
419 "format": "uint64", | 567 "format": "uint64", |
420 "type": "string" | 568 "type": "string" |
421 }, | 569 }, |
422 "localStartTime": { | 570 "localStartTime": { |
423 "description": "Local machine clock time from the UNIX epoch
,\nat which span execution started.\nOn the server side these are the times when
the server application\nhandler starts running.", | 571 "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.", |
424 "format": "google-datetime", | 572 "format": "google-datetime", |
425 "type": "string" | 573 "type": "string" |
426 }, | 574 }, |
427 "hasRemoteParent": { | 575 "hasRemoteParent": { |
428 "description": "True if this Span has a remote parent (is an
RPC server Span).", | 576 "description": "True if this span has a remote parent (is an
RPC server span).", |
429 "type": "boolean" | 577 "type": "boolean" |
430 }, | 578 }, |
431 "localEndTime": { | |
432 "description": "Local machine clock time from the UNIX epoch
,\nat which span execution ended.\nOn the server side these are the times when t
he server application\nhandler finishes running.", | |
433 "format": "google-datetime", | |
434 "type": "string" | |
435 }, | |
436 "parentId": { | |
437 "description": "ID of parent span. 0 or missing if this is a
root span.", | |
438 "format": "uint64", | |
439 "type": "string" | |
440 }, | |
441 "timeEvents": { | 579 "timeEvents": { |
442 "description": "A collection of time-stamped events.", | 580 "description": "A collection of `TimeEvent`s. A `TimeEvent`
is a time-stamped annotation\non the span, consisting of either user-supplied ke
y:value pairs, or\ndetails of an RPC message sent/received on the network.", |
443 "items": { | 581 "items": { |
444 "$ref": "TimeEvent" | 582 "$ref": "TimeEvent" |
445 }, | 583 }, |
446 "type": "array" | 584 "type": "array" |
447 }, | 585 }, |
| 586 "localEndTime": { |
| 587 "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.", |
| 588 "format": "google-datetime", |
| 589 "type": "string" |
| 590 }, |
| 591 "parentId": { |
| 592 "description": "ID of the parent span. If this is a root spa
n, the value must be `0` or\nempty.", |
| 593 "format": "uint64", |
| 594 "type": "string" |
| 595 }, |
448 "status": { | 596 "status": { |
449 "$ref": "Status", | 597 "$ref": "Status", |
450 "description": "The final status of the Span. This is option
al." | 598 "description": "An optional final status for this span." |
451 }, | |
452 "name": { | |
453 "description": "Name of the span. The span name is sanitized
and displayed in the\nStackdriver Trace tool in the {% dynamic print site_value
s.console_name %}.\nThe name may be a method name or some other per-call site na
me.\nFor the same executable and the same call point, a best practice is\nto use
a consistent name, which makes it easier to correlate\ncross-trace spans.", | |
454 "type": "string" | |
455 } | 599 } |
456 }, | 600 }, |
457 "type": "object" | 601 "type": "object" |
458 }, | 602 }, |
459 "Empty": { | 603 "Empty": { |
460 "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 `{}`.", | 604 "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 `{}`.", |
461 "id": "Empty", | 605 "id": "Empty", |
462 "properties": {}, | 606 "properties": {}, |
463 "type": "object" | 607 "type": "object" |
464 }, | 608 }, |
465 "AttributeValue": { | 609 "AttributeValue": { |
466 "description": "Allowed attribute values.", | 610 "description": "The allowed types for the value side of an attribute
key:value pair.", |
467 "id": "AttributeValue", | 611 "id": "AttributeValue", |
468 "properties": { | 612 "properties": { |
| 613 "intValue": { |
| 614 "description": "An integer value.", |
| 615 "format": "int64", |
| 616 "type": "string" |
| 617 }, |
469 "stringValue": { | 618 "stringValue": { |
470 "description": "A string value.", | 619 "description": "A string value.", |
471 "type": "string" | 620 "type": "string" |
472 }, | 621 }, |
473 "boolValue": { | 622 "boolValue": { |
474 "description": "A boolean value.", | 623 "description": "A boolean value.", |
475 "type": "boolean" | 624 "type": "boolean" |
476 }, | |
477 "intValue": { | |
478 "description": "An integer value.", | |
479 "format": "int64", | |
480 "type": "string" | |
481 } | 625 } |
482 }, | 626 }, |
483 "type": "object" | 627 "type": "object" |
484 }, | 628 }, |
485 "BatchUpdateSpansRequest": { | 629 "BatchUpdateSpansRequest": { |
486 "description": "The request message for the `BatchUpdateSpans` metho
d.", | 630 "description": "The request message for the `BatchUpdateSpans` metho
d.", |
487 "id": "BatchUpdateSpansRequest", | 631 "id": "BatchUpdateSpansRequest", |
488 "properties": { | 632 "properties": { |
489 "spanUpdates": { | 633 "spanUpdates": { |
490 "additionalProperties": { | 634 "additionalProperties": { |
491 "$ref": "SpanUpdates" | 635 "$ref": "SpanUpdates" |
492 }, | 636 }, |
493 "description": "A map from trace name to spans to be stored
or updated.", | 637 "description": "A map from trace name to spans to be stored
or updated.", |
494 "type": "object" | 638 "type": "object" |
495 } | 639 } |
496 }, | 640 }, |
497 "type": "object" | 641 "type": "object" |
498 }, | |
499 "StackTrace": { | |
500 "description": "StackTrace collected in a trace.", | |
501 "id": "StackTrace", | |
502 "properties": { | |
503 "stackFrame": { | |
504 "description": "Stack frames of this stack trace.", | |
505 "items": { | |
506 "$ref": "StackFrame" | |
507 }, | |
508 "type": "array" | |
509 }, | |
510 "stackTraceHashId": { | |
511 "description": "User can choose to use their own hash functi
on to hash large attributes to\nsave network bandwidth and storage.\nTypical usa
ge is to pass both stack_frame and stack_trace_hash_id initially\nto inform the
storage of the mapping. And in subsequent calls, pass in\nstack_trace_hash_id on
ly. User shall verify the hash value is\nsuccessfully stored.", | |
512 "format": "uint64", | |
513 "type": "string" | |
514 } | |
515 }, | |
516 "type": "object" | |
517 }, | |
518 "TimeEvent": { | |
519 "description": "A time-stamped annotation in the Span.", | |
520 "id": "TimeEvent", | |
521 "properties": { | |
522 "networkEvent": { | |
523 "$ref": "NetworkEvent", | |
524 "description": "Optional field that can be used only for net
work events." | |
525 }, | |
526 "annotation": { | |
527 "$ref": "Annotation", | |
528 "description": "Optional field for user supplied <string, At
tributeValue> map" | |
529 }, | |
530 "localTime": { | |
531 "description": "The local machine absolute timestamp when th
is event happened.", | |
532 "format": "google-datetime", | |
533 "type": "string" | |
534 } | |
535 }, | |
536 "type": "object" | |
537 }, | |
538 "NetworkEvent": { | |
539 "description": "An event describing an RPC message sent/received on
the network.", | |
540 "id": "NetworkEvent", | |
541 "properties": { | |
542 "messageSize": { | |
543 "description": "Number of bytes send/receive.", | |
544 "format": "uint64", | |
545 "type": "string" | |
546 }, | |
547 "kernelTime": { | |
548 "description": "If available, this is the kernel time:\nFor
sent messages, this is the time at which the first bit was sent.\nFor received m
essages, this is the time at which the last bit was\nreceived.", | |
549 "format": "google-datetime", | |
550 "type": "string" | |
551 }, | |
552 "type": { | |
553 "description": "Type of a NetworkEvent.", | |
554 "enum": [ | |
555 "TYPE_UNSPECIFIED", | |
556 "SENT", | |
557 "RECV" | |
558 ], | |
559 "enumDescriptions": [ | |
560 "Unknown event.", | |
561 "Event type for sending RPC message.", | |
562 "Event type for receiving RPC message." | |
563 ], | |
564 "type": "string" | |
565 }, | |
566 "messageId": { | |
567 "description": "Every message has an identifier, which must
be different from all the\nnetwork messages in this span.\nThis is especially im
portant when the request/response are streamed.", | |
568 "format": "uint64", | |
569 "type": "string" | |
570 } | |
571 }, | |
572 "type": "object" | |
573 }, | |
574 "ListSpansResponse": { | |
575 "description": "The response message for the 'ListSpans' method.", | |
576 "id": "ListSpansResponse", | |
577 "properties": { | |
578 "spans": { | |
579 "description": "The requested spans if they are any in the s
pecified trace.", | |
580 "items": { | |
581 "$ref": "Span" | |
582 }, | |
583 "type": "array" | |
584 }, | |
585 "nextPageToken": { | |
586 "description": "If defined, indicates that there are more sp
ans that match the request\nand that this value should be passed to the next req
uest to continue\nretrieving additional spans.", | |
587 "type": "string" | |
588 } | |
589 }, | |
590 "type": "object" | |
591 }, | |
592 "SpanUpdates": { | |
593 "description": "Collection of spans to update.", | |
594 "id": "SpanUpdates", | |
595 "properties": { | |
596 "spans": { | |
597 "description": "A collection of spans.", | |
598 "items": { | |
599 "$ref": "Span" | |
600 }, | |
601 "type": "array" | |
602 } | |
603 }, | |
604 "type": "object" | |
605 }, | |
606 "StackFrame": { | |
607 "description": "Presents a single stack frame in a stack trace.", | |
608 "id": "StackFrame", | |
609 "properties": { | |
610 "originalFunctionName": { | |
611 "description": "Used when function name is ‘mangled’. Not gu
aranteed to be fully\nqualified but usually it is.", | |
612 "type": "string" | |
613 }, | |
614 "functionName": { | |
615 "description": "Fully qualified names which uniquely identif
y function/method/etc.", | |
616 "type": "string" | |
617 }, | |
618 "lineNumber": { | |
619 "description": "Line number of the frame.", | |
620 "format": "int64", | |
621 "type": "string" | |
622 }, | |
623 "loadModule": { | |
624 "$ref": "Module", | |
625 "description": "Binary module the code is loaded from." | |
626 }, | |
627 "columnNumber": { | |
628 "description": "Column number is important in JavaScript(ano
nymous functions),\nMight not be available in some languages.", | |
629 "format": "int64", | |
630 "type": "string" | |
631 }, | |
632 "fileName": { | |
633 "description": "File name of the frame.", | |
634 "type": "string" | |
635 }, | |
636 "sourceVersion": { | |
637 "description": "source_version is deployment specific. It mi
ght be\nbetter to be stored in deployment metadata.", | |
638 "type": "string" | |
639 } | |
640 }, | |
641 "type": "object" | |
642 } | 642 } |
643 }, | 643 }, |
644 "servicePath": "", | 644 "servicePath": "", |
645 "title": "Google Tracing API", | 645 "title": "Google Tracing API", |
646 "version": "v1" | 646 "version": "v1" |
647 } | 647 } |
OLD | NEW |