bot-status-api

What This Skill Does

The bot-status-api provides a lightweight, performant observability layer for your OpenClaw agent ecosystem. Instead of manually inspecting logs or terminals, this skill exposes a structured JSON API that surfaces the internal state of your bot. It acts as a bridge between the agent's complex runtime environment and your monitoring tools. By polling the /status endpoint, you can visualize heartbeat data, monitor service availability, track active cron jobs, and keep an eye on system resource utilization like RAM and CPU usage. It is built to be dependency-free, running exclusively on Node.js, making it highly portable and ideal for lightweight VPS or container deployments.

Installation

1. Install the package using the command: clawhub install openclaw/skills/skills/suspect80/bot-status-api-test.
2. Locate the installation directory and copy server.js and the collectors/ directory to your target operational folder.
3. Create a config.json file based on the config.example.json template, ensuring you define your workspace and openclawHome paths correctly.
4. Configure your desired services (HTTP checks, shell commands, or file path monitoring) within the services array of the config.
5. Run the server using node server.js or configure it as a systemd user service to ensure it persists after reboots.

Use Cases

• Dashboard Integration: Feed the status JSON into Grafana, Datadog, or custom React dashboards to visualize bot uptime and health.
• Alerting: Configure UptimeRobot or similar services to ping the /health endpoint and alert you if the agent goes offline.
• Resource Management: Track context window usage and model state to optimize agent cost and performance.
• Service Monitoring: Centralize health checks for your agent's external dependencies like vector databases, custom scrapers, or local API tools.

Example Prompts

1. "OpenClaw, please generate a status dashboard configuration using the data provided by the bot-status-api for my Grafana panel."
2. "Check the bot-status-api config and verify if my current cron job list is correctly parsing the workspace files."
3. "Summarize the last 24 hours of service health from the status API, noting any downtime incidents reported for my external dependencies."

Tips & Limitations

• Security: The status API does not include authentication by default. Ensure it is only accessible via localhost or behind a reverse proxy (like Nginx) if exposed to the public internet.
• Caching: The API uses a configurable cache TTL (ttlMs). If you require real-time metrics, lower this value, but be aware of the performance impact on the host system.
• Heartbeat Requirement: For the agent vitals (context usage, etc.) to show up, ensure your primary agent routine is configured to write its state periodically to heartbeat-state.json as specified in the documentation.