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://cloudtrace.googleapis.com/", | 18 "baseUrl": "https://cloudtrace.googleapis.com/", |
19 "batchPath": "batch", | 19 "batchPath": "batch", |
20 "canonicalName": "Cloud Trace", | 20 "canonicalName": "Cloud Trace", |
21 "description": "Send and retrieve trace data from Stackdriver Trace. Data is
generated and available by default for all App Engine applications. Data from o
ther applications can be written to Stackdriver Trace for display, reporting, an
d analysis.\n", | 21 "description": "Send and retrieve trace data from Stackdriver Trace. Data is
generated and available by default for all App Engine applications. Data from o
ther applications can be written to Stackdriver Trace for display, reporting, an
d analysis.\n", |
22 "discoveryVersion": "v1", | 22 "discoveryVersion": "v1", |
23 "documentationLink": "https://cloud.google.com/trace", | 23 "documentationLink": "https://cloud.google.com/trace", |
24 "icons": { | 24 "icons": { |
25 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 25 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
26 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 26 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
27 }, | 27 }, |
28 "id": "cloudtrace:v2", | 28 "id": "cloudtrace:v2", |
29 "kind": "discovery#restDescription", | 29 "kind": "discovery#restDescription", |
30 "name": "cloudtrace", | 30 "name": "cloudtrace", |
31 "ownerDomain": "google.com", | 31 "ownerDomain": "google.com", |
32 "ownerName": "Google", | 32 "ownerName": "Google", |
33 "parameters": { | 33 "parameters": { |
34 "uploadType": { | 34 "quotaUser": { |
35 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 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", | 36 "location": "query", |
37 "type": "string" | 37 "type": "string" |
38 }, | 38 }, |
| 39 "pp": { |
| 40 "default": "true", |
| 41 "description": "Pretty-print response.", |
| 42 "location": "query", |
| 43 "type": "boolean" |
| 44 }, |
| 45 "bearer_token": { |
| 46 "description": "OAuth bearer token.", |
| 47 "location": "query", |
| 48 "type": "string" |
| 49 }, |
| 50 "oauth_token": { |
| 51 "description": "OAuth 2.0 token for the current user.", |
| 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 }, |
39 "fields": { | 66 "fields": { |
40 "description": "Selector specifying which fields to include in a par
tial response.", | 67 "description": "Selector specifying which fields to include in a par
tial response.", |
41 "location": "query", | 68 "location": "query", |
42 "type": "string" | 69 "type": "string" |
43 }, | 70 }, |
44 "callback": { | 71 "uploadType": { |
45 "description": "JSONP", | 72 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
46 "location": "query", | 73 "location": "query", |
47 "type": "string" | 74 "type": "string" |
48 }, | 75 }, |
49 "$.xgafv": { | 76 "$.xgafv": { |
50 "description": "V1 error format.", | 77 "description": "V1 error format.", |
51 "enum": [ | 78 "enum": [ |
52 "1", | 79 "1", |
53 "2" | 80 "2" |
54 ], | 81 ], |
55 "enumDescriptions": [ | 82 "enumDescriptions": [ |
56 "v1 error format", | 83 "v1 error format", |
57 "v2 error format" | 84 "v2 error format" |
58 ], | 85 ], |
59 "location": "query", | 86 "location": "query", |
60 "type": "string" | 87 "type": "string" |
61 }, | 88 }, |
| 89 "callback": { |
| 90 "description": "JSONP", |
| 91 "location": "query", |
| 92 "type": "string" |
| 93 }, |
62 "alt": { | 94 "alt": { |
63 "default": "json", | 95 "default": "json", |
64 "description": "Data format for response.", | 96 "description": "Data format for response.", |
65 "enum": [ | 97 "enum": [ |
66 "json", | 98 "json", |
67 "media", | 99 "media", |
68 "proto" | 100 "proto" |
69 ], | 101 ], |
70 "enumDescriptions": [ | 102 "enumDescriptions": [ |
71 "Responses with Content-Type of application/json", | 103 "Responses with Content-Type of application/json", |
72 "Media download with context-dependent Content-Type", | 104 "Media download with context-dependent Content-Type", |
73 "Responses with Content-Type of application/x-protobuf" | 105 "Responses with Content-Type of application/x-protobuf" |
74 ], | 106 ], |
75 "location": "query", | 107 "location": "query", |
76 "type": "string" | 108 "type": "string" |
77 }, | 109 }, |
78 "key": { | |
79 "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.", | |
80 "location": "query", | |
81 "type": "string" | |
82 }, | |
83 "access_token": { | 110 "access_token": { |
84 "description": "OAuth access token.", | 111 "description": "OAuth access token.", |
85 "location": "query", | 112 "location": "query", |
86 "type": "string" | 113 "type": "string" |
87 }, | 114 }, |
88 "quotaUser": { | 115 "key": { |
89 "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.", | 116 "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.", |
90 "location": "query", | 117 "location": "query", |
91 "type": "string" | 118 "type": "string" |
92 }, | |
93 "pp": { | |
94 "default": "true", | |
95 "description": "Pretty-print response.", | |
96 "location": "query", | |
97 "type": "boolean" | |
98 }, | |
99 "oauth_token": { | |
100 "description": "OAuth 2.0 token for the current user.", | |
101 "location": "query", | |
102 "type": "string" | |
103 }, | |
104 "bearer_token": { | |
105 "description": "OAuth bearer token.", | |
106 "location": "query", | |
107 "type": "string" | |
108 }, | |
109 "upload_protocol": { | |
110 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | |
111 "location": "query", | |
112 "type": "string" | |
113 }, | |
114 "prettyPrint": { | |
115 "default": "true", | |
116 "description": "Returns response with indentations and line breaks."
, | |
117 "location": "query", | |
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": { | 127 "listSpans": { |
128 "description": "Returns a list of spans within a tra
ce.", | 128 "description": "Returns a list of spans within a tra
ce.", |
129 "httpMethod": "GET", | 129 "httpMethod": "GET", |
130 "id": "cloudtrace.projects.traces.listSpans", | 130 "id": "cloudtrace.projects.traces.listSpans", |
131 "parameterOrder": [ | 131 "parameterOrder": [ |
132 "parent" | 132 "parent" |
133 ], | 133 ], |
134 "parameters": { | 134 "parameters": { |
| 135 "pageToken": { |
| 136 "description": "Optional. If present, then r
etrieve the next batch of results from the\npreceding call to this method. `page
_token` must be the value of\n`next_page_token` from the previous response. The
values of other method\nparameters should be identical to those in the previous
call.", |
| 137 "location": "query", |
| 138 "type": "string" |
| 139 }, |
135 "parent": { | 140 "parent": { |
136 "description": "Required: The resource name
of the trace containing the spans to list.\nThe format is `projects/PROJECT_ID/t
races/TRACE_ID`.", | 141 "description": "Required: The resource name
of the trace containing the spans to list.\nThe format is `projects/PROJECT_ID/t
races/TRACE_ID`.", |
137 "location": "path", | 142 "location": "path", |
138 "pattern": "^projects/[^/]+/traces/[^/]+$", | 143 "pattern": "^projects/[^/]+/traces/[^/]+$", |
139 "required": true, | 144 "required": true, |
140 "type": "string" | 145 "type": "string" |
141 }, | |
142 "pageToken": { | |
143 "description": "Optional. If present, then r
etrieve the next batch of results from the\npreceding call to this method. `page
_token` must be the value of\n`next_page_token` from the previous response. The
values of other method\nparameters should be identical to those in the previous
call.", | |
144 "location": "query", | |
145 "type": "string" | |
146 } | 146 } |
147 }, | 147 }, |
148 "path": "v2/{+parent}:listSpans", | 148 "path": "v2/{+parent}:listSpans", |
149 "response": { | 149 "response": { |
150 "$ref": "ListSpansResponse" | 150 "$ref": "ListSpansResponse" |
151 }, | 151 }, |
152 "scopes": [ | 152 "scopes": [ |
153 "https://www.googleapis.com/auth/cloud-platform"
, | 153 "https://www.googleapis.com/auth/cloud-platform"
, |
154 "https://www.googleapis.com/auth/trace.readonly" | 154 "https://www.googleapis.com/auth/trace.readonly" |
155 ] | 155 ] |
156 }, | 156 }, |
157 "list": { | 157 "list": { |
158 "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.", |
159 "httpMethod": "GET", | 159 "httpMethod": "GET", |
160 "id": "cloudtrace.projects.traces.list", | 160 "id": "cloudtrace.projects.traces.list", |
161 "parameterOrder": [ | 161 "parameterOrder": [ |
162 "parent" | 162 "parent" |
163 ], | 163 ], |
164 "parameters": { | 164 "parameters": { |
165 "pageSize": { | |
166 "description": "Optional. The maximum number
of results to return from this request.\nNon-positive values are ignored. The p
resence of `next_page_token` in the\nresponse indicates that more results might
be available, even if fewer than\nthe maximum number of results is returned by t
his request.", | |
167 "format": "int32", | |
168 "location": "query", | |
169 "type": "integer" | |
170 }, | |
171 "parent": { | 165 "parent": { |
172 "description": "Required. The project where
the trace data is stored. The format\nis `projects/PROJECT_ID`.", | 166 "description": "Required. The project where
the trace data is stored. The format\nis `projects/PROJECT_ID`.", |
173 "location": "path", | 167 "location": "path", |
174 "pattern": "^projects/[^/]+$", | 168 "pattern": "^projects/[^/]+$", |
175 "required": true, | 169 "required": true, |
176 "type": "string" | 170 "type": "string" |
177 }, | 171 }, |
178 "orderBy": { | 172 "orderBy": { |
179 "description": "Optional. A single field use
d to sort the returned traces.\nOnly the following field names can be used:\n\n*
`trace_id`: the trace's ID field\n* `name`: the root span's resource name\
n* `duration`: the difference between the root span's start time and end time\
n* `start`: the start time of the root span\n\nSorting is in ascending order
unless `desc` is appended to the sort field name.\nExample: `\"name desc\"`).", | 173 "description": "Optional. A single field use
d to sort the returned traces.\nOnly the following field names can be used:\n\n*
`trace_id`: the trace's ID field\n* `name`: the root span's resource name\
n* `duration`: the difference between the root span's start time and end time\
n* `start`: the start time of the root span\n\nSorting is in ascending order
unless `desc` is appended to the sort field name.\nExample: `\"name desc\"`).", |
180 "location": "query", | 174 "location": "query", |
181 "type": "string" | 175 "type": "string" |
182 }, | 176 }, |
183 "filter": { | 177 "filter": { |
184 "description": "Opional. Return only traces
that match this\n[trace filter](/trace/docs/trace-filters). Example:\n\n \"la
bel:/http/url root:/_ah/background my_label:17\"", | 178 "description": "Opional. Return only traces
that match this\n[trace filter](/trace/docs/trace-filters). Example:\n\n \"la
bel:/http/url root:/_ah/background my_label:17\"", |
185 "location": "query", | 179 "location": "query", |
186 "type": "string" | 180 "type": "string" |
187 }, | 181 }, |
188 "endTime": { | 182 "endTime": { |
189 "description": "Optional. Do not return trac
es whose start time is later than this time.", | 183 "description": "Optional. Do not return trac
es whose start time is later than this time.", |
190 "format": "google-datetime", | 184 "format": "google-datetime", |
191 "location": "query", | 185 "location": "query", |
192 "type": "string" | 186 "type": "string" |
193 }, | 187 }, |
| 188 "startTime": { |
| 189 "description": "Optional. Do not return trac
es whose end time is earlier than this time.", |
| 190 "format": "google-datetime", |
| 191 "location": "query", |
| 192 "type": "string" |
| 193 }, |
194 "pageToken": { | 194 "pageToken": { |
195 "description": "Optional. If present, then r
etrieve the next batch of results from the\npreceding call to this method. `pag
e_token` must be the value of\n`next_page_token` from the previous response. Th
e values of other method\nparameters should be identical to those in the previou
s call.", | 195 "description": "Optional. If present, then r
etrieve the next batch of results from the\npreceding call to this method. `pag
e_token` must be the value of\n`next_page_token` from the previous response. Th
e values of other method\nparameters should be identical to those in the previou
s call.", |
196 "location": "query", | 196 "location": "query", |
197 "type": "string" | 197 "type": "string" |
198 }, | 198 }, |
199 "startTime": { | 199 "pageSize": { |
200 "description": "Optional. Do not return trac
es whose end time is earlier than this time.", | 200 "description": "Optional. The maximum number
of results to return from this request.\nNon-positive values are ignored. The p
resence of `next_page_token` in the\nresponse indicates that more results might
be available, even if fewer than\nthe maximum number of results is returned by t
his request.", |
201 "format": "google-datetime", | 201 "format": "int32", |
202 "location": "query", | 202 "location": "query", |
203 "type": "string" | 203 "type": "integer" |
204 } | 204 } |
205 }, | 205 }, |
206 "path": "v2/{+parent}/traces", | 206 "path": "v2/{+parent}/traces", |
207 "response": { | 207 "response": { |
208 "$ref": "ListTracesResponse" | 208 "$ref": "ListTracesResponse" |
209 }, | 209 }, |
210 "scopes": [ | 210 "scopes": [ |
211 "https://www.googleapis.com/auth/cloud-platform"
, | 211 "https://www.googleapis.com/auth/cloud-platform"
, |
212 "https://www.googleapis.com/auth/trace.readonly" | 212 "https://www.googleapis.com/auth/trace.readonly" |
213 ] | 213 ] |
(...skipping 58 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
272 "https://www.googleapis.com/auth/trace.a
ppend" | 272 "https://www.googleapis.com/auth/trace.a
ppend" |
273 ] | 273 ] |
274 } | 274 } |
275 } | 275 } |
276 } | 276 } |
277 } | 277 } |
278 } | 278 } |
279 } | 279 } |
280 } | 280 } |
281 }, | 281 }, |
282 "revision": "20170705", | 282 "revision": "20170718", |
283 "rootUrl": "https://cloudtrace.googleapis.com/", | 283 "rootUrl": "https://cloudtrace.googleapis.com/", |
284 "schemas": { | 284 "schemas": { |
285 "StackTrace": { | 285 "TimeEvents": { |
286 "description": "A call stack appearing in a trace.", | 286 "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.", |
287 "id": "StackTrace", | 287 "id": "TimeEvents", |
288 "properties": { | 288 "properties": { |
289 "stackFrames": { | 289 "droppedAnnotationsCount": { |
290 "$ref": "StackFrames", | 290 "description": "The number of dropped annotations in all the
included time events.\nIf the value is 0, then no annotations were dropped.", |
291 "description": "Stack frames in this stack trace. A maximum
of 128 frames are allowed." | 291 "format": "int32", |
| 292 "type": "integer" |
292 }, | 293 }, |
293 "stackTraceHashId": { | 294 "timeEvent": { |
294 "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`.", | 295 "description": "A collection of `TimeEvent`s.", |
295 "format": "uint64", | 296 "items": { |
296 "type": "string" | 297 "$ref": "TimeEvent" |
| 298 }, |
| 299 "type": "array" |
| 300 }, |
| 301 "droppedNetworkEventsCount": { |
| 302 "description": "The number of dropped network events in all
the included time events.\nIf the value is 0, then no network events were droppe
d.", |
| 303 "format": "int32", |
| 304 "type": "integer" |
297 } | 305 } |
298 }, | 306 }, |
299 "type": "object" | 307 "type": "object" |
300 }, | 308 }, |
301 "TruncatableString": { | 309 "Module": { |
302 "description": "Represents a string that might be shortened to a spe
cified length.", | 310 "description": "Binary module.", |
303 "id": "TruncatableString", | 311 "id": "Module", |
304 "properties": { | 312 "properties": { |
305 "truncatedByteCount": { | 313 "buildId": { |
306 "description": "The number of bytes removed from the origina
l string. If this\nvalue is 0, then the string was not shortened.", | 314 "$ref": "TruncatableString", |
307 "format": "int32", | 315 "description": "A unique identifier for the module, usually
a hash of its\ncontents (up to 128 bytes)." |
308 "type": "integer" | |
309 }, | 316 }, |
310 "value": { | 317 "module": { |
311 "description": "The shortened string. For example, if the or
iginal string was 500\nbytes long and the limit of the string was 128 bytes, the
n this\nvalue contains the first 128 bytes of the 500-byte string. Note that\ntr
uncation always happens on the character boundary, to ensure that\ntruncated str
ing is still valid UTF8. In case of multi-byte characters,\nsize of truncated st
ring can be less than truncation limit.", | 318 "$ref": "TruncatableString", |
312 "type": "string" | 319 "description": "For example: main binary, kernel modules, an
d dynamic libraries\nsuch as libc.so, sharedlib.so (up to 256 bytes)." |
313 } | 320 } |
314 }, | 321 }, |
315 "type": "object" | 322 "type": "object" |
316 }, | 323 }, |
317 "TimeEvent": { | 324 "Status": { |
318 "description": "A time-stamped annotation or network event in the Sp
an.", | 325 "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.", |
319 "id": "TimeEvent", | 326 "id": "Status", |
320 "properties": { | 327 "properties": { |
321 "time": { | 328 "message": { |
322 "description": "The timestamp indicating the time the event
occurred.", | 329 "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.", |
323 "format": "google-datetime", | |
324 "type": "string" | 330 "type": "string" |
325 }, | 331 }, |
326 "networkEvent": { | 332 "details": { |
327 "$ref": "NetworkEvent", | 333 "description": "A list of messages that carry the error deta
ils. There is a common set of\nmessage types for APIs to use.", |
328 "description": "An event describing an RPC message sent/rece
ived on the network." | 334 "items": { |
| 335 "additionalProperties": { |
| 336 "description": "Properties of the object. Contains f
ield @type with type URL.", |
| 337 "type": "any" |
| 338 }, |
| 339 "type": "object" |
| 340 }, |
| 341 "type": "array" |
329 }, | 342 }, |
330 "annotation": { | 343 "code": { |
331 "$ref": "Annotation", | 344 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
332 "description": "One or more key:value pairs." | 345 "format": "int32", |
| 346 "type": "integer" |
333 } | 347 } |
334 }, | 348 }, |
335 "type": "object" | 349 "type": "object" |
336 }, | 350 }, |
337 "ListSpansResponse": { | 351 "BatchWriteSpansRequest": { |
338 "description": "The response message for the `ListSpans` method.", | 352 "description": "The request message for the `BatchWriteSpans` method
.", |
339 "id": "ListSpansResponse", | 353 "id": "BatchWriteSpansRequest", |
340 "properties": { | 354 "properties": { |
341 "nextPageToken": { | |
342 "description": "If defined, indicates that there might be mo
re spans that match the\nrequest. Pass this as the value of `pageToken` in a sub
sequent request to\nretrieve additional spans.", | |
343 "type": "string" | |
344 }, | |
345 "spans": { | 355 "spans": { |
346 "description": "The requested spans, if there are any in the
specified trace.", | 356 "description": "A collection of spans.", |
347 "items": { | 357 "items": { |
348 "$ref": "Span" | 358 "$ref": "Span" |
349 }, | 359 }, |
350 "type": "array" | 360 "type": "array" |
351 } | 361 } |
352 }, | 362 }, |
353 "type": "object" | 363 "type": "object" |
354 }, | 364 }, |
| 365 "ListTracesResponse": { |
| 366 "description": "The response message for the `ListTraces` method.", |
| 367 "id": "ListTracesResponse", |
| 368 "properties": { |
| 369 "nextPageToken": { |
| 370 "description": "If there might be more results than those ap
pearing in this response, then\n`next_page_token` is included. To get the next
set of results, call this\nmethod again using the value of `next_page_token` as
`page_token`.", |
| 371 "type": "string" |
| 372 }, |
| 373 "traces": { |
| 374 "description": "List of trace records returned.", |
| 375 "items": { |
| 376 "$ref": "Trace" |
| 377 }, |
| 378 "type": "array" |
| 379 } |
| 380 }, |
| 381 "type": "object" |
| 382 }, |
| 383 "Span": { |
| 384 "description": "A span represents a single operation within a trace.
Spans can be\nnested to form a trace tree. Often, a trace contains a root span\
nthat describes the end-to-end latency, and one or more subspans for\nits sub-op
erations. A trace can also contain multiple root spans,\nor none at all. Spans d
o not need to be contiguous—there may be\ngaps or overlaps between spans i
n a trace.", |
| 385 "id": "Span", |
| 386 "properties": { |
| 387 "childSpanCount": { |
| 388 "description": "An optional number of child spans that were
generated while this span\nwas active. If set, allows implementation to detect m
issing child spans.", |
| 389 "format": "uint32", |
| 390 "type": "integer" |
| 391 }, |
| 392 "sameProcessAsParentSpan": { |
| 393 "description": "A highly recommended but not required flag t
hat identifies when a trace\ncrosses a process boundary. True when the parent_sp
an belongs to the\nsame process as the current span.", |
| 394 "type": "boolean" |
| 395 }, |
| 396 "status": { |
| 397 "$ref": "Status", |
| 398 "description": "An optional final status for this span." |
| 399 }, |
| 400 "name": { |
| 401 "description": "The resource name of the span in the followi
ng format:\n\n projects/[PROJECT_ID]traces/[TRACE_ID]/spans/SPAN_ID is a uniq
ue identifier for a trace within a project.\n[SPAN_ID] is a unique identifier fo
r a span within a trace,\nassigned when the span is created.", |
| 402 "type": "string" |
| 403 }, |
| 404 "stackTrace": { |
| 405 "$ref": "StackTrace", |
| 406 "description": "Stack trace captured at the start of the spa
n." |
| 407 }, |
| 408 "parentSpanId": { |
| 409 "description": "The [SPAN_ID] of this span's parent span. If
this is a root span,\nthen this field must be empty.", |
| 410 "type": "string" |
| 411 }, |
| 412 "endTime": { |
| 413 "description": "The end time of the span. On the client side
, this is the time kept by\nthe local machine where the span execution ends. On
the server side, this\nis the time when the server application handler stops run
ning.", |
| 414 "format": "google-datetime", |
| 415 "type": "string" |
| 416 }, |
| 417 "startTime": { |
| 418 "description": "The start time of the span. On the client si
de, this is the time kept by\nthe local machine where the span execution starts.
On the server side, this\nis the time when the server's application handler sta
rts running.", |
| 419 "format": "google-datetime", |
| 420 "type": "string" |
| 421 }, |
| 422 "displayName": { |
| 423 "$ref": "TruncatableString", |
| 424 "description": "A description of the span's operation (up to
128 bytes).\nStackdriver Trace displays the description in the\n{% dynamic prin
t site_values.console_name %}.\nFor example, the display name can be a qualified
method name or a file name\nand a line number where the operation is called. A
best practice is to use\nthe same display name within an application and at the
same call point.\nThis makes it easier to correlate spans in different traces." |
| 425 }, |
| 426 "timeEvents": { |
| 427 "$ref": "TimeEvents", |
| 428 "description": "The included time events. There can be up to
32 annotations and 128 network\nevents per span." |
| 429 }, |
| 430 "links": { |
| 431 "$ref": "Links", |
| 432 "description": "A maximum of 128 links are allowed per Span.
" |
| 433 }, |
| 434 "attributes": { |
| 435 "$ref": "Attributes", |
| 436 "description": "A set of attributes on the span. There is a
limit of 32 attributes per\nspan." |
| 437 }, |
| 438 "spanId": { |
| 439 "description": "The [SPAN_ID] portion of the span's resource
name.", |
| 440 "type": "string" |
| 441 } |
| 442 }, |
| 443 "type": "object" |
| 444 }, |
| 445 "Empty": { |
| 446 "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 `{}`.", |
| 447 "id": "Empty", |
| 448 "properties": {}, |
| 449 "type": "object" |
| 450 }, |
| 451 "AttributeValue": { |
| 452 "description": "The allowed types for [VALUE] in a `[KEY]:[VALUE]` a
ttribute.", |
| 453 "id": "AttributeValue", |
| 454 "properties": { |
| 455 "intValue": { |
| 456 "description": "A 64-bit signed integer.", |
| 457 "format": "int64", |
| 458 "type": "string" |
| 459 }, |
| 460 "boolValue": { |
| 461 "description": "A Boolean value represented by `true` or `fa
lse`.", |
| 462 "type": "boolean" |
| 463 }, |
| 464 "stringValue": { |
| 465 "$ref": "TruncatableString", |
| 466 "description": "A string up to 256 bytes long." |
| 467 } |
| 468 }, |
| 469 "type": "object" |
| 470 }, |
| 471 "Attributes": { |
| 472 "description": "A set of attributes, each in the format `[KEY]:[VALU
E]`.", |
| 473 "id": "Attributes", |
| 474 "properties": { |
| 475 "droppedAttributesCount": { |
| 476 "description": "The number of attributes that were discarded
. Attributes can be discarded\nbecause their keys are too long or because there
are too many attributes.\nIf this value is 0 then all attributes are valid.", |
| 477 "format": "int32", |
| 478 "type": "integer" |
| 479 }, |
| 480 "attributeMap": { |
| 481 "additionalProperties": { |
| 482 "$ref": "AttributeValue" |
| 483 }, |
| 484 "description": "The set of attributes. Each attribute's key
can be up to 128 bytes\nlong. The value can be a string up to 256 bytes, an inte
ger, or the\nBoolean values `true` and `false`. For example:\n\n \"/instance_
id\": \"my-instance\"\n \"/http/user_agent\": \"\"\n \"/http/request_bytes
\": 300\n \"abc.com/myattribute\": true", |
| 485 "type": "object" |
| 486 } |
| 487 }, |
| 488 "type": "object" |
| 489 }, |
| 490 "Links": { |
| 491 "description": "A collection of links, which are references from thi
s span to a span\nin the same or different trace.", |
| 492 "id": "Links", |
| 493 "properties": { |
| 494 "droppedLinksCount": { |
| 495 "description": "The number of dropped links after the maximu
m size was enforced. If\nthis value is 0, then no links were dropped.", |
| 496 "format": "int32", |
| 497 "type": "integer" |
| 498 }, |
| 499 "link": { |
| 500 "description": "A collection of links.", |
| 501 "items": { |
| 502 "$ref": "Link" |
| 503 }, |
| 504 "type": "array" |
| 505 } |
| 506 }, |
| 507 "type": "object" |
| 508 }, |
| 509 "TruncatableString": { |
| 510 "description": "Represents a string that might be shortened to a spe
cified length.", |
| 511 "id": "TruncatableString", |
| 512 "properties": { |
| 513 "truncatedByteCount": { |
| 514 "description": "The number of bytes removed from the origina
l string. If this\nvalue is 0, then the string was not shortened.", |
| 515 "format": "int32", |
| 516 "type": "integer" |
| 517 }, |
| 518 "value": { |
| 519 "description": "The shortened string. For example, if the or
iginal string was 500\nbytes long and the limit of the string was 128 bytes, the
n this\nvalue contains the first 128 bytes of the 500-byte string. Note that\ntr
uncation always happens on the character boundary, to ensure that\ntruncated str
ing is still valid UTF8. In case of multi-byte characters,\nsize of truncated st
ring can be less than truncation limit.", |
| 520 "type": "string" |
| 521 } |
| 522 }, |
| 523 "type": "object" |
| 524 }, |
| 525 "StackTrace": { |
| 526 "description": "A call stack appearing in a trace.", |
| 527 "id": "StackTrace", |
| 528 "properties": { |
| 529 "stackFrames": { |
| 530 "$ref": "StackFrames", |
| 531 "description": "Stack frames in this stack trace. A maximum
of 128 frames are allowed." |
| 532 }, |
| 533 "stackTraceHashId": { |
| 534 "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`.", |
| 535 "format": "uint64", |
| 536 "type": "string" |
| 537 } |
| 538 }, |
| 539 "type": "object" |
| 540 }, |
| 541 "TimeEvent": { |
| 542 "description": "A time-stamped annotation or network event in the Sp
an.", |
| 543 "id": "TimeEvent", |
| 544 "properties": { |
| 545 "networkEvent": { |
| 546 "$ref": "NetworkEvent", |
| 547 "description": "An event describing an RPC message sent/rece
ived on the network." |
| 548 }, |
| 549 "annotation": { |
| 550 "$ref": "Annotation", |
| 551 "description": "One or more key:value pairs." |
| 552 }, |
| 553 "time": { |
| 554 "description": "The timestamp indicating the time the event
occurred.", |
| 555 "format": "google-datetime", |
| 556 "type": "string" |
| 557 } |
| 558 }, |
| 559 "type": "object" |
| 560 }, |
355 "NetworkEvent": { | 561 "NetworkEvent": { |
356 "description": "An event describing an RPC message sent or received
on the network.", | 562 "description": "An event describing an RPC message sent or received
on the network.", |
357 "id": "NetworkEvent", | 563 "id": "NetworkEvent", |
358 "properties": { | 564 "properties": { |
359 "messageId": { | |
360 "description": "An identifier for the message, which must be
unique in this span.", | |
361 "format": "uint64", | |
362 "type": "string" | |
363 }, | |
364 "messageSize": { | 565 "messageSize": { |
365 "description": "The number of bytes sent or received.", | 566 "description": "The number of bytes sent or received.", |
366 "format": "uint64", | 567 "format": "uint64", |
367 "type": "string" | 568 "type": "string" |
368 }, | 569 }, |
369 "time": { | 570 "time": { |
370 "description": "For sent messages, this is the time at which
the first bit was sent.\nFor received messages, this is the time at which the l
ast bit was\nreceived.", | 571 "description": "For sent messages, this is the time at which
the first bit was sent.\nFor received messages, this is the time at which the l
ast bit was\nreceived.", |
371 "format": "google-datetime", | 572 "format": "google-datetime", |
372 "type": "string" | 573 "type": "string" |
373 }, | 574 }, |
374 "type": { | 575 "type": { |
375 "description": "Type of NetworkEvent. Indicates whether the
RPC message was sent or\nreceived.", | 576 "description": "Type of NetworkEvent. Indicates whether the
RPC message was sent or\nreceived.", |
376 "enum": [ | 577 "enum": [ |
377 "TYPE_UNSPECIFIED", | 578 "TYPE_UNSPECIFIED", |
378 "SENT", | 579 "SENT", |
379 "RECV" | 580 "RECV" |
380 ], | 581 ], |
381 "enumDescriptions": [ | 582 "enumDescriptions": [ |
382 "Unknown event type.", | 583 "Unknown event type.", |
383 "Indicates a sent RPC message.", | 584 "Indicates a sent RPC message.", |
384 "Indicates a received RPC message." | 585 "Indicates a received RPC message." |
385 ], | 586 ], |
386 "type": "string" | 587 "type": "string" |
387 } | 588 }, |
388 }, | 589 "messageId": { |
389 "type": "object" | 590 "description": "An identifier for the message, which must be
unique in this span.", |
390 }, | 591 "format": "uint64", |
391 "StackFrame": { | 592 "type": "string" |
392 "description": "Represents a single stack frame in a stack trace.", | 593 } |
393 "id": "StackFrame", | 594 }, |
394 "properties": { | 595 "type": "object" |
395 "fileName": { | 596 }, |
396 "$ref": "TruncatableString", | 597 "ListSpansResponse": { |
397 "description": "The name of the source file where the functi
on call appears (up to 256\nbytes)." | 598 "description": "The response message for the `ListSpans` method.", |
398 }, | 599 "id": "ListSpansResponse", |
399 "sourceVersion": { | 600 "properties": { |
400 "$ref": "TruncatableString", | 601 "nextPageToken": { |
401 "description": "The version of the deployed source code (up
to 128 bytes)." | 602 "description": "If defined, indicates that there might be mo
re spans that match the\nrequest. Pass this as the value of `pageToken` in a sub
sequent request to\nretrieve additional spans.", |
402 }, | 603 "type": "string" |
403 "originalFunctionName": { | 604 }, |
404 "$ref": "TruncatableString", | |
405 "description": "An un-mangled function name, if `function_na
me` is\n[mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can\
nbe fully-qualified (up to 1024 bytes)." | |
406 }, | |
407 "functionName": { | |
408 "$ref": "TruncatableString", | |
409 "description": "The fully-qualified name that uniquely ident
ifies the function or\nmethod that is active in this frame (up to 1024 bytes)." | |
410 }, | |
411 "lineNumber": { | |
412 "description": "The line number in `file_name` where the fun
ction call appears.", | |
413 "format": "int64", | |
414 "type": "string" | |
415 }, | |
416 "loadModule": { | |
417 "$ref": "Module", | |
418 "description": "The binary module from where the code was lo
aded." | |
419 }, | |
420 "columnNumber": { | |
421 "description": "The column number where the function call ap
pears, if available.\nThis is important in JavaScript because of its anonymous f
unctions.", | |
422 "format": "int64", | |
423 "type": "string" | |
424 } | |
425 }, | |
426 "type": "object" | |
427 }, | |
428 "Link": { | |
429 "description": "A pointer from the current span to another span in t
he same trace or in a\ndifferent trace. For example, this can be used in batchin
g operations,\nwhere a single batch handler processes multiple requests from dif
ferent\ntraces or when the handler receives a request from a different project."
, | |
430 "id": "Link", | |
431 "properties": { | |
432 "type": { | |
433 "description": "The relationship of the current span relativ
e to the linked span.", | |
434 "enum": [ | |
435 "TYPE_UNSPECIFIED", | |
436 "CHILD_LINKED_SPAN", | |
437 "PARENT_LINKED_SPAN" | |
438 ], | |
439 "enumDescriptions": [ | |
440 "The relationship of the two spans is unknown.", | |
441 "The linked span is a child of the current span.", | |
442 "The linked span is a parent of the current span." | |
443 ], | |
444 "type": "string" | |
445 }, | |
446 "attributes": { | |
447 "$ref": "Attributes", | |
448 "description": "A set of attributes on the link. There is a
limit of 32 attributes per\nlink." | |
449 }, | |
450 "traceId": { | |
451 "description": "`TRACE_ID` identifies a trace within a proje
ct.", | |
452 "type": "string" | |
453 }, | |
454 "spanId": { | |
455 "description": "`SPAN_ID` identifies a span within a trace."
, | |
456 "type": "string" | |
457 } | |
458 }, | |
459 "type": "object" | |
460 }, | |
461 "Annotation": { | |
462 "description": "Text annotation with a set of attributes.", | |
463 "id": "Annotation", | |
464 "properties": { | |
465 "attributes": { | |
466 "$ref": "Attributes", | |
467 "description": "A set of attributes on the annotation. There
is a limit of 4 attributes\nper Annotation." | |
468 }, | |
469 "description": { | |
470 "$ref": "TruncatableString", | |
471 "description": "A user-supplied message describing the event
. The maximum length for\nthe description is 256 bytes." | |
472 } | |
473 }, | |
474 "type": "object" | |
475 }, | |
476 "StackFrames": { | |
477 "description": "A collection of stack frames, which can be truncated
.", | |
478 "id": "StackFrames", | |
479 "properties": { | |
480 "droppedFramesCount": { | |
481 "description": "The number of stack frames that were dropped
because there\nwere too many stack frames.\nIf this value is 0, then no stack f
rames were dropped.", | |
482 "format": "int32", | |
483 "type": "integer" | |
484 }, | |
485 "frame": { | |
486 "description": "Stack frames in this call stack.", | |
487 "items": { | |
488 "$ref": "StackFrame" | |
489 }, | |
490 "type": "array" | |
491 } | |
492 }, | |
493 "type": "object" | |
494 }, | |
495 "Trace": { | |
496 "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.", | |
497 "id": "Trace", | |
498 "properties": { | |
499 "name": { | |
500 "description": "The resource name of the trace in the follow
ing format:\n\n projects/[PROJECT_ID]/traces/TRACE_ID is a unique identifier
for a trace within a project.\nThe ID is assigned when the trace is created.", | |
501 "type": "string" | |
502 } | |
503 }, | |
504 "type": "object" | |
505 }, | |
506 "TimeEvents": { | |
507 "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.", | |
508 "id": "TimeEvents", | |
509 "properties": { | |
510 "droppedAnnotationsCount": { | |
511 "description": "The number of dropped annotations in all the
included time events.\nIf the value is 0, then no annotations were dropped.", | |
512 "format": "int32", | |
513 "type": "integer" | |
514 }, | |
515 "timeEvent": { | |
516 "description": "A collection of `TimeEvent`s.", | |
517 "items": { | |
518 "$ref": "TimeEvent" | |
519 }, | |
520 "type": "array" | |
521 }, | |
522 "droppedNetworkEventsCount": { | |
523 "description": "The number of dropped network events in all
the included time events.\nIf the value is 0, then no network events were droppe
d.", | |
524 "format": "int32", | |
525 "type": "integer" | |
526 } | |
527 }, | |
528 "type": "object" | |
529 }, | |
530 "Module": { | |
531 "description": "Binary module.", | |
532 "id": "Module", | |
533 "properties": { | |
534 "module": { | |
535 "$ref": "TruncatableString", | |
536 "description": "For example: main binary, kernel modules, an
d dynamic libraries\nsuch as libc.so, sharedlib.so (up to 256 bytes)." | |
537 }, | |
538 "buildId": { | |
539 "$ref": "TruncatableString", | |
540 "description": "A unique identifier for the module, usually
a hash of its\ncontents (up to 128 bytes)." | |
541 } | |
542 }, | |
543 "type": "object" | |
544 }, | |
545 "Status": { | |
546 "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.", | |
547 "id": "Status", | |
548 "properties": { | |
549 "details": { | |
550 "description": "A list of messages that carry the error deta
ils. There will be a\ncommon set of message types for APIs to use.", | |
551 "items": { | |
552 "additionalProperties": { | |
553 "description": "Properties of the object. Contains f
ield @type with type URL.", | |
554 "type": "any" | |
555 }, | |
556 "type": "object" | |
557 }, | |
558 "type": "array" | |
559 }, | |
560 "code": { | |
561 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", | |
562 "format": "int32", | |
563 "type": "integer" | |
564 }, | |
565 "message": { | |
566 "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.", | |
567 "type": "string" | |
568 } | |
569 }, | |
570 "type": "object" | |
571 }, | |
572 "BatchWriteSpansRequest": { | |
573 "description": "The request message for the `BatchWriteSpans` method
.", | |
574 "id": "BatchWriteSpansRequest", | |
575 "properties": { | |
576 "spans": { | 605 "spans": { |
577 "description": "A collection of spans.", | 606 "description": "The requested spans, if there are any in the
specified trace.", |
578 "items": { | 607 "items": { |
579 "$ref": "Span" | 608 "$ref": "Span" |
580 }, | 609 }, |
581 "type": "array" | 610 "type": "array" |
582 } | 611 } |
583 }, | 612 }, |
584 "type": "object" | 613 "type": "object" |
585 }, | 614 }, |
586 "Empty": { | 615 "StackFrame": { |
587 "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 `{}`.", | 616 "description": "Represents a single stack frame in a stack trace.", |
588 "id": "Empty", | 617 "id": "StackFrame", |
589 "properties": {}, | 618 "properties": { |
| 619 "functionName": { |
| 620 "$ref": "TruncatableString", |
| 621 "description": "The fully-qualified name that uniquely ident
ifies the function or\nmethod that is active in this frame (up to 1024 bytes)." |
| 622 }, |
| 623 "lineNumber": { |
| 624 "description": "The line number in `file_name` where the fun
ction call appears.", |
| 625 "format": "int64", |
| 626 "type": "string" |
| 627 }, |
| 628 "loadModule": { |
| 629 "$ref": "Module", |
| 630 "description": "The binary module from where the code was lo
aded." |
| 631 }, |
| 632 "columnNumber": { |
| 633 "description": "The column number where the function call ap
pears, if available.\nThis is important in JavaScript because of its anonymous f
unctions.", |
| 634 "format": "int64", |
| 635 "type": "string" |
| 636 }, |
| 637 "fileName": { |
| 638 "$ref": "TruncatableString", |
| 639 "description": "The name of the source file where the functi
on call appears (up to 256\nbytes)." |
| 640 }, |
| 641 "sourceVersion": { |
| 642 "$ref": "TruncatableString", |
| 643 "description": "The version of the deployed source code (up
to 128 bytes)." |
| 644 }, |
| 645 "originalFunctionName": { |
| 646 "$ref": "TruncatableString", |
| 647 "description": "An un-mangled function name, if `function_na
me` is\n[mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can\
nbe fully-qualified (up to 1024 bytes)." |
| 648 } |
| 649 }, |
590 "type": "object" | 650 "type": "object" |
591 }, | 651 }, |
592 "Span": { | 652 "Link": { |
593 "description": "A span represents a single operation within a trace.
Spans can be\nnested to form a trace tree. Often, a trace contains a root span\
nthat describes the end-to-end latency, and one or more subspans for\nits sub-op
erations. A trace can also contain multiple root spans,\nor none at all. Spans d
o not need to be contiguous—there may be\ngaps or overlaps between spans i
n a trace.", | 653 "description": "A pointer from the current span to another span in t
he same trace or in a\ndifferent trace. For example, this can be used in batchin
g operations,\nwhere a single batch handler processes multiple requests from dif
ferent\ntraces or when the handler receives a request from a different project."
, |
594 "id": "Span", | 654 "id": "Link", |
595 "properties": { | 655 "properties": { |
596 "childSpanCount": { | 656 "type": { |
597 "description": "An optional number of child spans that were
generated while this span\nwas active. If set, allows implementation to detect m
issing child spans.", | 657 "description": "The relationship of the current span relativ
e to the linked span.", |
598 "format": "uint32", | 658 "enum": [ |
599 "type": "integer" | 659 "TYPE_UNSPECIFIED", |
600 }, | 660 "CHILD_LINKED_SPAN", |
601 "sameProcessAsParentSpan": { | 661 "PARENT_LINKED_SPAN" |
602 "description": "A highly recommended but not required flag t
hat identifies when a trace\ncrosses a process boundary. True when the parent_sp
an belongs to the\nsame process as the current span.", | 662 ], |
603 "type": "boolean" | 663 "enumDescriptions": [ |
604 }, | 664 "The relationship of the two spans is unknown.", |
605 "status": { | 665 "The linked span is a child of the current span.", |
606 "$ref": "Status", | 666 "The linked span is a parent of the current span." |
607 "description": "An optional final status for this span." | 667 ], |
608 }, | |
609 "name": { | |
610 "description": "The resource name of the span in the followi
ng format:\n\n projects/[PROJECT_ID]traces/[TRACE_ID]/spans/SPAN_ID is a uniq
ue identifier for a trace within a project.\n[SPAN_ID] is a unique identifier fo
r a span within a trace,\nassigned when the span is created.", | |
611 "type": "string" | 668 "type": "string" |
612 }, | 669 }, |
613 "stackTrace": { | |
614 "$ref": "StackTrace", | |
615 "description": "Stack trace captured at the start of the spa
n." | |
616 }, | |
617 "parentSpanId": { | |
618 "description": "The [SPAN_ID] of this span's parent span. If
this is a root span,\nthen this field must be empty.", | |
619 "type": "string" | |
620 }, | |
621 "endTime": { | |
622 "description": "The end time of the span. On the client side
, this is the time kept by\nthe local machine where the span execution ends. On
the server side, this\nis the time when the server application handler stops run
ning.", | |
623 "format": "google-datetime", | |
624 "type": "string" | |
625 }, | |
626 "startTime": { | |
627 "description": "The start time of the span. On the client si
de, this is the time kept by\nthe local machine where the span execution starts.
On the server side, this\nis the time when the server's application handler sta
rts running.", | |
628 "format": "google-datetime", | |
629 "type": "string" | |
630 }, | |
631 "displayName": { | |
632 "$ref": "TruncatableString", | |
633 "description": "A description of the span's operation (up to
128 bytes).\nStackdriver Trace displays the description in the\n{% dynamic prin
t site_values.console_name %}.\nFor example, the display name can be a qualified
method name or a file name\nand a line number where the operation is called. A
best practice is to use\nthe same display name within an application and at the
same call point.\nThis makes it easier to correlate spans in different traces." | |
634 }, | |
635 "timeEvents": { | |
636 "$ref": "TimeEvents", | |
637 "description": "The included time events. There can be up to
32 annotations and 128 network\nevents per span." | |
638 }, | |
639 "links": { | |
640 "$ref": "Links", | |
641 "description": "A maximum of 128 links are allowed per Span.
" | |
642 }, | |
643 "attributes": { | 670 "attributes": { |
644 "$ref": "Attributes", | 671 "$ref": "Attributes", |
645 "description": "A set of attributes on the span. There is a
limit of 32 attributes per\nspan." | 672 "description": "A set of attributes on the link. There is a
limit of 32 attributes per\nlink." |
| 673 }, |
| 674 "traceId": { |
| 675 "description": "`TRACE_ID` identifies a trace within a proje
ct.", |
| 676 "type": "string" |
646 }, | 677 }, |
647 "spanId": { | 678 "spanId": { |
648 "description": "The [SPAN_ID] portion of the span's resource
name.", | 679 "description": "`SPAN_ID` identifies a span within a trace."
, |
649 "type": "string" | 680 "type": "string" |
650 } | 681 } |
651 }, | 682 }, |
652 "type": "object" | 683 "type": "object" |
653 }, | 684 }, |
654 "ListTracesResponse": { | 685 "Annotation": { |
655 "description": "The response message for the `ListTraces` method.", | 686 "description": "Text annotation with a set of attributes.", |
656 "id": "ListTracesResponse", | 687 "id": "Annotation", |
657 "properties": { | 688 "properties": { |
658 "nextPageToken": { | 689 "attributes": { |
659 "description": "If there might be more results than those ap
pearing in this response, then\n`next_page_token` is included. To get the next
set of results, call this\nmethod again using the value of `next_page_token` as
`page_token`.", | 690 "$ref": "Attributes", |
660 "type": "string" | 691 "description": "A set of attributes on the annotation. There
is a limit of 4 attributes\nper Annotation." |
661 }, | 692 }, |
662 "traces": { | 693 "description": { |
663 "description": "List of trace records returned.", | 694 "$ref": "TruncatableString", |
| 695 "description": "A user-supplied message describing the event
. The maximum length for\nthe description is 256 bytes." |
| 696 } |
| 697 }, |
| 698 "type": "object" |
| 699 }, |
| 700 "StackFrames": { |
| 701 "description": "A collection of stack frames, which can be truncated
.", |
| 702 "id": "StackFrames", |
| 703 "properties": { |
| 704 "droppedFramesCount": { |
| 705 "description": "The number of stack frames that were dropped
because there\nwere too many stack frames.\nIf this value is 0, then no stack f
rames were dropped.", |
| 706 "format": "int32", |
| 707 "type": "integer" |
| 708 }, |
| 709 "frame": { |
| 710 "description": "Stack frames in this call stack.", |
664 "items": { | 711 "items": { |
665 "$ref": "Trace" | 712 "$ref": "StackFrame" |
666 }, | 713 }, |
667 "type": "array" | 714 "type": "array" |
668 } | 715 } |
669 }, | 716 }, |
670 "type": "object" | 717 "type": "object" |
671 }, | 718 }, |
672 "AttributeValue": { | 719 "Trace": { |
673 "description": "The allowed types for [VALUE] in a `[KEY]:[VALUE]` a
ttribute.", | 720 "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.", |
674 "id": "AttributeValue", | 721 "id": "Trace", |
675 "properties": { | 722 "properties": { |
676 "intValue": { | 723 "name": { |
677 "description": "A 64-bit signed integer.", | 724 "description": "The resource name of the trace in the follow
ing format:\n\n projects/[PROJECT_ID]/traces/TRACE_ID is a unique identifier
for a trace within a project.\nThe ID is assigned when the trace is created.", |
678 "format": "int64", | |
679 "type": "string" | 725 "type": "string" |
680 }, | |
681 "boolValue": { | |
682 "description": "A Boolean value represented by `true` or `fa
lse`.", | |
683 "type": "boolean" | |
684 }, | |
685 "stringValue": { | |
686 "$ref": "TruncatableString", | |
687 "description": "A string up to 256 bytes long." | |
688 } | 726 } |
689 }, | 727 }, |
690 "type": "object" | 728 "type": "object" |
691 }, | |
692 "Attributes": { | |
693 "description": "A set of attributes, each in the format `[KEY]:[VALU
E]`.", | |
694 "id": "Attributes", | |
695 "properties": { | |
696 "droppedAttributesCount": { | |
697 "description": "The number of attributes that were discarded
. Attributes can be discarded\nbecause their keys are too long or because there
are too many attributes.\nIf this value is 0 then all attributes are valid.", | |
698 "format": "int32", | |
699 "type": "integer" | |
700 }, | |
701 "attributeMap": { | |
702 "additionalProperties": { | |
703 "$ref": "AttributeValue" | |
704 }, | |
705 "description": "The set of attributes. Each attribute's key
can be up to 128 bytes\nlong. The value can be a string up to 256 bytes, an inte
ger, or the\nBoolean values `true` and `false`. For example:\n\n \"/instance_
id\": \"my-instance\"\n \"/http/user_agent\": \"\"\n \"/http/request_bytes
\": 300\n \"abc.com/myattribute\": true", | |
706 "type": "object" | |
707 } | |
708 }, | |
709 "type": "object" | |
710 }, | |
711 "Links": { | |
712 "description": "A collection of links, which are references from thi
s span to a span\nin the same or different trace.", | |
713 "id": "Links", | |
714 "properties": { | |
715 "droppedLinksCount": { | |
716 "description": "The number of dropped links after the maximu
m size was enforced. If\nthis value is 0, then no links were dropped.", | |
717 "format": "int32", | |
718 "type": "integer" | |
719 }, | |
720 "link": { | |
721 "description": "A collection of links.", | |
722 "items": { | |
723 "$ref": "Link" | |
724 }, | |
725 "type": "array" | |
726 } | |
727 }, | |
728 "type": "object" | |
729 } | 729 } |
730 }, | 730 }, |
731 "servicePath": "", | 731 "servicePath": "", |
732 "title": "Stackdriver Trace API", | 732 "title": "Stackdriver Trace API", |
733 "version": "v2" | 733 "version": "v2" |
734 } | 734 } |
OLD | NEW |