@steadwing/openalerts 0.2.3 → 0.2.5

package/README.md

@@ -7,8 +7,10 @@
 
 <p align="center">
   <a href="https://www.npmjs.com/package/@steadwing/openalerts"><img src="https://img.shields.io/npm/v/@steadwing/openalerts?style=flat&color=blue" alt="npm"></a>
+  <a href="https://www.npmjs.com/package/@steadwing/openalerts"><img src="https://img.shields.io/npm/dt/@steadwing/openalerts?style=flat&color=blue" alt="npm"></a>
   <a href="https://github.com/steadwing/openalerts/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-green" alt="License"></a>
   <a href="https://github.com/steadwing/openalerts/stargazers"><img src="https://img.shields.io/github/stars/steadwing/openalerts?style=flat" alt="GitHub stars"></a>
+  <a href="https://discord.gg/4rUP86tSXn"><img src="https://img.shields.io/badge/discord-join-5865F2?style=flat" alt="Discord"></a>
 </p>
 
 <p align="center">
@@ -28,6 +30,7 @@ OpenAlerts watches your agent in real-time and alerts you the moment something g
 ## Quickstart
 
 > Currently supports OpenClaw. More framework adapters coming soon.
+> This project is under revamp for the next few hours
 
 ### 1. Install
 
@@ -43,17 +46,17 @@ Otherwise, set it explicitly in `openclaw.json`:
 
 ```jsonc
 {
-  "plugins": {
-    "entries": {
-      "openalerts": {
-        "enabled": true,
-        "config": {
-          "alertChannel": "telegram",  // telegram | discord | slack | whatsapp | signal
-          "alertTo": "YOUR_CHAT_ID"
-        }
-      }
-    }
-  }
+	"plugins": {
+		"entries": {
+			"openalerts": {
+				"enabled": true,
+				"config": {
+					"alertChannel": "telegram", // telegram | discord | slack | whatsapp | signal
+					"alertTo": "YOUR_CHAT_ID",
+				},
+			},
+		},
+	},
 }
 ```
 
@@ -65,11 +68,14 @@ Otherwise, set it explicitly in `openclaw.json`:
 openclaw gateway stop && openclaw gateway run
 ```
 
-
 Send `/health` to your bot. You should get a live status report back — zero LLM tokens consumed.
 
 That's it. OpenAlerts is now watching your agent.
 
+## Demo
+
+https://github.com/user-attachments/assets/0b6ed26e-1eb0-47b2-ae4f-947516f024b4
+
 ## Dashboard
 
 A real-time web dashboard is embedded in the gateway at:
@@ -78,26 +84,30 @@ A real-time web dashboard is embedded in the gateway at:
 http://127.0.0.1:18789/openalerts
 ```
 
-- **Activity** — Live event timeline with session flows, tool calls, LLM usage
+- **Activity** — Step-by-step execution timeline with tool calls, LLM usage, costs
+- **Sessions** — Active sessions with cost/token aggregation
+- **Execs** — Shell command executions with output capture
 - **System Logs** — Filtered, structured logs with search
 - **Health** — Rule status, alert history, system stats
+- **Debug** — State snapshot for troubleshooting
 
 ## Alert Rules
 
-Eight rules run against every event in real-time. All thresholds and cooldowns are configurable.
+Ten rules run against every event in real-time. All thresholds and cooldowns are configurable.
 
-| Rule | Watches for | Severity | Threshold (default) |
-|---|---|---|---|
-| `llm-errors` | LLM/agent failures in 1 min window | ERROR | `1` error |
-| `infra-errors` | Infrastructure errors in 1 min window | ERROR | `1` error |
-| `gateway-down` | No heartbeat received | CRITICAL | `30000` ms (30s) |
-| `session-stuck` | Session idle too long | WARN | `120000` ms (2 min) |
-| `high-error-rate` | Message failure rate over last 20 | ERROR | `50`% |
-| `queue-depth` | Queued items piling up | WARN | `10` items |
-| `tool-errors` | Tool failures in 1 min window | WARN | `1` error |
-| `heartbeat-fail` | Consecutive heartbeat failures | ERROR | `3` failures |
+| Rule              | Watches for                           | Severity | Threshold (default) |
+| ----------------- | ------------------------------------- | -------- | ------------------- |
+| `llm-errors`      | LLM/agent failures in 1 min window    | ERROR    | `1` error           |
+| `infra-errors`    | Infrastructure errors in 1 min window | ERROR    | `1` error           |
+| `gateway-down`    | No heartbeat received                 | CRITICAL | `30000` ms (30s)    |
+| `session-stuck`   | Session idle too long                 | WARN     | `120000` ms (2 min) |
+| `high-error-rate` | Message failure rate over last 20     | ERROR    | `50`%               |
+| `queue-depth`     | Queued items piling up                | WARN     | `10` items          |
+| `tool-errors`     | Tool failures in 1 min window         | WARN     | `1` error           |
+| `heartbeat-fail`  | Consecutive heartbeat failures        | ERROR    | `3` failures        |
 
 Every rule also accepts:
