v2.d.ts
25.8 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
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace cloudtrace_v2 {
export interface Options extends GlobalOptions {
version: 'v2';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* 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;
}
/**
* Cloud Trace API
*
* Sends application trace data to Cloud 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 Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenCensus.
*
* @example
* ```js
* const {google} = require('googleapis');
* const cloudtrace = google.cloudtrace('v2');
* ```
*/
export class Cloudtrace {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Text annotation with a set of attributes.
*/
export interface Schema$Annotation {
/**
* A set of attributes on the annotation. You can have up to 4 attributes per Annotation.
*/
attributes?: Schema$Attributes;
/**
* A user-supplied message describing the event. The maximum length for the description is 256 bytes.
*/
description?: Schema$TruncatableString;
}
/**
* A set of attributes, each in the format `[KEY]:[VALUE]`.
*/
export interface Schema$Attributes {
/**
* The set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the Boolean values `true` and `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" \} \} "/http/request_bytes": { "int_value": 300 \} "abc.com/myattribute": { "bool_value": false \}
*/
attributeMap?: {
[key: string]: Schema$AttributeValue;
} | null;
/**
* The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid.
*/
droppedAttributesCount?: number | null;
}
/**
* The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.
*/
export interface Schema$AttributeValue {
/**
* A Boolean value represented by `true` or `false`.
*/
boolValue?: boolean | null;
/**
* A 64-bit signed integer.
*/
intValue?: string | null;
/**
* A string up to 256 bytes long.
*/
stringValue?: Schema$TruncatableString;
}
/**
* The request message for the `BatchWriteSpans` method.
*/
export interface Schema$BatchWriteSpansRequest {
/**
* Required. A list of new spans. The span names must not match existing spans, or the results are undefined.
*/
spans?: Schema$Span[];
}
/**
* 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 `{\}`.
*/
export interface Schema$Empty {
}
/**
* A pointer from the current span to another span in the same trace or in a different trace. For example, this can be used in batching operations, where a single batch handler processes multiple requests from different traces or when the handler receives a request from a different project.
*/
export interface Schema$Link {
/**
* A set of attributes on the link. You have have up to 32 attributes per link.
*/
attributes?: Schema$Attributes;
/**
* The [SPAN_ID] for a span within a trace.
*/
spanId?: string | null;
/**
* The [TRACE_ID] for a trace within a project.
*/
traceId?: string | null;
/**
* The relationship of the current span relative to the linked span.
*/
type?: string | null;
}
/**
* A collection of links, which are references from this span to a span in the same or different trace.
*/
export interface Schema$Links {
/**
* The number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.
*/
droppedLinksCount?: number | null;
/**
* A collection of links.
*/
link?: Schema$Link[];
}
/**
* An event describing a message sent/received between Spans.
*/
export interface Schema$MessageEvent {
/**
* The number of compressed bytes sent or received. If missing assumed to be the same size as uncompressed.
*/
compressedSizeBytes?: string | null;
/**
* An identifier for the MessageEvent's message that can be used to match SENT and RECEIVED MessageEvents. It is recommended to be unique within a Span.
*/
id?: string | null;
/**
* Type of MessageEvent. Indicates whether the message was sent or received.
*/
type?: string | null;
/**
* The number of uncompressed bytes sent or received.
*/
uncompressedSizeBytes?: string | null;
}
/**
* Binary module.
*/
export interface Schema$Module {
/**
* A unique identifier for the module, usually a hash of its contents (up to 128 bytes).
*/
buildId?: Schema$TruncatableString;
/**
* For example: main binary, kernel modules, and dynamic libraries such as libc.so, sharedlib.so (up to 256 bytes).
*/
module?: Schema$TruncatableString;
}
/**
* A span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency, and one or more subspans for its sub-operations. A trace can also contain multiple root spans, or none at all. Spans do not need to be contiguous—there may be gaps or overlaps between spans in a trace.
*/
export interface Schema$Span {
/**
* A set of attributes on the span. You can have up to 32 attributes per span.
*/
attributes?: Schema$Attributes;
/**
* Optional. The number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans.
*/
childSpanCount?: number | null;
/**
* Required. A description of the span's operation (up to 128 bytes). Trace displays the description in the Google Cloud Platform Console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces.
*/
displayName?: Schema$TruncatableString;
/**
* Required. The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.
*/
endTime?: string | null;
/**
* Links associated with the span. You can have up to 128 links per Span.
*/
links?: Schema$Links;
/**
* Required. The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero.
*/
name?: string | null;
/**
* The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty.
*/
parentSpanId?: string | null;
/**
* Optional. Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Trace is unable to take advantage of this helpful information.
*/
sameProcessAsParentSpan?: boolean | null;
/**
* Required. The [SPAN_ID] portion of the span's resource name.
*/
spanId?: string | null;
/**
* Optional. Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `CLIENT` (caller) and `SERVER` (callee) to identify an RPC call.
*/
spanKind?: string | null;
/**
* Stack trace captured at the start of the span.
*/
stackTrace?: Schema$StackTrace;
/**
* Required. The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running.
*/
startTime?: string | null;
/**
* Optional. The final status for this span.
*/
status?: Schema$Status;
/**
* A set of time events. You can have up to 32 annotations and 128 message events per span.
*/
timeEvents?: Schema$TimeEvents;
}
/**
* Represents a single stack frame in a stack trace.
*/
export interface Schema$StackFrame {
/**
* The column number where the function call appears, if available. This is important in JavaScript because of its anonymous functions.
*/
columnNumber?: string | null;
/**
* The name of the source file where the function call appears (up to 256 bytes).
*/
fileName?: Schema$TruncatableString;
/**
* The fully-qualified name that uniquely identifies the function or method that is active in this frame (up to 1024 bytes).
*/
functionName?: Schema$TruncatableString;
/**
* The line number in `file_name` where the function call appears.
*/
lineNumber?: string | null;
/**
* The binary module from where the code was loaded.
*/
loadModule?: Schema$Module;
/**
* An un-mangled function name, if `function_name` is [mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can be fully-qualified (up to 1024 bytes).
*/
originalFunctionName?: Schema$TruncatableString;
/**
* The version of the deployed source code (up to 128 bytes).
*/
sourceVersion?: Schema$TruncatableString;
}
/**
* A collection of stack frames, which can be truncated.
*/
export interface Schema$StackFrames {
/**
* The number of stack frames that were dropped because there were too many stack frames. If this value is 0, then no stack frames were dropped.
*/
droppedFramesCount?: number | null;
/**
* Stack frames in this call stack.
*/
frame?: Schema$StackFrame[];
}
/**
* A call stack appearing in a trace.
*/
export interface Schema$StackTrace {
/**
* Stack frames in this stack trace. A maximum of 128 frames are allowed.
*/
stackFrames?: Schema$StackFrames;
/**
* The hash ID is used to conserve network bandwidth for duplicate stack traces within a single trace. Often multiple spans will have identical stack traces. The first occurrence of a stack trace should contain both the `stackFrame` content and a value in `stackTraceHashId`. Subsequent spans within the same request can refer to that stack trace by only setting `stackTraceHashId`.
*/
stackTraceHashId?: string | null;
}
/**
* The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string | null;
}
/**
* A time-stamped annotation or message event in the Span.
*/
export interface Schema$TimeEvent {
/**
* Text annotation with a set of attributes.
*/
annotation?: Schema$Annotation;
/**
* An event describing a message sent/received between Spans.
*/
messageEvent?: Schema$MessageEvent;
/**
* The timestamp indicating the time the event occurred.
*/
time?: string | null;
}
/**
* A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation on the span, consisting of either user-supplied key:value pairs, or details of a message sent/received between Spans.
*/
export interface Schema$TimeEvents {
/**
* The number of dropped annotations in all the included time events. If the value is 0, then no annotations were dropped.
*/
droppedAnnotationsCount?: number | null;
/**
* The number of dropped message events in all the included time events. If the value is 0, then no message events were dropped.
*/
droppedMessageEventsCount?: number | null;
/**
* A collection of `TimeEvent`s.
*/
timeEvent?: Schema$TimeEvent[];
}
/**
* Represents a string that might be shortened to a specified length.
*/
export interface Schema$TruncatableString {
/**
* The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
*/
truncatedByteCount?: number | null;
/**
* The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.
*/
value?: string | null;
}
export class Resource$Projects {
context: APIRequestContext;
traces: Resource$Projects$Traces;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Traces {
context: APIRequestContext;
spans: Resource$Projects$Traces$Spans;
constructor(context: APIRequestContext);
/**
* Sends new spans to new or existing traces. You cannot update existing spans.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudtrace.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudtrace = google.cloudtrace('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/trace.append',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudtrace.projects.traces.batchWrite({
* // Required. The name of the project where the spans belong. The format is `projects/[PROJECT_ID]`.
* name: 'projects/my-project',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "spans": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
batchWrite(params: Params$Resource$Projects$Traces$Batchwrite, options: StreamMethodOptions): GaxiosPromise<Readable>;
batchWrite(params?: Params$Resource$Projects$Traces$Batchwrite, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
batchWrite(params: Params$Resource$Projects$Traces$Batchwrite, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
batchWrite(params: Params$Resource$Projects$Traces$Batchwrite, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
batchWrite(params: Params$Resource$Projects$Traces$Batchwrite, callback: BodyResponseCallback<Schema$Empty>): void;
batchWrite(callback: BodyResponseCallback<Schema$Empty>): void;
}
export interface Params$Resource$Projects$Traces$Batchwrite extends StandardParameters {
/**
* Required. The name of the project where the spans belong. The format is `projects/[PROJECT_ID]`.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$BatchWriteSpansRequest;
}
export class Resource$Projects$Traces$Spans {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Creates a new span.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/cloudtrace.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const cloudtrace = google.cloudtrace('v2');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/trace.append',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await cloudtrace.projects.traces.spans.createSpan({
* // Required. The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero.
* name: 'projects/my-project/traces/my-trace/spans/my-span',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "attributes": {},
* // "childSpanCount": 0,
* // "displayName": {},
* // "endTime": "my_endTime",
* // "links": {},
* // "name": "my_name",
* // "parentSpanId": "my_parentSpanId",
* // "sameProcessAsParentSpan": false,
* // "spanId": "my_spanId",
* // "spanKind": "my_spanKind",
* // "stackTrace": {},
* // "startTime": "my_startTime",
* // "status": {},
* // "timeEvents": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "attributes": {},
* // "childSpanCount": 0,
* // "displayName": {},
* // "endTime": "my_endTime",
* // "links": {},
* // "name": "my_name",
* // "parentSpanId": "my_parentSpanId",
* // "sameProcessAsParentSpan": false,
* // "spanId": "my_spanId",
* // "spanKind": "my_spanKind",
* // "stackTrace": {},
* // "startTime": "my_startTime",
* // "status": {},
* // "timeEvents": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
createSpan(params: Params$Resource$Projects$Traces$Spans$Createspan, options: StreamMethodOptions): GaxiosPromise<Readable>;
createSpan(params?: Params$Resource$Projects$Traces$Spans$Createspan, options?: MethodOptions): GaxiosPromise<Schema$Span>;
createSpan(params: Params$Resource$Projects$Traces$Spans$Createspan, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
createSpan(params: Params$Resource$Projects$Traces$Spans$Createspan, options: MethodOptions | BodyResponseCallback<Schema$Span>, callback: BodyResponseCallback<Schema$Span>): void;
createSpan(params: Params$Resource$Projects$Traces$Spans$Createspan, callback: BodyResponseCallback<Schema$Span>): void;
createSpan(callback: BodyResponseCallback<Schema$Span>): void;
}
export interface Params$Resource$Projects$Traces$Spans$Createspan extends StandardParameters {
/**
* Required. The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Span;
}
export {};
}