Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(503)

Side by Side Diff: discovery/googleapis/tracing__v1.json

Issue 2734843002: Api-roll 46: 2017-03-06 (Closed)
Patch Set: Created 3 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/storage__v1.json ('k') | discovery/googleapis/vision__v1.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 {
2 "auth": {
3 "oauth2": {
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": {
9 "description": "Write Trace data for a project or applicatio n"
10 },
11 "https://www.googleapis.com/auth/cloud-platform": {
12 "description": "View and manage your data across Google Clou d Platform services"
13 }
14 }
15 }
16 },
17 "basePath": "",
18 "baseUrl": "https://tracing.googleapis.com/",
19 "batchPath": "batch",
20 "canonicalName": "Tracing",
21 "description": "Send and retrieve trace data from Google Stackdriver Trace.\ n",
22 "discoveryVersion": "v1",
23 "documentationLink": "https://cloud.google.com/trace",
24 "icons": {
25 "x16": "http://www.google.com/images/icons/product/search-16.gif",
26 "x32": "http://www.google.com/images/icons/product/search-32.gif"
27 },
28 "id": "tracing:v1",
29 "kind": "discovery#restDescription",
30 "name": "tracing",
31 "ownerDomain": "google.com",
32 "ownerName": "Google",
33 "parameters": {
34 "bearer_token": {
35 "description": "OAuth bearer token.",
36 "location": "query",
37 "type": "string"
38 },
39 "oauth_token": {
40 "description": "OAuth 2.0 token for the current user.",
41 "location": "query",
42 "type": "string"
43 },
44 "upload_protocol": {
45 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
46 "location": "query",
47 "type": "string"
48 },
49 "prettyPrint": {
50 "default": "true",
51 "description": "Returns response with indentations and line breaks." ,
52 "location": "query",
53 "type": "boolean"
54 },
55 "fields": {
56 "description": "Selector specifying which fields to include in a par tial response.",
57 "location": "query",
58 "type": "string"
59 },
60 "uploadType": {
61 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
62 "location": "query",
63 "type": "string"
64 },
65 "callback": {
66 "description": "JSONP",
67 "location": "query",
68 "type": "string"
69 },
70 "$.xgafv": {
71 "description": "V1 error format.",
72 "enum": [
73 "1",
74 "2"
75 ],
76 "enumDescriptions": [
77 "v1 error format",
78 "v2 error format"
79 ],
80 "location": "query",
81 "type": "string"
82 },
83 "alt": {
84 "default": "json",
85 "description": "Data format for response.",
86 "enum": [
87 "json",
88 "media",
89 "proto"
90 ],
91 "enumDescriptions": [
92 "Responses with Content-Type of application/json",
93 "Media download with context-dependent Content-Type",
94 "Responses with Content-Type of application/x-protobuf"
95 ],
96 "location": "query",
97 "type": "string"
98 },
99 "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.",
101 "location": "query",
102 "type": "string"
103 },
104 "access_token": {
105 "description": "OAuth access token.",
106 "location": "query",
107 "type": "string"
108 },
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.",
111 "location": "query",
112 "type": "string"
113 },
114 "pp": {
115 "default": "true",
116 "description": "Pretty-print response.",
117 "location": "query",
118 "type": "boolean"
119 }
120 },
121 "protocol": "rest",
122 "resources": {
123 "projects": {
124 "resources": {
125 "traces": {
126 "methods": {
127 "list": {
128 "description": "Returns of a list of traces that mat ch the specified filter conditions.",
129 "httpMethod": "GET",
130 "id": "tracing.projects.traces.list",
131 "parameterOrder": [
132 "parent"
133 ],
134 "parameters": {
135 "pageSize": {
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.",
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",
151 "type": "string"
152 },
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": {
159 "description": "End of the time interval (in clusive) during which the trace data was\ncollected from the application.",
160 "format": "google-datetime",
161 "location": "query",
162 "type": "string"
163 },
164 "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.",
166 "location": "query",
167 "type": "string"
168 },
169 "startTime": {
170 "description": "Start of the time interval ( inclusive) during which the trace data was\ncollected from the application.",
171 "format": "google-datetime",
172 "location": "query",
173 "type": "string"
174 }
175 },
176 "path": "v1/{+parent}/traces",
177 "response": {
178 "$ref": "ListTracesResponse"
179 },
180 "scopes": [
181 "https://www.googleapis.com/auth/cloud-platform" ,
182 "https://www.googleapis.com/auth/trace.readonly"
183 ]
184 },
185 "get": {
186 "description": "Returns a specific trace.",
187 "httpMethod": "GET",
188 "id": "tracing.projects.traces.get",
189 "parameterOrder": [
190 "name"
191 ],
192 "parameters": {
193 "name": {
194 "description": "ID of the trace which is \"p rojects/<project_id>/traces/<trace_id>\".",
195 "location": "path",
196 "pattern": "^projects/[^/]+/traces/[^/]+$",
197 "required": true,
198 "type": "string"
199 }
200 },
201 "path": "v1/{+name}",
202 "response": {
203 "$ref": "Trace"
204 },
205 "scopes": [
206 "https://www.googleapis.com/auth/cloud-platform" ,
207 "https://www.googleapis.com/auth/trace.readonly"
208 ]
209 },
210 "batchUpdate": {
211 "description": "Sends new spans to Stackdriver Trace or updates existing spans. If the\nname of a trace that you send matches that o f an existing trace, any fields\nin the existing trace and its spans are overwri tten by the provided values,\nand any new fields provided are merged with the ex isting trace data. If the\nname does not match, a new trace is created with give n set of spans.",
212 "httpMethod": "POST",
213 "id": "tracing.projects.traces.batchUpdate",
214 "parameterOrder": [
215 "parent"
216 ],
217 "parameters": {
218 "parent": {
219 "description": "ID of the Cloud project wher e the trace data is stored.",
220 "location": "path",
221 "pattern": "^projects/[^/]+$",
222 "required": true,
223 "type": "string"
224 }
225 },
226 "path": "v1/{+parent}/traces:batchUpdate",
227 "request": {
228 "$ref": "BatchUpdateSpansRequest"
229 },
230 "response": {
231 "$ref": "Empty"
232 },
233 "scopes": [
234 "https://www.googleapis.com/auth/cloud-platform" ,
235 "https://www.googleapis.com/auth/trace.append"
236 ]
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 }
268 }
269 }
270 }
271 }
272 },
273 "revision": "20170225",
274 "rootUrl": "https://tracing.googleapis.com/",
275 "schemas": {
276 "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.",
278 "id": "Link",
279 "properties": {
280 "type": {
281 "description": "The type of the link.",
282 "enum": [
283 "TYPE_UNSPECIFIED",
284 "CHILD",
285 "PARENT"
286 ],
287 "enumDescriptions": [
288 "The relation of current span and linked span is unknown .",
289 "Current span is child of the linked span.",
290 "Current span is parent of the linked span."
291 ],
292 "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 }
303 },
304 "type": "object"
305 },
306 "Annotation": {
307 "description": "Text annotation with a set of attributes.",
308 "id": "Annotation",
309 "properties": {
310 "description": {
311 "description": "A user-supplied message describing the event .",
312 "type": "string"
313 },
314 "attributes": {
315 "additionalProperties": {
316 "$ref": "AttributeValue"
317 },
318 "description": "A set of attributes on the annotation.",
319 "type": "object"
320 }
321 },
322 "type": "object"
323 },
324 "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.",
326 "id": "Trace",
327 "properties": {
328 "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.",
330 "type": "string"
331 }
332 },
333 "type": "object"
334 },
335 "Module": {
336 "description": "Binary module.",
337 "id": "Module",
338 "properties": {
339 "module": {
340 "description": "E.g. main binary, kernel modules, and dynami c libraries\nsuch as libc.so, sharedlib.so",
341 "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 }
347 },
348 "type": "object"
349 },
350 "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.",
352 "id": "Status",
353 "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": {
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.",
361 "type": "string"
362 },
363 "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.",
365 "items": {
366 "additionalProperties": {
367 "description": "Properties of the object. Contains f ield @type with type URL.",
368 "type": "any"
369 },
370 "type": "object"
371 },
372 "type": "array"
373 }
374 },
375 "type": "object"
376 },
377 "ListTracesResponse": {
378 "description": "The response message for the `ListTraces` method.",
379 "id": "ListTracesResponse",
380 "properties": {
381 "traces": {
382 "description": "List of trace records returned.",
383 "items": {
384 "$ref": "Trace"
385 },
386 "type": "array"
387 },
388 "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.",
390 "type": "string"
391 }
392 },
393 "type": "object"
394 },
395 "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.",
397 "id": "Span",
398 "properties": {
399 "stackTrace": {
400 "$ref": "StackTrace",
401 "description": "Stack trace captured at the start of the spa n. This is optional."
402 },
403 "links": {
404 "description": "A collection of links.",
405 "items": {
406 "$ref": "Link"
407 },
408 "type": "array"
409 },
410 "attributes": {
411 "additionalProperties": {
412 "$ref": "AttributeValue"
413 },
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.",
415 "type": "object"
416 },
417 "id": {
418 "description": "Identifier for the span. Must be a 64-bit in teger other than 0 and\nunique within a trace.",
419 "format": "uint64",
420 "type": "string"
421 },
422 "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.",
424 "format": "google-datetime",
425 "type": "string"
426 },
427 "hasRemoteParent": {
428 "description": "True if this Span has a remote parent (is an RPC server Span).",
429 "type": "boolean"
430 },
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": {
442 "description": "A collection of time-stamped events.",
443 "items": {
444 "$ref": "TimeEvent"
445 },
446 "type": "array"
447 },
448 "status": {
449 "$ref": "Status",
450 "description": "The final status of the Span. This is option al."
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 }
456 },
457 "type": "object"
458 },
459 "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 `{}`.",
461 "id": "Empty",
462 "properties": {},
463 "type": "object"
464 },
465 "AttributeValue": {
466 "description": "Allowed attribute values.",
467 "id": "AttributeValue",
468 "properties": {
469 "stringValue": {
470 "description": "A string value.",
471 "type": "string"
472 },
473 "boolValue": {
474 "description": "A boolean value.",
475 "type": "boolean"
476 },
477 "intValue": {
478 "description": "An integer value.",
479 "format": "int64",
480 "type": "string"
481 }
482 },
483 "type": "object"
484 },
485 "BatchUpdateSpansRequest": {
486 "description": "The request message for the `BatchUpdateSpans` metho d.",
487 "id": "BatchUpdateSpansRequest",
488 "properties": {
489 "spanUpdates": {
490 "additionalProperties": {
491 "$ref": "SpanUpdates"
492 },
493 "description": "A map from trace name to spans to be stored or updated.",
494 "type": "object"
495 }
496 },
497 "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 }
643 },
644 "servicePath": "",
645 "title": "Google Tracing API",
646 "version": "v1"
647 }
OLDNEW
« no previous file with comments | « discovery/googleapis/storage__v1.json ('k') | discovery/googleapis/vision__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698