test-wuying-agentbay-sdk 0.13.1-beta.20251224103203 → 0.13.1-beta.20251224113236
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +87 -23
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.mts +42 -1
- package/dist/index.d.ts +42 -1
- package/dist/index.mjs +64 -0
- package/dist/index.mjs.map +1 -1
- package/docs/api/common-features/basics/session.md +0 -2
- package/docs/examples/README.md +1 -0
- package/docs/examples/common-features/advanced/session-metrics/README.md +19 -0
- package/docs/examples/common-features/advanced/session-metrics/main.ts +33 -0
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -156,6 +156,29 @@ interface OperationResult extends ApiResponse {
|
|
|
156
156
|
/** Optional error message if the operation failed */
|
|
157
157
|
errorMessage?: string;
|
|
158
158
|
}
|
|
159
|
+
/**
|
|
160
|
+
* Structured runtime metrics returned by Session.getMetrics().
|
|
161
|
+
*/
|
|
162
|
+
interface SessionMetrics {
|
|
163
|
+
cpuCount: number;
|
|
164
|
+
cpuUsedPct: number;
|
|
165
|
+
diskTotal: number;
|
|
166
|
+
diskUsed: number;
|
|
167
|
+
memTotal: number;
|
|
168
|
+
memUsed: number;
|
|
169
|
+
rxRateKBps: number;
|
|
170
|
+
txRateKBps: number;
|
|
171
|
+
rxUsedKB: number;
|
|
172
|
+
txUsedKB: number;
|
|
173
|
+
timestamp: string;
|
|
174
|
+
}
|
|
175
|
+
/**
|
|
176
|
+
* Result of Session.getMetrics() operation.
|
|
177
|
+
*/
|
|
178
|
+
interface SessionMetricsResult extends OperationResult {
|
|
179
|
+
data?: SessionMetrics;
|
|
180
|
+
raw?: Record<string, any>;
|
|
181
|
+
}
|
|
159
182
|
/**
|
|
160
183
|
* Interface for process list operation responses
|
|
161
184
|
* Corresponds to Python's ProcessListResult type
|
|
@@ -6511,6 +6534,24 @@ declare class Session {
|
|
|
6511
6534
|
* This improves case compatibility (e.g., "CTRL" -> "Ctrl", "tab" -> "Tab").
|
|
6512
6535
|
*/
|
|
6513
6536
|
callMcpTool(toolName: string, args: any, autoGenSession?: boolean): Promise<McpToolResult>;
|
|
6537
|
+
/**
|
|
6538
|
+
* Get runtime metrics for this session via the MCP get_metrics tool.
|
|
6539
|
+
*
|
|
6540
|
+
* The underlying MCP tool returns a JSON string. This method parses it and
|
|
6541
|
+
* returns a structured result.
|
|
6542
|
+
*
|
|
6543
|
+
* @example
|
|
6544
|
+
* ```typescript
|
|
6545
|
+
* const agentBay = new AgentBay({ apiKey: "your_api_key" });
|
|
6546
|
+
* const create = await agentBay.create({ imageId: "linux_latest" });
|
|
6547
|
+
* if (create.success && create.session) {
|
|
6548
|
+
* const metrics = await create.session.getMetrics();
|
|
6549
|
+
* console.log(metrics.data);
|
|
6550
|
+
* await create.session.delete();
|
|
6551
|
+
* }
|
|
6552
|
+
* ```
|
|
6553
|
+
*/
|
|
6554
|
+
getMetrics(): Promise<SessionMetricsResult>;
|
|
6514
6555
|
/**
|
|
6515
6556
|
* Asynchronously pause this session, putting it into a dormant state.
|
|
6516
6557
|
*
|
|
@@ -7755,4 +7796,4 @@ declare function logWarn(message: string, ...args: any[]): void;
|
|
|
7755
7796
|
*/
|
|
7756
7797
|
declare function logError(message: string, error?: any): void;
|
|
7757
7798
|
|
|
7758
|
-
export { APIError, APP_BLACKLIST_TEMPLATE, APP_WHITELIST_TEMPLATE, type ActOptions, ActResult, Agent, AgentBay, AgentBayError, type AgentOptions, type ApiResponse, type ApiResponseWithData, type AppManagerRule, ApplyMqttTokenRequest, ApplyMqttTokenResponse, ApplyMqttTokenResponseBody, ApplyMqttTokenResponseBodyData, AuthenticationError, type BWList, type BinaryFileContentResult, type Brand, Browser, BrowserAgent, BrowserContext, BrowserError, type BrowserFingerprint, BrowserFingerprintContext, BrowserFingerprintGenerator, type BrowserOption, BrowserOptionClass, type BrowserProxy, BrowserProxyClass, type BrowserScreen, BrowserUseAgent, type BrowserViewport, CallMcpToolRequest, CallMcpToolResponse, CallMcpToolResponseBody, ClearContextRequest, ClearContextResponse, ClearContextResponseBody, Client, Code, Command, Computer, ComputerUseAgent, type Config, Context, type ContextInfoResult, ContextManager, ContextService, type ContextStatusData, type ContextStatusItem, ContextSync, type ContextSyncResult, CreateMcpSessionRequest, CreateMcpSessionRequestPersistenceDataList, CreateMcpSessionResponse, CreateMcpSessionResponseBody, CreateMcpSessionResponseBodyData, CreateMcpSessionShrinkRequest, CreateSessionParams, type CreateSessionParamsConfig, DeleteContextFileRequest, DeleteContextFileResponse, DeleteContextFileResponseBody, DeleteContextRequest, DeleteContextResponse, DeleteContextResponseBody, type DeletePolicy, type DeleteResult, DeleteSessionAsyncRequest, DeleteSessionAsyncResponse, DeleteSessionAsyncResponseBody, DescribeContextFilesRequest, DescribeContextFilesResponse, DescribeContextFilesResponseBody, type DirectoryEntry, type DirectoryListResult, type DownloadPolicy, DownloadStrategy, type ExecutionResult, Extension, ExtensionOption, ExtensionsService, type ExtraConfigs, type ExtraProperties, type ExtractOptions, type ExtractPolicy, ExtractPolicyClass, type FileChangeEvent, FileChangeEventHelper, type FileChangeResult, FileChangeResultHelper, type FileContentResult, FileError, type FileInfo, type FileInfoResult, type FileSearchResult, FileSystem, type Fingerprint, FingerprintFormat, GetAdbLinkRequest, GetAdbLinkResponse, GetAdbLinkResponseBody, GetAdbLinkResponseBodyData, GetAndLoadInternalContextRequest, GetAndLoadInternalContextResponse, GetAndLoadInternalContextResponseBody, GetAndLoadInternalContextResponseBodyData, GetCdpLinkRequest, GetCdpLinkResponse, GetCdpLinkResponseBody, GetCdpLinkResponseBodyData, GetContextFileDownloadUrlRequest, GetContextFileDownloadUrlResponse, GetContextFileDownloadUrlResponseBody, GetContextFileUploadUrlRequest, GetContextFileUploadUrlResponse, GetContextFileUploadUrlResponseBody, GetContextInfoRequest, GetContextInfoResponse, GetContextInfoResponseBody, GetContextInfoResponseBodyData, GetContextRequest, GetContextResponse, GetContextResponseBody, GetContextResponseBodyData, GetLabelRequest, GetLabelResponse, GetLabelResponseBody, GetLabelResponseBodyData, GetLinkRequest, GetLinkResponse, GetLinkResponseBody, GetLinkResponseBodyData, GetMcpResourceRequest, GetMcpResourceResponse, GetMcpResourceResponseBody, GetMcpResourceResponseBodyData, GetMcpResourceResponseBodyDataDesktopInfo, GetSessionDetailRequest, GetSessionDetailResponse, GetSessionDetailResponseBody, GetSessionDetailResponseBodyData, GetSessionRequest, GetSessionResponse, GetSessionResponseBody, GetSessionResponseBodyData, HIDE_NAVIGATION_BAR_TEMPLATE, IS_RELEASE, InitBrowserRequest, InitBrowserResponse, InitBrowserResponseBody, InitBrowserResponseBodyData, type InitializationResult, Lifecycle, ListContextsRequest, ListContextsResponse, ListContextsResponseBody, ListContextsResponseBodyData, ListMcpToolsRequest, ListMcpToolsResponse, ListMcpToolsResponseBody, type ListSessionParams, ListSessionRequest, ListSessionResponse, ListSessionResponseBody, ListSessionResponseBodyData, type LogLevel, type LoggerConfig, MOBILE_COMMAND_TEMPLATES, type MappingPolicy, type McpSession, type McpToolResult, Mobile, type MobileExtraConfig, type MobileSimulateConfig, MobileSimulateMode, MobileSimulateService, type MobileSimulateUploadResult, MobileUseAgent, ModifyContextRequest, ModifyContextResponse, ModifyContextResponseBody, type MultipleFileContentResult, type NavigatorFingerprint, type ObserveOptions, ObserveResult, Oss, OssError, PauseSessionAsyncRequest, PauseSessionAsyncResponse, PauseSessionAsyncResponseBody, type QueryResult, RESOLUTION_LOCK_TEMPLATE, type RecyclePolicy, ReleaseMcpSessionRequest, ReleaseMcpSessionResponse, ReleaseMcpSessionResponseBody, ResumeSessionAsyncRequest, ResumeSessionAsyncResponse, ResumeSessionAsyncResponseBody, SHOW_NAVIGATION_BAR_TEMPLATE, type ScreenFingerprint, Session, SessionError, type SessionInterface, type SessionListResult, SetLabelRequest, SetLabelResponse, SetLabelResponseBody, type SyncCallback, SyncContextRequest, SyncContextResponse, SyncContextResponseBody, type SyncPolicy, SyncPolicyImpl, UNINSTALL_BLACKLIST_TEMPLATE, UploadMode, type UploadPolicy, UploadStrategy, type UserAgentData, VERSION, type VideoCard, type WhiteList, WhiteListValidator, createListSessionParams, extraConfigsFromJSON, extraConfigsToJSON, extractRequestId, getLogLevel, getMobileCommandTemplate, hasMobileCommandTemplate, log, logDebug, logError, logInfo, logWarn, newContextManager, newContextSync, newCreateSessionParams, newDeletePolicy, newDownloadPolicy, newExtractPolicy, newMappingPolicy, newRecyclePolicy, newSyncPolicy, newSyncPolicyWithDefaults, newUploadPolicy, replaceTemplatePlaceholders, setLogLevel, setupLogger, validateAppManagerRule, validateExtraConfigs, validateMobileExtraConfig, validateMobileSimulateConfig };
|
|
7799
|
+
export { APIError, APP_BLACKLIST_TEMPLATE, APP_WHITELIST_TEMPLATE, type ActOptions, ActResult, Agent, AgentBay, AgentBayError, type AgentOptions, type ApiResponse, type ApiResponseWithData, type AppManagerRule, ApplyMqttTokenRequest, ApplyMqttTokenResponse, ApplyMqttTokenResponseBody, ApplyMqttTokenResponseBodyData, AuthenticationError, type BWList, type BinaryFileContentResult, type Brand, Browser, BrowserAgent, BrowserContext, BrowserError, type BrowserFingerprint, BrowserFingerprintContext, BrowserFingerprintGenerator, type BrowserOption, BrowserOptionClass, type BrowserProxy, BrowserProxyClass, type BrowserScreen, BrowserUseAgent, type BrowserViewport, CallMcpToolRequest, CallMcpToolResponse, CallMcpToolResponseBody, ClearContextRequest, ClearContextResponse, ClearContextResponseBody, Client, Code, Command, Computer, ComputerUseAgent, type Config, Context, type ContextInfoResult, ContextManager, ContextService, type ContextStatusData, type ContextStatusItem, ContextSync, type ContextSyncResult, CreateMcpSessionRequest, CreateMcpSessionRequestPersistenceDataList, CreateMcpSessionResponse, CreateMcpSessionResponseBody, CreateMcpSessionResponseBodyData, CreateMcpSessionShrinkRequest, CreateSessionParams, type CreateSessionParamsConfig, DeleteContextFileRequest, DeleteContextFileResponse, DeleteContextFileResponseBody, DeleteContextRequest, DeleteContextResponse, DeleteContextResponseBody, type DeletePolicy, type DeleteResult, DeleteSessionAsyncRequest, DeleteSessionAsyncResponse, DeleteSessionAsyncResponseBody, DescribeContextFilesRequest, DescribeContextFilesResponse, DescribeContextFilesResponseBody, type DirectoryEntry, type DirectoryListResult, type DownloadPolicy, DownloadStrategy, type ExecutionResult, Extension, ExtensionOption, ExtensionsService, type ExtraConfigs, type ExtraProperties, type ExtractOptions, type ExtractPolicy, ExtractPolicyClass, type FileChangeEvent, FileChangeEventHelper, type FileChangeResult, FileChangeResultHelper, type FileContentResult, FileError, type FileInfo, type FileInfoResult, type FileSearchResult, FileSystem, type Fingerprint, FingerprintFormat, GetAdbLinkRequest, GetAdbLinkResponse, GetAdbLinkResponseBody, GetAdbLinkResponseBodyData, GetAndLoadInternalContextRequest, GetAndLoadInternalContextResponse, GetAndLoadInternalContextResponseBody, GetAndLoadInternalContextResponseBodyData, GetCdpLinkRequest, GetCdpLinkResponse, GetCdpLinkResponseBody, GetCdpLinkResponseBodyData, GetContextFileDownloadUrlRequest, GetContextFileDownloadUrlResponse, GetContextFileDownloadUrlResponseBody, GetContextFileUploadUrlRequest, GetContextFileUploadUrlResponse, GetContextFileUploadUrlResponseBody, GetContextInfoRequest, GetContextInfoResponse, GetContextInfoResponseBody, GetContextInfoResponseBodyData, GetContextRequest, GetContextResponse, GetContextResponseBody, GetContextResponseBodyData, GetLabelRequest, GetLabelResponse, GetLabelResponseBody, GetLabelResponseBodyData, GetLinkRequest, GetLinkResponse, GetLinkResponseBody, GetLinkResponseBodyData, GetMcpResourceRequest, GetMcpResourceResponse, GetMcpResourceResponseBody, GetMcpResourceResponseBodyData, GetMcpResourceResponseBodyDataDesktopInfo, GetSessionDetailRequest, GetSessionDetailResponse, GetSessionDetailResponseBody, GetSessionDetailResponseBodyData, GetSessionRequest, GetSessionResponse, GetSessionResponseBody, GetSessionResponseBodyData, HIDE_NAVIGATION_BAR_TEMPLATE, IS_RELEASE, InitBrowserRequest, InitBrowserResponse, InitBrowserResponseBody, InitBrowserResponseBodyData, type InitializationResult, Lifecycle, ListContextsRequest, ListContextsResponse, ListContextsResponseBody, ListContextsResponseBodyData, ListMcpToolsRequest, ListMcpToolsResponse, ListMcpToolsResponseBody, type ListSessionParams, ListSessionRequest, ListSessionResponse, ListSessionResponseBody, ListSessionResponseBodyData, type LogLevel, type LoggerConfig, MOBILE_COMMAND_TEMPLATES, type MappingPolicy, type McpSession, type McpToolResult, Mobile, type MobileExtraConfig, type MobileSimulateConfig, MobileSimulateMode, MobileSimulateService, type MobileSimulateUploadResult, MobileUseAgent, ModifyContextRequest, ModifyContextResponse, ModifyContextResponseBody, type MultipleFileContentResult, type NavigatorFingerprint, type ObserveOptions, ObserveResult, Oss, OssError, PauseSessionAsyncRequest, PauseSessionAsyncResponse, PauseSessionAsyncResponseBody, type QueryResult, RESOLUTION_LOCK_TEMPLATE, type RecyclePolicy, ReleaseMcpSessionRequest, ReleaseMcpSessionResponse, ReleaseMcpSessionResponseBody, ResumeSessionAsyncRequest, ResumeSessionAsyncResponse, ResumeSessionAsyncResponseBody, SHOW_NAVIGATION_BAR_TEMPLATE, type ScreenFingerprint, Session, SessionError, type SessionInterface, type SessionListResult, type SessionMetrics, type SessionMetricsResult, SetLabelRequest, SetLabelResponse, SetLabelResponseBody, type SyncCallback, SyncContextRequest, SyncContextResponse, SyncContextResponseBody, type SyncPolicy, SyncPolicyImpl, UNINSTALL_BLACKLIST_TEMPLATE, UploadMode, type UploadPolicy, UploadStrategy, type UserAgentData, VERSION, type VideoCard, type WhiteList, WhiteListValidator, createListSessionParams, extraConfigsFromJSON, extraConfigsToJSON, extractRequestId, getLogLevel, getMobileCommandTemplate, hasMobileCommandTemplate, log, logDebug, logError, logInfo, logWarn, newContextManager, newContextSync, newCreateSessionParams, newDeletePolicy, newDownloadPolicy, newExtractPolicy, newMappingPolicy, newRecyclePolicy, newSyncPolicy, newSyncPolicyWithDefaults, newUploadPolicy, replaceTemplatePlaceholders, setLogLevel, setupLogger, validateAppManagerRule, validateExtraConfigs, validateMobileExtraConfig, validateMobileSimulateConfig };
|
package/dist/index.d.ts
CHANGED
|
@@ -156,6 +156,29 @@ interface OperationResult extends ApiResponse {
|
|
|
156
156
|
/** Optional error message if the operation failed */
|
|
157
157
|
errorMessage?: string;
|
|
158
158
|
}
|
|
159
|
+
/**
|
|
160
|
+
* Structured runtime metrics returned by Session.getMetrics().
|
|
161
|
+
*/
|
|
162
|
+
interface SessionMetrics {
|
|
163
|
+
cpuCount: number;
|
|
164
|
+
cpuUsedPct: number;
|
|
165
|
+
diskTotal: number;
|
|
166
|
+
diskUsed: number;
|
|
167
|
+
memTotal: number;
|
|
168
|
+
memUsed: number;
|
|
169
|
+
rxRateKBps: number;
|
|
170
|
+
txRateKBps: number;
|
|
171
|
+
rxUsedKB: number;
|
|
172
|
+
txUsedKB: number;
|
|
173
|
+
timestamp: string;
|
|
174
|
+
}
|
|
175
|
+
/**
|
|
176
|
+
* Result of Session.getMetrics() operation.
|
|
177
|
+
*/
|
|
178
|
+
interface SessionMetricsResult extends OperationResult {
|
|
179
|
+
data?: SessionMetrics;
|
|
180
|
+
raw?: Record<string, any>;
|
|
181
|
+
}
|
|
159
182
|
/**
|
|
160
183
|
* Interface for process list operation responses
|
|
161
184
|
* Corresponds to Python's ProcessListResult type
|
|
@@ -6511,6 +6534,24 @@ declare class Session {
|
|
|
6511
6534
|
* This improves case compatibility (e.g., "CTRL" -> "Ctrl", "tab" -> "Tab").
|
|
6512
6535
|
*/
|
|
6513
6536
|
callMcpTool(toolName: string, args: any, autoGenSession?: boolean): Promise<McpToolResult>;
|
|
6537
|
+
/**
|
|
6538
|
+
* Get runtime metrics for this session via the MCP get_metrics tool.
|
|
6539
|
+
*
|
|
6540
|
+
* The underlying MCP tool returns a JSON string. This method parses it and
|
|
6541
|
+
* returns a structured result.
|
|
6542
|
+
*
|
|
6543
|
+
* @example
|
|
6544
|
+
* ```typescript
|
|
6545
|
+
* const agentBay = new AgentBay({ apiKey: "your_api_key" });
|
|
6546
|
+
* const create = await agentBay.create({ imageId: "linux_latest" });
|
|
6547
|
+
* if (create.success && create.session) {
|
|
6548
|
+
* const metrics = await create.session.getMetrics();
|
|
6549
|
+
* console.log(metrics.data);
|
|
6550
|
+
* await create.session.delete();
|
|
6551
|
+
* }
|
|
6552
|
+
* ```
|
|
6553
|
+
*/
|
|
6554
|
+
getMetrics(): Promise<SessionMetricsResult>;
|
|
6514
6555
|
/**
|
|
6515
6556
|
* Asynchronously pause this session, putting it into a dormant state.
|
|
6516
6557
|
*
|
|
@@ -7755,4 +7796,4 @@ declare function logWarn(message: string, ...args: any[]): void;
|
|
|
7755
7796
|
*/
|
|
7756
7797
|
declare function logError(message: string, error?: any): void;
|
|
7757
7798
|
|
|
7758
|
-
export { APIError, APP_BLACKLIST_TEMPLATE, APP_WHITELIST_TEMPLATE, type ActOptions, ActResult, Agent, AgentBay, AgentBayError, type AgentOptions, type ApiResponse, type ApiResponseWithData, type AppManagerRule, ApplyMqttTokenRequest, ApplyMqttTokenResponse, ApplyMqttTokenResponseBody, ApplyMqttTokenResponseBodyData, AuthenticationError, type BWList, type BinaryFileContentResult, type Brand, Browser, BrowserAgent, BrowserContext, BrowserError, type BrowserFingerprint, BrowserFingerprintContext, BrowserFingerprintGenerator, type BrowserOption, BrowserOptionClass, type BrowserProxy, BrowserProxyClass, type BrowserScreen, BrowserUseAgent, type BrowserViewport, CallMcpToolRequest, CallMcpToolResponse, CallMcpToolResponseBody, ClearContextRequest, ClearContextResponse, ClearContextResponseBody, Client, Code, Command, Computer, ComputerUseAgent, type Config, Context, type ContextInfoResult, ContextManager, ContextService, type ContextStatusData, type ContextStatusItem, ContextSync, type ContextSyncResult, CreateMcpSessionRequest, CreateMcpSessionRequestPersistenceDataList, CreateMcpSessionResponse, CreateMcpSessionResponseBody, CreateMcpSessionResponseBodyData, CreateMcpSessionShrinkRequest, CreateSessionParams, type CreateSessionParamsConfig, DeleteContextFileRequest, DeleteContextFileResponse, DeleteContextFileResponseBody, DeleteContextRequest, DeleteContextResponse, DeleteContextResponseBody, type DeletePolicy, type DeleteResult, DeleteSessionAsyncRequest, DeleteSessionAsyncResponse, DeleteSessionAsyncResponseBody, DescribeContextFilesRequest, DescribeContextFilesResponse, DescribeContextFilesResponseBody, type DirectoryEntry, type DirectoryListResult, type DownloadPolicy, DownloadStrategy, type ExecutionResult, Extension, ExtensionOption, ExtensionsService, type ExtraConfigs, type ExtraProperties, type ExtractOptions, type ExtractPolicy, ExtractPolicyClass, type FileChangeEvent, FileChangeEventHelper, type FileChangeResult, FileChangeResultHelper, type FileContentResult, FileError, type FileInfo, type FileInfoResult, type FileSearchResult, FileSystem, type Fingerprint, FingerprintFormat, GetAdbLinkRequest, GetAdbLinkResponse, GetAdbLinkResponseBody, GetAdbLinkResponseBodyData, GetAndLoadInternalContextRequest, GetAndLoadInternalContextResponse, GetAndLoadInternalContextResponseBody, GetAndLoadInternalContextResponseBodyData, GetCdpLinkRequest, GetCdpLinkResponse, GetCdpLinkResponseBody, GetCdpLinkResponseBodyData, GetContextFileDownloadUrlRequest, GetContextFileDownloadUrlResponse, GetContextFileDownloadUrlResponseBody, GetContextFileUploadUrlRequest, GetContextFileUploadUrlResponse, GetContextFileUploadUrlResponseBody, GetContextInfoRequest, GetContextInfoResponse, GetContextInfoResponseBody, GetContextInfoResponseBodyData, GetContextRequest, GetContextResponse, GetContextResponseBody, GetContextResponseBodyData, GetLabelRequest, GetLabelResponse, GetLabelResponseBody, GetLabelResponseBodyData, GetLinkRequest, GetLinkResponse, GetLinkResponseBody, GetLinkResponseBodyData, GetMcpResourceRequest, GetMcpResourceResponse, GetMcpResourceResponseBody, GetMcpResourceResponseBodyData, GetMcpResourceResponseBodyDataDesktopInfo, GetSessionDetailRequest, GetSessionDetailResponse, GetSessionDetailResponseBody, GetSessionDetailResponseBodyData, GetSessionRequest, GetSessionResponse, GetSessionResponseBody, GetSessionResponseBodyData, HIDE_NAVIGATION_BAR_TEMPLATE, IS_RELEASE, InitBrowserRequest, InitBrowserResponse, InitBrowserResponseBody, InitBrowserResponseBodyData, type InitializationResult, Lifecycle, ListContextsRequest, ListContextsResponse, ListContextsResponseBody, ListContextsResponseBodyData, ListMcpToolsRequest, ListMcpToolsResponse, ListMcpToolsResponseBody, type ListSessionParams, ListSessionRequest, ListSessionResponse, ListSessionResponseBody, ListSessionResponseBodyData, type LogLevel, type LoggerConfig, MOBILE_COMMAND_TEMPLATES, type MappingPolicy, type McpSession, type McpToolResult, Mobile, type MobileExtraConfig, type MobileSimulateConfig, MobileSimulateMode, MobileSimulateService, type MobileSimulateUploadResult, MobileUseAgent, ModifyContextRequest, ModifyContextResponse, ModifyContextResponseBody, type MultipleFileContentResult, type NavigatorFingerprint, type ObserveOptions, ObserveResult, Oss, OssError, PauseSessionAsyncRequest, PauseSessionAsyncResponse, PauseSessionAsyncResponseBody, type QueryResult, RESOLUTION_LOCK_TEMPLATE, type RecyclePolicy, ReleaseMcpSessionRequest, ReleaseMcpSessionResponse, ReleaseMcpSessionResponseBody, ResumeSessionAsyncRequest, ResumeSessionAsyncResponse, ResumeSessionAsyncResponseBody, SHOW_NAVIGATION_BAR_TEMPLATE, type ScreenFingerprint, Session, SessionError, type SessionInterface, type SessionListResult, SetLabelRequest, SetLabelResponse, SetLabelResponseBody, type SyncCallback, SyncContextRequest, SyncContextResponse, SyncContextResponseBody, type SyncPolicy, SyncPolicyImpl, UNINSTALL_BLACKLIST_TEMPLATE, UploadMode, type UploadPolicy, UploadStrategy, type UserAgentData, VERSION, type VideoCard, type WhiteList, WhiteListValidator, createListSessionParams, extraConfigsFromJSON, extraConfigsToJSON, extractRequestId, getLogLevel, getMobileCommandTemplate, hasMobileCommandTemplate, log, logDebug, logError, logInfo, logWarn, newContextManager, newContextSync, newCreateSessionParams, newDeletePolicy, newDownloadPolicy, newExtractPolicy, newMappingPolicy, newRecyclePolicy, newSyncPolicy, newSyncPolicyWithDefaults, newUploadPolicy, replaceTemplatePlaceholders, setLogLevel, setupLogger, validateAppManagerRule, validateExtraConfigs, validateMobileExtraConfig, validateMobileSimulateConfig };
|
|
7799
|
+
export { APIError, APP_BLACKLIST_TEMPLATE, APP_WHITELIST_TEMPLATE, type ActOptions, ActResult, Agent, AgentBay, AgentBayError, type AgentOptions, type ApiResponse, type ApiResponseWithData, type AppManagerRule, ApplyMqttTokenRequest, ApplyMqttTokenResponse, ApplyMqttTokenResponseBody, ApplyMqttTokenResponseBodyData, AuthenticationError, type BWList, type BinaryFileContentResult, type Brand, Browser, BrowserAgent, BrowserContext, BrowserError, type BrowserFingerprint, BrowserFingerprintContext, BrowserFingerprintGenerator, type BrowserOption, BrowserOptionClass, type BrowserProxy, BrowserProxyClass, type BrowserScreen, BrowserUseAgent, type BrowserViewport, CallMcpToolRequest, CallMcpToolResponse, CallMcpToolResponseBody, ClearContextRequest, ClearContextResponse, ClearContextResponseBody, Client, Code, Command, Computer, ComputerUseAgent, type Config, Context, type ContextInfoResult, ContextManager, ContextService, type ContextStatusData, type ContextStatusItem, ContextSync, type ContextSyncResult, CreateMcpSessionRequest, CreateMcpSessionRequestPersistenceDataList, CreateMcpSessionResponse, CreateMcpSessionResponseBody, CreateMcpSessionResponseBodyData, CreateMcpSessionShrinkRequest, CreateSessionParams, type CreateSessionParamsConfig, DeleteContextFileRequest, DeleteContextFileResponse, DeleteContextFileResponseBody, DeleteContextRequest, DeleteContextResponse, DeleteContextResponseBody, type DeletePolicy, type DeleteResult, DeleteSessionAsyncRequest, DeleteSessionAsyncResponse, DeleteSessionAsyncResponseBody, DescribeContextFilesRequest, DescribeContextFilesResponse, DescribeContextFilesResponseBody, type DirectoryEntry, type DirectoryListResult, type DownloadPolicy, DownloadStrategy, type ExecutionResult, Extension, ExtensionOption, ExtensionsService, type ExtraConfigs, type ExtraProperties, type ExtractOptions, type ExtractPolicy, ExtractPolicyClass, type FileChangeEvent, FileChangeEventHelper, type FileChangeResult, FileChangeResultHelper, type FileContentResult, FileError, type FileInfo, type FileInfoResult, type FileSearchResult, FileSystem, type Fingerprint, FingerprintFormat, GetAdbLinkRequest, GetAdbLinkResponse, GetAdbLinkResponseBody, GetAdbLinkResponseBodyData, GetAndLoadInternalContextRequest, GetAndLoadInternalContextResponse, GetAndLoadInternalContextResponseBody, GetAndLoadInternalContextResponseBodyData, GetCdpLinkRequest, GetCdpLinkResponse, GetCdpLinkResponseBody, GetCdpLinkResponseBodyData, GetContextFileDownloadUrlRequest, GetContextFileDownloadUrlResponse, GetContextFileDownloadUrlResponseBody, GetContextFileUploadUrlRequest, GetContextFileUploadUrlResponse, GetContextFileUploadUrlResponseBody, GetContextInfoRequest, GetContextInfoResponse, GetContextInfoResponseBody, GetContextInfoResponseBodyData, GetContextRequest, GetContextResponse, GetContextResponseBody, GetContextResponseBodyData, GetLabelRequest, GetLabelResponse, GetLabelResponseBody, GetLabelResponseBodyData, GetLinkRequest, GetLinkResponse, GetLinkResponseBody, GetLinkResponseBodyData, GetMcpResourceRequest, GetMcpResourceResponse, GetMcpResourceResponseBody, GetMcpResourceResponseBodyData, GetMcpResourceResponseBodyDataDesktopInfo, GetSessionDetailRequest, GetSessionDetailResponse, GetSessionDetailResponseBody, GetSessionDetailResponseBodyData, GetSessionRequest, GetSessionResponse, GetSessionResponseBody, GetSessionResponseBodyData, HIDE_NAVIGATION_BAR_TEMPLATE, IS_RELEASE, InitBrowserRequest, InitBrowserResponse, InitBrowserResponseBody, InitBrowserResponseBodyData, type InitializationResult, Lifecycle, ListContextsRequest, ListContextsResponse, ListContextsResponseBody, ListContextsResponseBodyData, ListMcpToolsRequest, ListMcpToolsResponse, ListMcpToolsResponseBody, type ListSessionParams, ListSessionRequest, ListSessionResponse, ListSessionResponseBody, ListSessionResponseBodyData, type LogLevel, type LoggerConfig, MOBILE_COMMAND_TEMPLATES, type MappingPolicy, type McpSession, type McpToolResult, Mobile, type MobileExtraConfig, type MobileSimulateConfig, MobileSimulateMode, MobileSimulateService, type MobileSimulateUploadResult, MobileUseAgent, ModifyContextRequest, ModifyContextResponse, ModifyContextResponseBody, type MultipleFileContentResult, type NavigatorFingerprint, type ObserveOptions, ObserveResult, Oss, OssError, PauseSessionAsyncRequest, PauseSessionAsyncResponse, PauseSessionAsyncResponseBody, type QueryResult, RESOLUTION_LOCK_TEMPLATE, type RecyclePolicy, ReleaseMcpSessionRequest, ReleaseMcpSessionResponse, ReleaseMcpSessionResponseBody, ResumeSessionAsyncRequest, ResumeSessionAsyncResponse, ResumeSessionAsyncResponseBody, SHOW_NAVIGATION_BAR_TEMPLATE, type ScreenFingerprint, Session, SessionError, type SessionInterface, type SessionListResult, type SessionMetrics, type SessionMetricsResult, SetLabelRequest, SetLabelResponse, SetLabelResponseBody, type SyncCallback, SyncContextRequest, SyncContextResponse, SyncContextResponseBody, type SyncPolicy, SyncPolicyImpl, UNINSTALL_BLACKLIST_TEMPLATE, UploadMode, type UploadPolicy, UploadStrategy, type UserAgentData, VERSION, type VideoCard, type WhiteList, WhiteListValidator, createListSessionParams, extraConfigsFromJSON, extraConfigsToJSON, extractRequestId, getLogLevel, getMobileCommandTemplate, hasMobileCommandTemplate, log, logDebug, logError, logInfo, logWarn, newContextManager, newContextSync, newCreateSessionParams, newDeletePolicy, newDownloadPolicy, newExtractPolicy, newMappingPolicy, newRecyclePolicy, newSyncPolicy, newSyncPolicyWithDefaults, newUploadPolicy, replaceTemplatePlaceholders, setLogLevel, setupLogger, validateAppManagerRule, validateExtraConfigs, validateMobileExtraConfig, validateMobileSimulateConfig };
|
package/dist/index.mjs
CHANGED
|
@@ -17251,6 +17251,70 @@ var _Session = class _Session {
|
|
|
17251
17251
|
};
|
|
17252
17252
|
}
|
|
17253
17253
|
}
|
|
17254
|
+
/**
|
|
17255
|
+
* Get runtime metrics for this session via the MCP get_metrics tool.
|
|
17256
|
+
*
|
|
17257
|
+
* The underlying MCP tool returns a JSON string. This method parses it and
|
|
17258
|
+
* returns a structured result.
|
|
17259
|
+
*
|
|
17260
|
+
* @example
|
|
17261
|
+
* ```typescript
|
|
17262
|
+
* const agentBay = new AgentBay({ apiKey: "your_api_key" });
|
|
17263
|
+
* const create = await agentBay.create({ imageId: "linux_latest" });
|
|
17264
|
+
* if (create.success && create.session) {
|
|
17265
|
+
* const metrics = await create.session.getMetrics();
|
|
17266
|
+
* console.log(metrics.data);
|
|
17267
|
+
* await create.session.delete();
|
|
17268
|
+
* }
|
|
17269
|
+
* ```
|
|
17270
|
+
*/
|
|
17271
|
+
async getMetrics() {
|
|
17272
|
+
const toolResult = await this.callMcpTool("get_metrics", {});
|
|
17273
|
+
const requestId = toolResult.requestId || "";
|
|
17274
|
+
if (!toolResult.success) {
|
|
17275
|
+
return {
|
|
17276
|
+
requestId,
|
|
17277
|
+
success: false,
|
|
17278
|
+
data: void 0,
|
|
17279
|
+
raw: void 0,
|
|
17280
|
+
errorMessage: toolResult.errorMessage || ""
|
|
17281
|
+
};
|
|
17282
|
+
}
|
|
17283
|
+
try {
|
|
17284
|
+
const raw = typeof toolResult.data === "string" ? JSON.parse(toolResult.data) : toolResult.data;
|
|
17285
|
+
if (!raw || typeof raw !== "object" || Array.isArray(raw)) {
|
|
17286
|
+
throw new Error("get_metrics returned non-object JSON");
|
|
17287
|
+
}
|
|
17288
|
+
const metrics = {
|
|
17289
|
+
cpuCount: Number(raw.cpu_count ?? 0),
|
|
17290
|
+
cpuUsedPct: Number(raw.cpu_used_pct ?? 0),
|
|
17291
|
+
diskTotal: Number(raw.disk_total ?? 0),
|
|
17292
|
+
diskUsed: Number(raw.disk_used ?? 0),
|
|
17293
|
+
memTotal: Number(raw.mem_total ?? 0),
|
|
17294
|
+
memUsed: Number(raw.mem_used ?? 0),
|
|
17295
|
+
rxRateKBps: Number(raw.rx_rate_KBps ?? 0),
|
|
17296
|
+
txRateKBps: Number(raw.tx_rate_KBps ?? 0),
|
|
17297
|
+
rxUsedKB: Number(raw.rx_used_KB ?? 0),
|
|
17298
|
+
txUsedKB: Number(raw.tx_used_KB ?? 0),
|
|
17299
|
+
timestamp: String(raw.timestamp ?? "")
|
|
17300
|
+
};
|
|
17301
|
+
return {
|
|
17302
|
+
requestId,
|
|
17303
|
+
success: true,
|
|
17304
|
+
data: metrics,
|
|
17305
|
+
raw,
|
|
17306
|
+
errorMessage: ""
|
|
17307
|
+
};
|
|
17308
|
+
} catch (err) {
|
|
17309
|
+
return {
|
|
17310
|
+
requestId,
|
|
17311
|
+
success: false,
|
|
17312
|
+
data: void 0,
|
|
17313
|
+
raw: void 0,
|
|
17314
|
+
errorMessage: `Failed to parse get_metrics response: ${err?.message || String(err)}`
|
|
17315
|
+
};
|
|
17316
|
+
}
|
|
17317
|
+
}
|
|
17254
17318
|
/**
|
|
17255
17319
|
* Asynchronously pause this session, putting it into a dormant state.
|
|
17256
17320
|
*
|