Skip to content

Commit 14d3265

Browse files
feat: Support telemetry enabled request config and fix SDK metadata
1 parent b82549d commit 14d3265

5 files changed

Lines changed: 58 additions & 32 deletions

File tree

.stats.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 112
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-e9c99662d29710f105847d461f8919e06f6aa2e43b0e1a6285d0b137643a7907.yml
3-
openapi_spec_hash: 4415cb4790c7a5ec892f4e3521217cb4
4-
config_hash: 27b38657d9a3b33328be930eeb319628
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-0a186c486b56f555cab374ea5f2adbef2d718b5c9190a48c862f0fdf1232324f.yml
3+
openapi_spec_hash: fad386b8e8712e6639ed9689e9dfc070
4+
config_hash: 5dde8b5de321a7bb96f695a69eb21c23

api.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,6 @@ Types:
119119
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserTelemetryCategoryConfig</a></code>
120120
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserTelemetryConfig</a></code>
121121
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserTelemetryEvent</a></code>
122-
- <code><a href="./src/resources/browsers/telemetry.ts">BrowserTelemetryRequestConfig</a></code>
123122
- <code><a href="./src/resources/browsers/telemetry.ts">TelemetryStreamResponse</a></code>
124123

125124
Methods:

src/resources/browsers/browsers.ts

Lines changed: 55 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,7 @@ import {
8383
BrowserTelemetryCategoryConfig,
8484
BrowserTelemetryConfig,
8585
BrowserTelemetryEvent,
86-
BrowserTelemetryRequestConfig,
87-
Telemetry,
86+
Telemetry as TelemetryAPITelemetry,
8887
TelemetryStreamParams,
8988
TelemetryStreamResponse,
9089
} from './telemetry';
@@ -899,7 +898,7 @@ export interface BrowserCreateParams {
899898
* category settings, or all four categories are explicitly disabled, capture is
900899
* not started.
901900
*/
902-
telemetry?: TelemetryAPI.BrowserTelemetryRequestConfig | null;
901+
telemetry?: BrowserCreateParams.Telemetry | null;
903902

904903
/**
905904
* The number of seconds of inactivity before the browser session is terminated.
@@ -927,6 +926,32 @@ export interface BrowserCreateParams {
927926
viewport?: Shared.BrowserViewport;
928927
}
929928

929+
export namespace BrowserCreateParams {
930+
/**
931+
* Telemetry configuration for the browser session. Set enabled to true to start
932+
* capture using VM defaults, or provide browser category settings. If omitted,
933+
* null, set to an empty object ({}), set to enabled: false without browser
934+
* category settings, or all four categories are explicitly disabled, capture is
935+
* not started.
936+
*/
937+
export interface Telemetry {
938+
/**
939+
* Per-category enable/disable flags. If enabled is true and browser is omitted or
940+
* empty, the VM default category set is used. Explicitly disabling all four
941+
* categories stops capture on update and starts no capture on create.
942+
*/
943+
browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
944+
945+
/**
946+
* Request shortcut for browser telemetry capture. True enables capture using VM
947+
* defaults unless browser category settings are provided. False stops capture on
948+
* update and starts no capture on create. enabled=false cannot be combined with
949+
* browser category settings.
950+
*/
951+
enabled?: boolean;
952+
}
953+
}
954+
930955
export interface BrowserRetrieveParams {
931956
/**
932957
* When true, includes soft-deleted browser sessions in the lookup.
@@ -960,7 +985,7 @@ export interface BrowserUpdateParams {
960985
* category settings for per-category updates. Explicitly disabling all four
961986
* categories also stops capture.
962987
*/
963-
telemetry?: TelemetryAPI.BrowserTelemetryRequestConfig | null;
988+
telemetry?: BrowserUpdateParams.Telemetry | null;
964989

965990
/**
966991
* Viewport configuration to apply to the browser session.
@@ -969,6 +994,30 @@ export interface BrowserUpdateParams {
969994
}
970995

971996
export namespace BrowserUpdateParams {
997+
/**
998+
* Telemetry configuration. Omit, set to null, or set to an empty object ({}) to
999+
* leave the existing configuration unchanged. Set enabled to true to enable
1000+
* capture using VM defaults. Set enabled to false to stop capture. Provide browser
1001+
* category settings for per-category updates. Explicitly disabling all four
1002+
* categories also stops capture.
1003+
*/
1004+
export interface Telemetry {
1005+
/**
1006+
* Per-category enable/disable flags. If enabled is true and browser is omitted or
1007+
* empty, the VM default category set is used. Explicitly disabling all four
1008+
* categories stops capture on update and starts no capture on create.
1009+
*/
1010+
browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
1011+
1012+
/**
1013+
* Request shortcut for browser telemetry capture. True enables capture using VM
1014+
* defaults unless browser category settings are provided. False stops capture on
1015+
* update and starts no capture on create. enabled=false cannot be combined with
1016+
* browser category settings.
1017+
*/
1018+
enabled?: boolean;
1019+
}
1020+
9721021
/**
9731022
* Viewport configuration to apply to the browser session.
9741023
*/
@@ -1056,7 +1105,7 @@ export namespace BrowserLoadExtensionsParams {
10561105
}
10571106
}
10581107

