Observability

Documentation Index

Fetch the complete documentation index at: https://docs.hopx.ai/llms.txt

Use this file to discover all available pages before exploring further.

Monitor and observe HopX sandboxes with comprehensive metrics, process monitoring, and system information. This hub covers all observability features for debugging and performance optimization.

​

Related

• CLI System Commands - System operations from CLI

​

What You’ll Learn

• How to monitor sandbox metrics (CPU, memory, disk)
• How to list and monitor processes
• How to track system information and health
• How to use observability for debugging
• How to optimize performance based on metrics

​

Observability Overview

​

Core Concepts

​

Metrics

Monitor CPU, memory, disk, and other system metrics.

• Metrics - Monitor system metrics
• SDK: Python: sandbox.get_agent_metrics() | JavaScript: sandbox.getAgentMetrics()
• API: GET /system/metrics

​

Processes

List and monitor running processes in sandboxes.

• Processes - Monitor processes
• SDK: Python: sandbox.list_processes() | JavaScript: sandbox.listProcesses()
• API: GET /processes | GET /processes/system

​

Monitoring

Comprehensive monitoring strategies and best practices.

• Monitoring - Monitoring strategies
• SDK: Monitoring utilities | API: Monitoring endpoints

​

SDK Reference

​

Python SDK

Complete reference for Python observability operations.

• Sandbox.get_agent_metrics() - Get system metrics
• Sandbox.list_processes() - List processes
• Sandbox.get_metrics_snapshot() - Get metrics snapshot

​

JavaScript SDK

Complete reference for JavaScript/TypeScript observability operations.

• Sandbox.getAgentMetrics() - Get system metrics
• Sandbox.listProcesses() - List processes
• Sandbox.getMetricsSnapshot() - Get metrics snapshot

​

API Reference

​

VM Agent API

REST API endpoints for observability.

• VM Agent API Overview - API overview
• Get System Metrics - GET /system/metrics - Get metrics
• List Processes - GET /processes - List background processes
• List System Processes - GET /processes/system - List all processes

​

Quick Start

If you’re new to observability, start here:

1. Metrics - Monitor system metrics
2. Processes - Monitor running processes
3. Monitoring - Set up monitoring

​

Related Topics

• Code Execution - Monitor background execution
• Sandboxes - Monitor sandbox state
• Process Management - Manage processes
• Cache Management - Monitor cache usage

​

Next Steps

• Learn about Metrics for system monitoring
• Explore Processes for process monitoring
• Review Monitoring for comprehensive strategies
• Check out Code Execution for execution monitoring