v1.d.ts
26.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { GaxiosPromise } from 'gaxios';
import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library';
import { APIRequestContext, BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common';
export declare namespace cloudtrace_v1 {
interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API
* access, quota, and reports. Required unless you provide an OAuth 2.0
* token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be
* any arbitrary string assigned to a user, but should not exceed 40
* characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Stackdriver Trace API
*
* Sends application trace data to Stackdriver Trace for viewing. Trace data
* is collected for all App Engine applications by default. Trace data from
* other applications can be provided using this API. This library is used to
* interact with the Trace API directly. If you are looking to instrument your
* application for Stackdriver Trace, we recommend using OpenCensus.
*
* @example
* const {google} = require('googleapis');
* const cloudtrace = google.cloudtrace('v1');
*
* @namespace cloudtrace
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Cloudtrace
*/
class Cloudtrace {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* A generic empty message that you can re-use to avoid defining duplicated
* empty messages in your APIs. A typical example is to use it as the request
* or the response type of an API method. For instance: service Foo { rpc
* Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
* representation for `Empty` is empty JSON object `{}`.
*/
interface Schema$Empty {
}
/**
* The response message for the `ListTraces` method.
*/
interface Schema$ListTracesResponse {
/**
* If defined, indicates that there are more traces that match the request
* and that this value should be passed to the next request to continue
* retrieving additional traces.
*/
nextPageToken?: string;
/**
* List of trace records as specified by the view parameter.
*/
traces?: Schema$Trace[];
}
/**
* A trace describes how long it takes for an application to perform an
* operation. It consists of a set of spans, each of which represent a single
* timed event within the operation.
*/
interface Schema$Trace {
/**
* Project ID of the Cloud project where the trace data is stored.
*/
projectId?: string;
/**
* Collection of spans in the trace.
*/
spans?: Schema$TraceSpan[];
/**
* Globally unique identifier for the trace. This identifier is a 128-bit
* numeric value formatted as a 32-byte hex string. For example,
* `382d4f4c6b7bb2f4a972559d9085001d`.
*/
traceId?: string;
}
/**
* List of new or updated traces.
*/
interface Schema$Traces {
/**
* List of traces.
*/
traces?: Schema$Trace[];
}
/**
* A span represents a single timed event within a trace. Spans can be nested
* and form a trace tree. Often, a trace contains a root span that describes
* the end-to-end latency of an operation and, optionally, one or more
* subspans for its suboperations. Spans do not need to be contiguous. There
* may be gaps between spans in a trace.
*/
interface Schema$TraceSpan {
/**
* End time of the span in nanoseconds from the UNIX epoch.
*/
endTime?: string;
/**
* Distinguishes between spans generated in a particular context. For
* example, two spans with the same name may be distinguished using
* `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated
* with the span.
*/
kind?: string;
/**
* Collection of labels associated with the span. Label keys must be less
* than 128 bytes. Label values must be less than 16 kilobytes (10MB for
* `/stacktrace` values). Some predefined label keys exist, or you may
* create your own. When creating your own, we recommend the following
* formats: * `/category/product/key` for agents of well-known products
* (e.g. `/db/mongodb/read_size`). * `short_host/path/key` for
* domain-specific keys (e.g. `foo.com/myproduct/bar`) Predefined labels
* include: * `/agent` * `/component` * `/error/message` *
* `/error/name` * `/http/client_city` * `/http/client_country` *
* `/http/client_protocol` * `/http/client_region` * `/http/host` *
* `/http/method` * `/http/path` * `/http/redirected_url` *
* `/http/request/size` * `/http/response/size` * `/http/route` *
* `/http/status_code` * `/http/url` * `/http/user_agent` * `/pid` *
* `/stacktrace` * `/tid`
*/
labels?: {
[key: string]: string;
};
/**
* Name of the span. Must be less than 128 bytes. The span name is sanitized
* and displayed in the Stackdriver Trace tool in the Google Cloud Platform
* Console. The name may be a method name or some other per-call site name.
* For the same executable and the same call point, a best practice is to
* use a consistent name, which makes it easier to correlate cross-trace
* spans.
*/
name?: string;
/**
* ID of the parent span, if any. Optional.
*/
parentSpanId?: string;
/**
* Identifier for the span. Must be a 64-bit integer other than 0 and unique
* within a trace. For example, `2205310701640571284`.
*/
spanId?: string;
/**
* Start time of the span in nanoseconds from the UNIX epoch.
*/
startTime?: string;
}
class Resource$Projects {
context: APIRequestContext;
traces: Resource$Projects$Traces;
constructor(context: APIRequestContext);
/**
* cloudtrace.projects.patchTraces
* @desc Sends new traces to Stackdriver Trace or updates existing traces.
* If the ID of a trace that you send matches that of an existing trace, any
* fields in the existing trace and its spans are overwritten by the
* provided values, and any new fields provided are merged with the existing
* trace data. If the ID does not match, a new trace is created.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Stackdriver Trace API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/cloudtrace
* // 2. This sample uses Application Default Credentials for
* authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var cloudTrace = google.cloudtrace('v1');
*
* authorize(function(authClient) {
* var request = {
* // ID of the Cloud project where the trace data is stored.
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body. Only these
* properties
* // will be changed.
* },
*
* auth: authClient,
* };
*
* cloudTrace.projects.patchTraces(request, function(err) {
* if (err) {
* console.error(err);
* return;
* }
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias cloudtrace.projects.patchTraces
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.projectId ID of the Cloud project where the trace data is stored.
* @param {().Traces} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patchTraces(params?: Params$Resource$Projects$Patchtraces, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
patchTraces(params: Params$Resource$Projects$Patchtraces, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
patchTraces(params: Params$Resource$Projects$Patchtraces, callback: BodyResponseCallback<Schema$Empty>): void;
patchTraces(callback: BodyResponseCallback<Schema$Empty>): void;
}
interface Params$Resource$Projects$Patchtraces extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* ID of the Cloud project where the trace data is stored.
*/
projectId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Traces;
}
class Resource$Projects$Traces {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* cloudtrace.projects.traces.get
* @desc Gets a single trace by its ID.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Stackdriver Trace API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/cloudtrace
* // 2. This sample uses Application Default Credentials for
* authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var cloudTrace = google.cloudtrace('v1');
*
* authorize(function(authClient) {
* var request = {
* // ID of the Cloud project where the trace data is stored.
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* // ID of the trace to return.
* traceId: 'my-trace-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* cloudTrace.projects.traces.get(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias cloudtrace.projects.traces.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.projectId ID of the Cloud project where the trace data is stored.
* @param {string} params.traceId ID of the trace to return.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Traces$Get, options?: MethodOptions): GaxiosPromise<Schema$Trace>;
get(params: Params$Resource$Projects$Traces$Get, options: MethodOptions | BodyResponseCallback<Schema$Trace>, callback: BodyResponseCallback<Schema$Trace>): void;
get(params: Params$Resource$Projects$Traces$Get, callback: BodyResponseCallback<Schema$Trace>): void;
get(callback: BodyResponseCallback<Schema$Trace>): void;
/**
* cloudtrace.projects.traces.list
* @desc Returns of a list of traces that match the specified filter
* conditions.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Stackdriver Trace API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/cloudtrace
* // 2. This sample uses Application Default Credentials for
* authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var cloudTrace = google.cloudtrace('v1');
*
* authorize(function(authClient) {
* var request = {
* // ID of the Cloud project where the trace data is stored.
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* var handlePage = function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* var tracesPage = response['traces'];
* if (!tracesPage) {
* return;
* }
* for (var i = 0; i < tracesPage.length; i++) {
* // TODO: Change code below to process each resource in
* `tracesPage`: console.log(JSON.stringify(tracesPage[i], null, 2));
* }
*
* if (response.nextPageToken) {
* request.pageToken = response.nextPageToken;
* cloudTrace.projects.traces.list(request, handlePage);
* }
* };
*
* cloudTrace.projects.traces.list(request, handlePage);
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias cloudtrace.projects.traces.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.endTime End of the time interval (inclusive) during which the trace data was collected from the application.
* @param {string=} params.filter An optional filter against labels for the request. By default, searches use prefix matching. To specify exact match, prepend a plus symbol (`+`) to the search term. Multiple terms are ANDed. Syntax: * `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root span starts with `NAME_PREFIX`. * `+root:NAME` or `+NAME`: Return traces where any root span's name is exactly `NAME`. * `span:NAME_PREFIX`: Return traces where any span starts with `NAME_PREFIX`. * `+span:NAME`: Return traces where any span's name is exactly `NAME`. * `latency:DURATION`: Return traces whose overall latency is greater or equal to than `DURATION`. Accepted units are nanoseconds (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For example, `latency:24ms` returns traces whose overall latency is greater than or equal to 24 milliseconds. * `label:LABEL_KEY`: Return all traces containing the specified label key (exact match, case-sensitive) regardless of the key:value pair's value (including empty values). * `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified label key (exact match, case-sensitive) whose value starts with `VALUE_PREFIX`. Both a key and a value must be specified. * `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair exactly matching the specified text. Both a key and a value must be specified. * `method:VALUE`: Equivalent to `/http/method:VALUE`. * `url:VALUE`: Equivalent to `/http/url:VALUE`.
* @param {string=} params.orderBy Field used to sort the returned traces. Optional. Can be one of the following: * `trace_id` * `name` (`name` field of root span in the trace) * `duration` (difference between `end_time` and `start_time` fields of the root span) * `start` (`start_time` field of the root span) Descending order can be specified by appending `desc` to the sort field (for example, `name desc`). Only one sort field is permitted.
* @param {integer=} params.pageSize Maximum number of traces to return. If not specified or <= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size. Optional.
* @param {string=} params.pageToken Token identifying the page of results to return. If provided, use the value of the `next_page_token` field from a previous request. Optional.
* @param {string} params.projectId ID of the Cloud project where the trace data is stored.
* @param {string=} params.startTime Start of the time interval (inclusive) during which the trace data was collected from the application.
* @param {string=} params.view Type of data returned for traces in the list. Optional. Default is `MINIMAL`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Traces$List, options?: MethodOptions): GaxiosPromise<Schema$ListTracesResponse>;
list(params: Params$Resource$Projects$Traces$List, options: MethodOptions | BodyResponseCallback<Schema$ListTracesResponse>, callback: BodyResponseCallback<Schema$ListTracesResponse>): void;
list(params: Params$Resource$Projects$Traces$List, callback: BodyResponseCallback<Schema$ListTracesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListTracesResponse>): void;
}
interface Params$Resource$Projects$Traces$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* ID of the Cloud project where the trace data is stored.
*/
projectId?: string;
/**
* ID of the trace to return.
*/
traceId?: string;
}
interface Params$Resource$Projects$Traces$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* End of the time interval (inclusive) during which the trace data was
* collected from the application.
*/
endTime?: string;
/**
* An optional filter against labels for the request. By default, searches
* use prefix matching. To specify exact match, prepend a plus symbol (`+`)
* to the search term. Multiple terms are ANDed. Syntax: *
* `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root span
* starts with `NAME_PREFIX`. * `+root:NAME` or `+NAME`: Return traces
* where any root span's name is exactly `NAME`. * `span:NAME_PREFIX`:
* Return traces where any span starts with `NAME_PREFIX`. *
* `+span:NAME`: Return traces where any span's name is exactly `NAME`.
* * `latency:DURATION`: Return traces whose overall latency is greater or
* equal to than `DURATION`. Accepted units are nanoseconds (`ns`),
* milliseconds (`ms`), and seconds (`s`). Default is `ms`. For example,
* `latency:24ms` returns traces whose overall latency is greater than
* or equal to 24 milliseconds. * `label:LABEL_KEY`: Return all traces
* containing the specified label key (exact match, case-sensitive)
* regardless of the key:value pair's value (including empty values). *
* `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified
* label key (exact match, case-sensitive) whose value starts with
* `VALUE_PREFIX`. Both a key and a value must be specified. *
* `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair exactly
* matching the specified text. Both a key and a value must be specified. *
* `method:VALUE`: Equivalent to `/http/method:VALUE`. * `url:VALUE`:
* Equivalent to `/http/url:VALUE`.
*/
filter?: string;
/**
* Field used to sort the returned traces. Optional. Can be one of the
* following: * `trace_id` * `name` (`name` field of root span in the
* trace) * `duration` (difference between `end_time` and `start_time`
* fields of the root span) * `start` (`start_time` field of the root
* span) Descending order can be specified by appending `desc` to the sort
* field (for example, `name desc`). Only one sort field is permitted.
*/
orderBy?: string;
/**
* Maximum number of traces to return. If not specified or <= 0, the
* implementation selects a reasonable value. The implementation may return
* fewer traces than the requested page size. Optional.
*/
pageSize?: number;
/**
* Token identifying the page of results to return. If provided, use the
* value of the `next_page_token` field from a previous request. Optional.
*/
pageToken?: string;
/**
* ID of the Cloud project where the trace data is stored.
*/
projectId?: string;
/**
* Start of the time interval (inclusive) during which the trace data was
* collected from the application.
*/
startTime?: string;
/**
* Type of data returned for traces in the list. Optional. Default is
* `MINIMAL`.
*/
view?: string;
}
}