| OLD | NEW |
|---|
| (Empty) |
| 1 { | |
| 2 "auth": { | |
| 3 "oauth2": { | |
| 4 "scopes": { | |
| 5 "https://www.googleapis.com/auth/trace.append": { | |
| 6 "description": "Write Trace data for a project or applicatio
n" | |
| 7 }, | |
| 8 "https://www.googleapis.com/auth/cloud-platform": { | |
| 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 } | |
| 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:v2", | |
| 29 "kind": "discovery#restDescription", | |
| 30 "name": "tracing", | |
| 31 "ownerDomain": "google.com", | |
| 32 "ownerName": "Google", | |
| 33 "parameters": { | |
| 34 "quotaUser": { | |
| 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.", | |
| 36 "location": "query", | |
| 37 "type": "string" | |
| 38 }, | |
| 39 "pp": { | |
| 40 "default": "true", | |
| 41 "description": "Pretty-print response.", | |
| 42 "location": "query", | |
| 43 "type": "boolean" | |
| 44 }, | |
| 45 "oauth_token": { | |
| 46 "description": "OAuth 2.0 token for the current user.", | |
| 47 "location": "query", | |
| 48 "type": "string" | |
| 49 }, | |
| 50 "bearer_token": { | |
| 51 "description": "OAuth bearer token.", | |
| 52 "location": "query", | |
| 53 "type": "string" | |
| 54 }, | |
| 55 "upload_protocol": { | |
| 56 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | |
| 57 "location": "query", | |
| 58 "type": "string" | |
| 59 }, | |
| 60 "prettyPrint": { | |
| 61 "default": "true", | |
| 62 "description": "Returns response with indentations and line breaks."
, | |
| 63 "location": "query", | |
| 64 "type": "boolean" | |
| 65 }, | |
| 66 "uploadType": { | |
| 67 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
| 68 "location": "query", | |
| 69 "type": "string" | |
| 70 }, | |
| 71 "fields": { | |
| 72 "description": "Selector specifying which fields to include in a par
tial response.", | |
| 73 "location": "query", | |
| 74 "type": "string" | |
| 75 }, | |
| 76 "$.xgafv": { | |
| 77 "description": "V1 error format.", | |
| 78 "enum": [ | |
| 79 "1", | |
| 80 "2" | |
| 81 ], | |
| 82 "enumDescriptions": [ | |
| 83 "v1 error format", | |
| 84 "v2 error format" | |
| 85 ], | |
| 86 "location": "query", | |
| 87 "type": "string" | |
| 88 }, | |
| 89 "callback": { | |
| 90 "description": "JSONP", | |
| 91 "location": "query", | |
| 92 "type": "string" | |
| 93 }, | |
| 94 "alt": { | |
| 95 "default": "json", | |
| 96 "description": "Data format for response.", | |
| 97 "enum": [ | |
| 98 "json", | |
| 99 "media", | |
| 100 "proto" | |
| 101 ], | |
| 102 "enumDescriptions": [ | |
| 103 "Responses with Content-Type of application/json", | |
| 104 "Media download with context-dependent Content-Type", | |
| 105 "Responses with Content-Type of application/x-protobuf" | |
| 106 ], | |
| 107 "location": "query", | |
| 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 } | |
| 120 }, | |
| 121 "protocol": "rest", | |
| 122 "resources": { | |
| 123 "projects": { | |
| 124 "resources": { | |
| 125 "traces": { | |
| 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 }, | |
| 155 "listSpans": { | |
| 156 "description": "Returns a list of spans within a tra
ce.", | |
| 157 "httpMethod": "GET", | |
| 158 "id": "tracing.projects.traces.listSpans", | |
| 159 "parameterOrder": [ | |
| 160 "parent" | |
| 161 ], | |
| 162 "parameters": { | |
| 163 "pageToken": { | |
| 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.", | |
| 165 "location": "query", | |
| 166 "type": "string" | |
| 167 }, | |
| 168 "parent": { | |
| 169 "description": "ID of the trace for which to
list child spans. Format is\n`projects/PROJECT_ID/traces/TRACE_ID`.", | |
| 170 "location": "path", | |
| 171 "pattern": "^projects/[^/]+/traces/[^/]+$", | |
| 172 "required": true, | |
| 173 "type": "string" | |
| 174 } | |
| 175 }, | |
| 176 "path": "v2/{+parent}:listSpans", | |
| 177 "response": { | |
| 178 "$ref": "ListSpansResponse" | |
| 179 }, | |
| 180 "scopes": [ | |
| 181 "https://www.googleapis.com/auth/cloud-platform"
, | |
| 182 "https://www.googleapis.com/auth/trace.readonly" | |
| 183 ] | |
| 184 }, | |
| 185 "list": { | |
| 186 "description": "Returns of a list of traces that mat
ch the specified filter conditions.", | |
| 187 "httpMethod": "GET", | |
| 188 "id": "tracing.projects.traces.list", | |
| 189 "parameterOrder": [ | |
| 190 "parent" | |
| 191 ], | |
| 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 }, | |
| 198 "filter": { | |
| 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`.", | |
| 200 "location": "query", | |
| 201 "type": "string" | |
| 202 }, | |
| 203 "endTime": { | |
| 204 "description": "End of the time interval (in
clusive) during which the trace data was\ncollected from the application.", | |
| 205 "format": "google-datetime", | |
| 206 "location": "query", | |
| 207 "type": "string" | |
| 208 }, | |
| 209 "pageToken": { | |
| 210 "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.", | |
| 211 "location": "query", | |
| 212 "type": "string" | |
| 213 }, | |
| 214 "startTime": { | |
| 215 "description": "Start of the time interval (
inclusive) during which the trace data was\ncollected from the application.", | |
| 216 "format": "google-datetime", | |
| 217 "location": "query", | |
| 218 "type": "string" | |
| 219 }, | |
| 220 "pageSize": { | |
| 221 "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.", | |
| 222 "format": "int32", | |
| 223 "location": "query", | |
| 224 "type": "integer" | |
| 225 }, | |
| 226 "parent": { | |
| 227 "description": "ID of the Cloud project wher
e the trace data is stored which is\n`projects/PROJECT_ID`.", | |
| 228 "location": "path", | |
| 229 "pattern": "^projects/[^/]+$", | |
| 230 "required": true, | |
| 231 "type": "string" | |
| 232 } | |
| 233 }, | |
| 234 "path": "v2/{+parent}/traces", | |
| 235 "response": { | |
| 236 "$ref": "ListTracesResponse" | |
| 237 }, | |
| 238 "scopes": [ | |
| 239 "https://www.googleapis.com/auth/cloud-platform"
, | |
| 240 "https://www.googleapis.com/auth/trace.readonly" | |
| 241 ] | |
| 242 } | |
| 243 }, | |
| 244 "resources": { | |
| 245 "spans": { | |
| 246 "methods": { | |
| 247 "create": { | |
| 248 "description": "Creates a new Span.", | |
| 249 "httpMethod": "PUT", | |
| 250 "id": "tracing.projects.traces.spans.create"
, | |
| 251 "parameterOrder": [ | |
| 252 "name" | |
| 253 ], | |
| 254 "parameters": { | |
| 255 "name": { | |
| 256 "description": "The resource name of
Span in the format\n`projects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID`.\n`TRAC
E_ID` is a unique identifier for a trace within a project and is a\nbase16-encod
ed, case-insensitive string 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-inse
nsitive string of a 8-bytes array and is required\nto be 16 char long.", | |
| 257 "location": "path", | |
| 258 "pattern": "^projects/[^/]+/traces/[
^/]+/spans/[^/]+$", | |
| 259 "required": true, | |
| 260 "type": "string" | |
| 261 } | |
| 262 }, | |
| 263 "path": "v2/{+name}", | |
| 264 "request": { | |
| 265 "$ref": "Span" | |
| 266 }, | |
| 267 "response": { | |
| 268 "$ref": "Span" | |
| 269 }, | |
| 270 "scopes": [ | |
| 271 "https://www.googleapis.com/auth/cloud-p
latform", | |
| 272 "https://www.googleapis.com/auth/trace.a
ppend" | |
| 273 ] | |
| 274 } | |
| 275 } | |
| 276 } | |
| 277 } | |
| 278 } | |
| 279 } | |
| 280 } | |
| 281 }, | |
| 282 "revision": "20170531", | |
| 283 "rootUrl": "https://tracing.googleapis.com/", | |
| 284 "schemas": { | |
| 285 "Attributes": { | |
| 286 "description": "Attributes of a span with a key:value format.", | |
| 287 "id": "Attributes", | |
| 288 "properties": { | |
| 289 "droppedAttributesCount": { | |
| 290 "description": "The number of dropped attributes after the m
aximum size was enforced. If\n0 then no attributes were dropped.", | |
| 291 "format": "int32", | |
| 292 "type": "integer" | |
| 293 }, | |
| 294 "attributeMap": { | |
| 295 "additionalProperties": { | |
| 296 "$ref": "AttributeValue" | |
| 297 }, | |
| 298 "description": "The maximum key length is 128 bytes (attribu
tes are dropped if the\nkey size is larger than the maximum allowed). The value
can be a string\n(up to 256 bytes), integer, or boolean (true/false). Some commo
n pair\nexamples:\n\n \"/instance_id\": \"my-instance\"\n \"/zone\": \"us-
central1-a\"\n \"/grpc/peer_address\": \"ip:port\" (dns, etc.)\n \"/grpc/d
eadline\": \"Duration\"\n \"/http/user_agent\"\n \"/http/request_bytes\":
300\n \"/http/response_bytes\": 1200\n \"/http/url\": google.com/apis\n
\"abc.com/myattribute\": true", | |
| 299 "type": "object" | |
| 300 } | |
| 301 }, | |
| 302 "type": "object" | |
| 303 }, | |
| 304 "Links": { | |
| 305 "description": "A collection of links, which are references from thi
s span to a span\nin the same or different trace.", | |
| 306 "id": "Links", | |
| 307 "properties": { | |
| 308 "link": { | |
| 309 "description": "A collection of links.", | |
| 310 "items": { | |
| 311 "$ref": "Link" | |
| 312 }, | |
| 313 "type": "array" | |
| 314 }, | |
| 315 "droppedLinksCount": { | |
| 316 "description": "The number of dropped links after the maximu
m size was enforced. If\n0 then no links were dropped.", | |
| 317 "format": "int32", | |
| 318 "type": "integer" | |
| 319 } | |
| 320 }, | |
| 321 "type": "object" | |
| 322 }, | |
| 323 "TruncatableString": { | |
| 324 "description": "Represents a string value that might be truncated.", | |
| 325 "id": "TruncatableString", | |
| 326 "properties": { | |
| 327 "truncatedCharacterCount": { | |
| 328 "description": "The number of characters truncated from the
original string value. If 0 it\nmeans that the string value was not truncated.", | |
| 329 "format": "int32", | |
| 330 "type": "integer" | |
| 331 }, | |
| 332 "value": { | |
| 333 "description": "The truncated string value. E.g. for a strin
g attribute this may have up to\n256 bytes.", | |
| 334 "type": "string" | |
| 335 } | |
| 336 }, | |
| 337 "type": "object" | |
| 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 }, | |
| 355 "TimeEvent": { | |
| 356 "description": "A time-stamped annotation in the Span.", | |
| 357 "id": "TimeEvent", | |
| 358 "properties": { | |
| 359 "time": { | |
| 360 "description": "The timestamp indicating the time the event
occurred.", | |
| 361 "format": "google-datetime", | |
| 362 "type": "string" | |
| 363 }, | |
| 364 "networkEvent": { | |
| 365 "$ref": "NetworkEvent", | |
| 366 "description": "An event describing an RPC message sent/rece
ived on the network." | |
| 367 }, | |
| 368 "annotation": { | |
| 369 "$ref": "Annotation", | |
| 370 "description": "One or more key:value pairs." | |
| 371 } | |
| 372 }, | |
| 373 "type": "object" | |
| 374 }, | |
| 375 "NetworkEvent": { | |
| 376 "description": "An event describing an RPC message sent/received on
the network. A\nmaximum of 128 network events are allowed per Span.", | |
| 377 "id": "NetworkEvent", | |
| 378 "properties": { | |
| 379 "messageSize": { | |
| 380 "description": "The number of bytes sent or received.", | |
| 381 "format": "uint64", | |
| 382 "type": "string" | |
| 383 }, | |
| 384 "time": { | |
| 385 "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.", | |
| 386 "format": "google-datetime", | |
| 387 "type": "string" | |
| 388 }, | |
| 389 "type": { | |
| 390 "description": "Type of NetworkEvent. Indicates whether the
RPC message was sent or\nreceived.", | |
| 391 "enum": [ | |
| 392 "TYPE_UNSPECIFIED", | |
| 393 "SENT", | |
| 394 "RECV" | |
| 395 ], | |
| 396 "enumDescriptions": [ | |
| 397 "Unknown event type.", | |
| 398 "Indicates a sent RPC message.", | |
| 399 "Indicates a received RPC message." | |
| 400 ], | |
| 401 "type": "string" | |
| 402 }, | |
| 403 "messageId": { | |
| 404 "description": "An identifier for the message, which must be
unique in this span.", | |
| 405 "format": "uint64", | |
| 406 "type": "string" | |
| 407 } | |
| 408 }, | |
| 409 "type": "object" | |
| 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 }, | |
| 429 "StackFrame": { | |
| 430 "description": "Represents a single stack frame in a stack trace.", | |
| 431 "id": "StackFrame", | |
| 432 "properties": { | |
| 433 "lineNumber": { | |
| 434 "description": "Line number of the frame.", | |
| 435 "format": "int64", | |
| 436 "type": "string" | |
| 437 }, | |
| 438 "loadModule": { | |
| 439 "$ref": "Module", | |
| 440 "description": "Binary module the code is loaded from." | |
| 441 }, | |
| 442 "columnNumber": { | |
| 443 "description": "Column number is important in JavaScript (an
onymous functions).\nMay not be available in some languages.", | |
| 444 "format": "int64", | |
| 445 "type": "string" | |
| 446 }, | |
| 447 "fileName": { | |
| 448 "$ref": "TruncatableString", | |
| 449 "description": "The filename of the file containing this fra
me (up to 256 characters)." | |
| 450 }, | |
| 451 "sourceVersion": { | |
| 452 "$ref": "TruncatableString", | |
| 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)." | |
| 462 } | |
| 463 }, | |
| 464 "type": "object" | |
| 465 }, | |
| 466 "Link": { | |
| 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.", | |
| 468 "id": "Link", | |
| 469 "properties": { | |
| 470 "type": { | |
| 471 "description": "The relationship of the current span relativ
e to the linked span.", | |
| 472 "enum": [ | |
| 473 "TYPE_UNSPECIFIED", | |
| 474 "CHILD", | |
| 475 "PARENT" | |
| 476 ], | |
| 477 "enumDescriptions": [ | |
| 478 "The relationship of the two spans is unknown.", | |
| 479 "The current span is a child of the linked span.", | |
| 480 "The current span is the parent of the linked span." | |
| 481 ], | |
| 482 "type": "string" | |
| 483 }, | |
| 484 "traceId": { | |
| 485 "description": "`TRACE_ID` is a unique identifier for a trac
e within a project. It is\na base16-encoded, case-insensitive string of a 16-byt
es array and is\nrequired to be 32 char long.", | |
| 486 "type": "string" | |
| 487 }, | |
| 488 "spanId": { | |
| 489 "description": "`SPAN_ID` is a unique identifier for a span
within a trace. It is a\nbase16-encoded, case-insensitive string of a 8-bytes ar
ray and is\nrequired to be 16 char long.", | |
| 490 "type": "string" | |
| 491 } | |
| 492 }, | |
| 493 "type": "object" | |
| 494 }, | |
| 495 "Annotation": { | |
| 496 "description": "Text annotation with a set of attributes. A maximum
of 32 annotations are\nallowed per Span.", | |
| 497 "id": "Annotation", | |
| 498 "properties": { | |
| 499 "description": { | |
| 500 "$ref": "TruncatableString", | |
| 501 "description": "A user-supplied message describing the event
. The maximum length for\nthe description is 256 bytes." | |
| 502 }, | |
| 503 "attributes": { | |
| 504 "$ref": "Attributes", | |
| 505 "description": "A set of attributes on the annotation. A max
imum of 4 attributes are\nallowed per Annotation." | |
| 506 } | |
| 507 }, | |
| 508 "type": "object" | |
| 509 }, | |
| 510 "StackFrames": { | |
| 511 "description": "Represents collection of StackFrames that can be tru
ncated.", | |
| 512 "id": "StackFrames", | |
| 513 "properties": { | |
| 514 "droppedFramesCount": { | |
| 515 "description": "The number of dropped stack frames after the
maximum size was enforced.\nIf 0 then no frames were dropped.", | |
| 516 "format": "int32", | |
| 517 "type": "integer" | |
| 518 }, | |
| 519 "frame": { | |
| 520 "description": "Stack frames in this stack trace.", | |
| 521 "items": { | |
| 522 "$ref": "StackFrame" | |
| 523 }, | |
| 524 "type": "array" | |
| 525 } | |
| 526 }, | |
| 527 "type": "object" | |
| 528 }, | |
| 529 "Trace": { | |
| 530 "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.", | |
| 531 "id": "Trace", | |
| 532 "properties": { | |
| 533 "name": { | |
| 534 "description": "The resource name of Trace in the format\n`p
rojects/PROJECT_ID/traces/TRACE_ID`. `TRACE_ID` is a unique identifier\nfor a tr
ace within a project and is a base16-encoded, case-insensitive\nstring and is re
quired to be 32 char long.", | |
| 535 "type": "string" | |
| 536 } | |
| 537 }, | |
| 538 "type": "object" | |
| 539 }, | |
| 540 "TimeEvents": { | |
| 541 "description": "A collection of `TimeEvent`s. A `TimeEvent` is a tim
e-stamped annotation\non the span, consisting of either user-supplied key:value
pairs, or\ndetails of an RPC message sent/received on the network.", | |
| 542 "id": "TimeEvents", | |
| 543 "properties": { | |
| 544 "droppedAnnotationsCount": { | |
| 545 "description": "The number of dropped annotations after the
maximum size was enforced. If\n0 then no annotations were dropped.", | |
| 546 "format": "int32", | |
| 547 "type": "integer" | |
| 548 }, | |
| 549 "timeEvent": { | |
| 550 "description": "A collection of `TimeEvent`s.", | |
| 551 "items": { | |
| 552 "$ref": "TimeEvent" | |
| 553 }, | |
| 554 "type": "array" | |
| 555 }, | |
| 556 "droppedNetworkEventsCount": { | |
| 557 "description": "The number of dropped network events after t
he maximum size was enforced.\nIf 0 then no annotations were dropped.", | |
| 558 "format": "int32", | |
| 559 "type": "integer" | |
| 560 } | |
| 561 }, | |
| 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 } | |
| 717 }, | |
| 718 "servicePath": "", | |
| 719 "title": "Google Tracing API", | |
| 720 "version": "v2" | |
| 721 } | |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 2973303002:
Api-Roll 51: 2017-07-10 (Closed)