+
 - **`enabled`** — `false` to disable the rule (default: `true`)
 - **`cooldownMinutes`** — minutes before the same rule can fire again (default: `15`)
 
@@ -105,21 +115,21 @@ To tune rules, add a `rules` object in your plugin config:
 
 ```jsonc
 {
-  "plugins": {
-    "entries": {
-      "openalerts": {
-        "config": {
-          "cooldownMinutes": 10,
-          "rules": {
-            "llm-errors": { "threshold": 5 },
-            "infra-errors": { "cooldownMinutes": 30 },
-            "high-error-rate": { "enabled": false },
-            "gateway-down": { "threshold": 60000 }
-          }
-        }
-      }
-    }
-  }
+	"plugins": {
+		"entries": {
+			"openalerts": {
+				"config": {
+					"cooldownMinutes": 10,
+					"rules": {
+						"llm-errors": { "threshold": 5 },
+						"infra-errors": { "cooldownMinutes": 30 },
+						"high-error-rate": { "enabled": false },
+						"gateway-down": { "threshold": 60000 },
+					},
+				},
+			},
+		},
+	},
 }
 ```
 
@@ -131,15 +141,15 @@ OpenAlerts can optionally use your configured LLM to enrich alerts with a human-
 
 ```jsonc
 {
-  "plugins": {
-    "entries": {
-      "openalerts": {
-        "config": {
-          "llmEnriched": true
-        }
-      }
-    }
-  }
+	"plugins": {
+		"entries": {
+			"openalerts": {
+				"config": {
+					"llmEnriched": true,
+				},
+			},
+		},
+	},
 }
 ```
 
@@ -161,11 +171,11 @@ Action: Update your API key in ~/.openclaw/.env with a valid key from platform.o
 
 Zero-token chat commands available in any connected channel:
 
-| Command | What it does |
-|---|---|
-| `/health` | System health snapshot — uptime, active alerts, stats |
-| `/alerts` | Recent alert history with severity and timestamps |
-| `/dashboard` | Returns the dashboard URL |
+| Command      | What it does                                          |
+| ------------ | ----------------------------------------------------- |
+| `/health`    | System health snapshot — uptime, active alerts, stats |
+| `/alerts`    | Recent alert history with severity and timestamps     |
+| `/dashboard` | Returns the dashboard URL                             |
 
 ## Roadmap
 

package/dist/collections/collection-manager.d.ts

@@ -0,0 +1,50 @@
+import { type MonitorSession, type MonitorAction, type MonitorExecEvent, type MonitorExecProcess, type MonitorExecProcessStatus, type CollectionStats, type CostUsageSummary } from "./types.js";
+export declare class CollectionManager {
+    private sessions;
+    private actions;
+    private execs;
+    private runSessionMap;
+    private parentActionHistory;
+    private onSessionChange?;
+    private onActionChange?;
+    private onExecChange?;
+    constructor();
+    setCallbacks(callbacks: {
+        onSessionChange?: (session: MonitorSession) => void;
+        onActionChange?: (action: MonitorAction) => void;
+        onExecChange?: (exec: MonitorExecProcess) => void;
+    }): void;
+    private trackParentAction;
+    private inferSpawnedBy;
+    private resolveSessionKey;
+    private backfillExecSessionKey;
+    private createPlaceholderExec;
+    upsertSession(session: Partial<MonitorSession>): void;
+    updateSessionStatus(key: string, status: MonitorSession["status"]): void;
+    addAction(action: MonitorAction): void;
+    addExecEvent(event: MonitorExecEvent): void;
+    getSessions(): MonitorSession[];
+    /**
+     * Returns only recently-active sessions for the dashboard.
+     * Filters out stale idle sessions loaded from filesystem that are older than windowMs.
+     * Active/thinking sessions are always included regardless of age.
+     */
+    getActiveSessions(windowMs?: number): MonitorSession[];
+    getActions(opts?: {
+        sessionKey?: string;
+        limit?: number;
+    }): MonitorAction[];
+    getExecs(opts?: {
+        status?: MonitorExecProcessStatus;
+        sessionKey?: string;
+    }): MonitorExecProcess[];
+    getExec(id: string): MonitorExecProcess | undefined;
+    getStats(): CollectionStats;
+    updateSessionCost(sessionKey: string, costUsd: number, inputTokens?: number, outputTokens?: number): void;
+    syncAggregatedCosts(summary: CostUsageSummary): void;
+    clear(): void;
+    hydrate(sessions: MonitorSession[], actions: MonitorAction[], execEvents?: MonitorExecEvent[]): void;
+    exportSessions(): MonitorSession[];
+    exportActions(): MonitorAction[];
+    exportExecEvents(): MonitorExecEvent[];
+}