1059-
Browsers.Telemetry = Telemetry;
1108+
Browsers.Telemetry = TelemetryAPITelemetry;
10601109
Browsers.Replays = Replays;
10611110
Browsers.Fs = Fs;
10621111
Browsers.Process = Process;
@@ -1084,7 +1133,7 @@ export declare namespace Browsers {
10841133
};
10851134

10861135
export {
1087-
Telemetry as Telemetry,
1136+
TelemetryAPITelemetry as Telemetry,
10881137
type BrowserCallStack as BrowserCallStack,
10891138
type BrowserConsoleErrorEvent as BrowserConsoleErrorEvent,
10901139
type BrowserConsoleLogEvent as BrowserConsoleLogEvent,
@@ -1115,7 +1164,6 @@ export declare namespace Browsers {
11151164
type BrowserTelemetryCategoryConfig as BrowserTelemetryCategoryConfig,
11161165
type BrowserTelemetryConfig as BrowserTelemetryConfig,
11171166
type BrowserTelemetryEvent as BrowserTelemetryEvent,
1118-
type BrowserTelemetryRequestConfig as BrowserTelemetryRequestConfig,
11191167
type TelemetryStreamResponse as TelemetryStreamResponse,
11201168
type TelemetryStreamParams as TelemetryStreamParams,
11211169
};

src/resources/browsers/index.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,6 @@ export {
111111
type BrowserTelemetryCategoryConfig,
112112
type BrowserTelemetryConfig,
113113
type BrowserTelemetryEvent,
114-
type BrowserTelemetryRequestConfig,
115114
type TelemetryStreamResponse,
116115
type TelemetryStreamParams,
117116
} from './telemetry';

src/resources/browsers/telemetry.ts

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1452,25 +1452,6 @@ export type BrowserTelemetryEvent =
14521452
| BrowserMonitorReconnectFailedEvent
14531453
| BrowserMonitorInitFailedEvent;
14541454

1455-
/**
1456-
* Telemetry request configuration for a browser session.
1457-
*/
1458-
export interface BrowserTelemetryRequestConfig {
1459-
/**
1460-
* Per-category enable/disable flags. If enabled is true and browser is omitted or
1461-
* empty, the VM default category set is used. Explicitly disabling all four
1462-
* categories stops capture on update and starts no capture on create.
1463-
*/
1464-
browser?: BrowserTelemetryCategoriesConfig;
1465-
1466-
/**
1467-
* Request shortcut for browser telemetry capture. True enables capture using VM
1468-
* defaults. False stops capture on update and starts no capture on create. Cannot
1469-
* be combined with browser category settings.
1470-
*/
1471-
enabled?: boolean;
1472-
}
1473-
14741455
/**
14751456
* Envelope wrapping a browser telemetry event with its monotonic sequence number.
14761457
* Each SSE data: frame carries one envelope as JSON. The seq value is also emitted
@@ -1534,7 +1515,6 @@ export declare namespace Telemetry {
15341515
type BrowserTelemetryCategoryConfig as BrowserTelemetryCategoryConfig,
15351516
type BrowserTelemetryConfig as BrowserTelemetryConfig,
15361517
type BrowserTelemetryEvent as BrowserTelemetryEvent,
1537-
type BrowserTelemetryRequestConfig as BrowserTelemetryRequestConfig,
15381518
type TelemetryStreamResponse as TelemetryStreamResponse,
15391519
type TelemetryStreamParams as TelemetryStreamParams,
15401520
};

0 commit comments

Comments
 (0)