swarmauri_tool_psutil 0.9.3.dev4

Swarmauri Psutil Tool.

---

Swarmauri Tool · psutil

A Swarmauri-compatible system inspection tool powered by psutil. Use it to surface CPU, memory, disk, network, and sensor telemetry inside agents, observability workflows, or health checks.

• Wraps rich psutil APIs behind a single callable interface.
• Returns structured dictionaries that mirror psutil's native data models (converted to plain Python objects for JSON serialization).
• Handles common permission gaps gracefully (e.g., network connections, sensors) so calls do not crash automation.

Requirements

• Python 3.10 – 3.13.
• psutil installed (pulled automatically with the package).
• Optional platform support: some sensor endpoints require root/admin privileges or may not exist on virtualized hosts.

Installation

Select the installer that matches your environment; each command resolves transitive dependencies.

pip

pip install swarmauri_tool_psutil

Poetry

poetry add swarmauri_tool_psutil

uv

# Add to the current project and update uv.lock
uv add swarmauri_tool_psutil

# or install directly into the active environment without editing pyproject.toml
uv pip install swarmauri_tool_psutil

Tip: psutil needs native build tooling on some platforms (musl-based containers, Alpine). Install the OS-level prerequisites before running the package install command.

Quick Start

from pprint import pprint
from swarmauri_tool_psutil import PsutilTool

psutil_tool = PsutilTool()

cpu = psutil_tool("cpu")
mem = psutil_tool("memory")

print("CPU summary:")
pprint(cpu)

print("Memory summary:")
pprint(mem)

Each call returns a dictionary keyed by metrics families (e.g., cpu_times, virtual_memory). Use only the sections you need in downstream automations.

Usage Scenarios

Build a Lightweight Health Endpoint

from fastapi import FastAPI
from swarmauri_tool_psutil import PsutilTool

app = FastAPI()
ps_tool = PsutilTool()

@app.get("/health/system")
def system_health():
    return {
        "cpu": ps_tool("cpu"),
        "memory": ps_tool("memory"),
        "disk": ps_tool("disk"),
    }

Expose system metrics to dashboards or probes without wiring psutil manually.

Enrich Swarmauri Agent Responses With Telemetry

from swarmauri_core.agent.Agent import Agent
from swarmauri_core.messages.HumanMessage import HumanMessage
from swarmauri_standard.tools.registry import ToolRegistry
from swarmauri_tool_psutil import PsutilTool

registry = ToolRegistry()
registry.register(PsutilTool())
agent = Agent(tool_registry=registry)

message = HumanMessage(content="report system cpu load and memory usage")
response = agent.run(message)
print(response)

Register the tool alongside other Swarmauri capabilities so agents can answer operational questions on demand.

Archive High-Usage Events for Later Analysis

import json
import time
from pathlib import Path
from swarmauri_tool_psutil import PsutilTool

ps_tool = PsutilTool()
log_dir = Path("telemetry_logs")
log_dir.mkdir(exist_ok=True)

while True:
    snapshot = {
        "ts": time.time(),
        "cpu": ps_tool("cpu"),
        "memory": ps_tool("memory"),
        "network": ps_tool("network"),
    }
    (log_dir / f"snapshot-{int(snapshot['ts'])}.json").write_text(
        json.dumps(snapshot, indent=2)
    )
    time.sleep(60)

Capture periodic snapshots that can be loaded into notebooks, dashboards, or anomaly detection jobs.

Troubleshooting

• ValueError: Invalid info_type – Only "cpu", "memory", "disk", "network", and "sensors" are supported. Validate user input before calling the tool.
• Permission denied retrieving connections/sensors – Run with elevated privileges or filter out those sections. The tool returns a descriptive string when it cannot access the data.
• psutil.AccessDenied on containerized hosts – Grant the container additional capabilities (e.g., SYS_PTRACE) or restrict to metrics that do not require elevated rights.

License

swarmauri_tool_psutil is released under the Apache 2.0 License. See LICENSE for details.