Expose complete scoped AgentOS limit usage for observability
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 4.6k
- Forks
- 251
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 34
Description
Problem
AgentOS has two centralized limit mechanisms today:
VmLimitsis the authoritative sidecar-owned configuration and enforcement surface.QueueRegistrytracks live usage for manually registered gauges and producesdepth,high_water,capacity, andfill_percentsnapshots.
The existing get_resource_snapshot path exposes the registered gauges, but it does not represent every configured limit. The registry currently covers selected queues, kernel resources, V8 budgets, and WASM budgets. There is no automatic descriptor/catalog connection between a VmLimits field and its observable usage.
The snapshot also reads from a process-global registry whose entries do not carry scope or VM identity. A VM-addressed request therefore cannot reliably distinguish VM-local gauges from sidecar-wide gauges when a sidecar hosts multiple VMs.
Missing measurable usage
Audit and register live usage where it is meaningful, including at least:
- ACP sessions, prompts, retained history bytes/events, and pending permissions
- JavaScript timers
- reactor capabilities, ready handles, tasks, bridge calls, async completions, and blocking jobs/bytes
- UDP buffered datagrams/bytes
- TLS buffered bytes
- HTTP/2 connections, streams, pending commands/events, and buffered/header/data bytes
- any other count/byte limit with durable current usage that is enforced through
VmLimits
Non-gauge limits
Some configured limits do not have meaningful persistent usage, including per-operation payload caps, page sizes, work quanta, and inactive deadlines. These should still appear in an authoritative limit catalog with their configured capacity and measurement semantics, while reporting live usage as unavailable rather than inventing a percentage.
Example shape:
interface LimitUsage {
name: string;
configurationPath: string;
category: "queue" | "resource" | "memory" | "cpu" | "deadline" | "payload";
scope: "sidecar" | "vm" | "session" | "process" | "capability" | "connection" | "stream";
unit: "items" | "bytes" | "milliseconds" | "tasks" | "connections" | "streams";
capacity: number;
currentUsage: number | null;
highWater: number | null;
fillPercent: number | null;
measurement: "gauge" | "per_operation" | "deadline" | "quantum";
}
The exact wire shape can differ, but the sidecar must remain the single source of truth.
Scope and security
- Associate registered gauges with their owning scope and VM where applicable.
- A VM-scoped snapshot must not expose another VM's usage or identities.
- Sidecar-wide aggregate usage should be available only through an explicitly host-authorized observability surface.
- Preserve the design requirement that guest-visible diagnostics cannot become a cross-tenant occupancy oracle.
Public API
Expose the resulting snapshot with behavioral parity across:
AgentOs.getResourceSnapshot()in@rivet-dev/agentos-core- the Rust
AgentOsclient - a
getResourceSnapshotaction in@rivet-dev/agentos
@rivet-dev/agentos-runtime-core already has the lower-level transport and NodeRuntime.getResourceSnapshot() implementation; product users should not need to depend on that implementation package directly.
Acceptance criteria
- Every
VmLimitsfield has one canonical runtime descriptor containing its configuration path, category, unit, scope, and measurement semantics. - Every meaningfully measurable count/byte/budget limit is connected to live usage and high-water accounting.
- Non-gauge limits are returned with configured values and nullable usage/percentage.
- VM-addressed snapshots contain only that VM's data plus explicitly labeled, authorized sidecar aggregates.
- TypeScript core, Rust client, and actor APIs expose equivalent JSON-serializable results.
- The limits audit fails when a new operator-facing limit lacks a descriptor, and fails when a measurable limit lacks accounting.
- Tests cover multiple VMs in one shared sidecar and prove there is no cross-VM leakage.
- Resource-limit documentation is updated to distinguish configured limits, measurable gauges, and non-gauge enforcement limits.
This enables an inspector page to render the complete limit inventory directly from the API without maintaining a separate UI mapping.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Begin by auditing VmLimits and QueueRegistry, then trace the existing NodeRuntime.getResourceSnapshot() transport and the AgentOs APIs in the TypeScript core, Rust client, and actor package. Map each limit to its descriptor and usage source, then use the acceptance criteria to verify complete results, authorized scoping, audit coverage, parity, and multi-VM leakage tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust, typescript, wasm
- Domain
- backend-api-design, documentation, observability, security, testing-qa
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100