DocumentationDashboard

Sandbox metrics

This feature is in a private beta.

The sandbox metrics allows you to get information about the sandbox's CPU and memory usage.

1. Installation

To get sandbox metrics, you need to install the beta version of the SDKs and CLI.

1.1. Installing the beta version of the SDKs

Terminal
npm i @e2b/code-interpreter@beta
#
# or use Core: https://github.com/e2b-dev/e2b
# npm i e2b@beta

1.2. Installing the beta version of the CLI

Terminal
npm i -g @e2b/cli@beta

2. Getting sandbox metrics

Getting the metrics of a sandbox returns an array of timestamped metrics containing CPU and memory usage information. The metrics are collected at the start of the sandbox, then every 2 seconds, and finally right before the sandbox is deleted.

2.1. Getting sandbox metrics using the SDKs

import { Sandbox } from '@e2b/code-interpreter'

const sbx = await Sandbox.create()
console.log('Sandbox created', sbx.sandboxId)

const metrics = await sbx.getMetrics() 

// You can also get the metrics by sandbox ID:
// const metrics = await Sandbox.getMetrics(sbx.sandboxId)

console.log('Sandbox metrics:', metrics)

// [
//   {
//     cpuCount: 2,
//     cpuUsedPct: 50.05,
//     memTotalMiB: 484,
//     memUsedMiB: 37,
//     timestamp: '2025-01-23T23:44:12.222Z'
//   },
//   {
//     cpuCount: 2,
//     cpuUsedPct: 4.5,
//     memTotalMiB: 484,
//     memUsedMiB: 37,
//     timestamp: '2025-01-23T23:44:13.220Z'
//   }
// ]

2.2. Getting sandbox metrics using the CLI

Terminal
e2b sandbox metrics <sandbox_id>  

# Metrics for sandbox <sandbox_id>
# 
# [2025-01-23 00:58:58.829Z]  { cpuCount: 2, cpuUsedPct: 50.21, logger: '', memTotalMiB: 484, memUsedMiB: 38, timestamp: '2025-01-23T00:58:58.829638869Z' }
# [2025-01-23 00:59:03.814Z]  { cpuCount: 2, cpuUsedPct: 5.16, logger: '', memTotalMiB: 484, memUsedMiB: 37, timestamp: '2025-01-23T00:59:03.814028031Z' }
# [2025-01-23 00:59:08.815Z]  { cpuCount: 2, cpuUsedPct: 1.6, logger: '', memTotalMiB: 484, memUsedMiB: 37, timestamp: '2025-01-23T00:59:08.815933749Z' }

Limitations while in beta

  • It may take a second or more to get the metrics after the sandbox is created. Until the logs are collected from the sandbox, you will get an empty array.