Add sbx metrics to SDKs

Author: jakubno

packages/js-sdk/src/api/schema.gen.ts

@@ -41,7 +41,7 @@ export type {
 } from './sandbox/commands'
 
 export type { SandboxOpts } from './sandbox'
-export type { SandboxInfo } from './sandbox/sandboxApi'
+export type { SandboxInfo, SandboxMetrics } from './sandbox/sandboxApi'
 export { Sandbox }
 import { Sandbox } from './sandbox'
 export default Sandbox

packages/js-sdk/src/index.ts

@@ -520,6 +520,21 @@ export class Sandbox extends SandboxApi {
     })
   }
 
+
+  /**
+   * Get the metrics of the sandbox.
+   *
+   * @param opts connection options.
+   *
+   * @returns metrics of the sandbox.
+   */
+  async getMetrics(opts?: Pick<SandboxOpts, 'requestTimeoutMs'>) {
+    return await Sandbox.getMetrics(this.sandboxId, {
+      ...this.connectionConfig,
+      ...opts,
+    })
+  }
+
   private fileUrl(path?: string, username?: string) {
     const url = new URL('/files', this.envdApiUrl)
 

packages/js-sdk/src/sandbox/index.ts

@@ -125,6 +125,47 @@ export interface ListedSandbox {
 }
 
 
+/**
+ * Sandbox resource usage metrics.
+ */
+export interface SandboxMetrics {
+  /**
+   * Timestamp of the metrics.
+   */
+  timestamp: Date
+
+  /**
+   * CPU usage in percentage.
+   */
+  cpuUsedPct: number
+
+  /**
+   * Number of CPU cores.
+   */
+  cpuCount: number
+
+  /**
+   * Memory usage in bytes.
+   */
+  memUsed: number
+
+  /**
+   * Total memory available in bytes.
+   */
+  memTotal: number
+
+  /**
+   * Used disk space in bytes.
+   */
+  diskUsed: number
+
+  /**
+   * Total disk space available in bytes.
+   */
+  diskTotal: number
+}
+
+
 export class SandboxApi {
   protected constructor() {}
 
@@ -262,6 +303,49 @@ export class SandboxApi {
     }
   }
 
+
+  /**
+   * Get the metrics of the sandbox.
+   *
+   * @param sandboxId sandbox ID.
+   * @param opts connection options.
+   *
+   * @returns metrics of the sandbox.
+   */
+  static async getMetrics(
+    sandboxId: string,
+    opts?: SandboxApiOpts
+  ): Promise<SandboxMetrics[]> {
+    const config = new ConnectionConfig(opts)
+    const client = new ApiClient(config)
+
+    const res = await client.api.GET('/sandboxes/{sandboxID}/metrics', {
+      params: {
+        path: {
+          sandboxID: sandboxId,
+        },
+      },
+      signal: config.getSignal(opts?.requestTimeoutMs),
+    })
+
+    const err = handleApiError(res)
+    if (err) {
+      throw err
+    }
+
+    return (
+      res.data?.map((metric: components['schemas']['SandboxMetric']) => ({
+        timestamp: new Date(metric.timestamp),
+        cpuUsedPct: metric.cpuUsedPct,
+        cpuCount: metric.cpuCount,
+        memUsed: metric.memUsed,
+        memTotal: metric.memTotal,
+        diskUsed: metric.diskUsed,
+        diskTotal: metric.diskTotal,
+      })) ?? []
+    )
+  }
+
   /**
    * Set the timeout of the specified sandbox.
    * After the timeout expires the sandbox will be automatically killed.