opsveritas-sdk 0.1.4 → 0.2.0

package/README.md

@@ -0,0 +1,65 @@
+# opsveritas-sdk
+
+Monitor your AI agents in **three lines of code**. Tracks tokens, cost, latency, model, and silent failures (200 OK with empty output) — and routes alerts to Slack / Email / Teams via [OpsVeritas AI Agents Control Tower](https://agents.opsveritas.com).
+
+```bash
+npm install opsveritas-sdk
+```
+
+## Quick start (3 lines)
+
+```ts
+import { OpsVeritas } from 'opsveritas-sdk';
+
+OpsVeritas.init('<your-ingest-key>');                 // key from Settings → Integrations
+const client = OpsVeritas.wrap(new OpenAI(), { agentName: 'Support Bot' });
+// use `client` exactly as before — runs appear in your dashboard automatically
+```
+
+Works the same for Anthropic and Gemini clients. Prefer manual control? Wrap a function:
+
+```ts
+await OpsVeritas.trace('Nightly Report', async () => runReport());
+```
+
+## What data is sent
+
+By design the SDK sends **metadata only, plus a short output snippet** — never your prompts/inputs:
+
+| Sent | Detail |
+|------|--------|
+| ✅ Metadata | agent name, status, timestamps, duration, token counts, model, cost, tool-call count |
+| ⚠️ Output snippet | first 300 chars of the response (`output_summary`) — powers silent-failure detection |
+| ⚠️ Error message | the exception text, if a call fails |
+| ❌ Prompts / inputs | **never sent** — only token counts |
+
+### Metadata-only mode (for regulated / client data)
+
+Drop the output snippet and redact error text so **no response content ever leaves your environment** — token/cost/latency metadata still flows:
+
+```ts
+OpsVeritas.init('<your-ingest-key>', { metadataOnly: true });
+```
+
+Or set the environment variable:
+
+```bash
+OPSVERITAS_METADATA_ONLY=true
+```
+
+## Reliability
+
+Telemetry is **non-blocking and fire-and-forget** — it never throws into your code and never slows your agent. If the ingest endpoint is briefly unreachable, sends are **retried with backoff** and **buffered in memory** (bounded), then flushed on the next event — so a transient outage doesn't lose telemetry.
+
+## Configuration
+
+```ts
+OpsVeritas.init(apiKey, {
+  endpoint,      // optional — defaults to https://agents.opsveritas.com
+  metadataOnly,  // optional — default false; when true, no response content is sent
+});
+```
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -1,5 +1,6 @@
 declare function init(apiKey: string, options?: {
     endpoint?: string;
+    metadataOnly?: boolean;
 }): void;
 
 declare function run<T>(agentName: string, fn: () => Promise<T>, opts?: {

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 declare function init(apiKey: string, options?: {
     endpoint?: string;
+    metadataOnly?: boolean;
 }): void;
 
 declare function run<T>(agentName: string, fn: () => Promise<T>, opts?: {

package/dist/index.js

@@ -35,7 +35,9 @@ function init(apiKey, options) {
   if (!apiKey || typeof apiKey !== "string") throw new Error("[OpsVeritas] apiKey is required");
   _config = {
     apiKey,
-    endpoint: (options?.endpoint ?? "https://agents.opsveritas.com").replace(/\/$/, "")
+    endpoint: (options?.endpoint ?? "https://agents.opsveritas.com").replace(/\/$/, ""),
+    // Opt-in via init() or the OPSVERITAS_METADATA_ONLY=true env var. Defaults off (unchanged behavior).
+    metadataOnly: options?.metadataOnly ?? (typeof process !== "undefined" && process.env?.OPSVERITAS_METADATA_ONLY === "true")
   };
 }
 function getConfig() {
@@ -47,19 +49,77 @@ function getConfig() {
 var import_async_hooks = require("async_hooks");
 
 // src/http.ts
-async function sendExecution(payload) {
-  const { apiKey, endpoint } = getConfig();
+var RETRY_BACKOFF_MS = [500, 2e3, 5e3];
+var MAX_BUFFER = 200;
+var buffer = [];
+var flushing = false;
+function sleep(ms) {
+  return new Promise((resolve) => {
+    const t = setTimeout(resolve, ms);
+    if (typeof t?.unref === "function") t.unref();
+  });
+}
+function scrubForMetadataOnly(payload) {
+  return {
+    ...payload,
+    output_summary: void 0,
+    error_message: payload.error_message != null ? "[redacted \u2014 metadata-only mode]" : payload.error_message
+  };
+}
+async function postOnce(endpoint, apiKey, body) {
   try {
-    await fetch(`${endpoint}/webhooks/agent-execution`, {
+    const res = await fetch(`${endpoint}/webhooks/agent-execution`, {
       method: "POST",
-      headers: {
-        "Content-Type": "application/json",
-        "x-opsveritas-key": apiKey
-      },
-      body: JSON.stringify(payload)
+      headers: { "Content-Type": "application/json", "x-opsveritas-key": apiKey },
+      body: JSON.stringify(body)
     });
+    if (res.ok) return "ok";
+    if (res.status >= 400 && res.status < 500) return "drop";
+    return "retry";
+  } catch {
+    return "retry";
+  }
+}
+async function deliver(endpoint, apiKey, body) {
+  for (let attempt = 0; ; attempt++) {
+    const outcome = await postOnce(endpoint, apiKey, body);
+    if (outcome === "ok" || outcome === "drop") return true;
+    if (attempt >= RETRY_BACKOFF_MS.length) return false;
+    await sleep(RETRY_BACKOFF_MS[attempt]);
+  }
+}
+function enqueue(body) {
+  buffer.push(body);
+  while (buffer.length > MAX_BUFFER) buffer.shift();
+}
+async function flush(endpoint, apiKey) {
+  if (flushing || buffer.length === 0) return;
+  flushing = true;
+  try {
+    const pending = buffer.splice(0, buffer.length);
+    for (let i = 0; i < pending.length; i++) {
+      const ok = await deliver(endpoint, apiKey, pending[i]);
+      if (!ok) {
+        for (let j = pending.length - 1; j >= i; j--) buffer.unshift(pending[j]);
+        break;
+      }
+    }
+  } finally {
+    flushing = false;
+  }
+}
+async function sendExecution(payload) {
+  let cfg;
+  try {
+    cfg = getConfig();
   } catch {
+    return;
   }
+  const { apiKey, endpoint, metadataOnly } = cfg;
+  const body = metadataOnly ? scrubForMetadataOnly(payload) : payload;
+  void flush(endpoint, apiKey);
+  const ok = await deliver(endpoint, apiKey, body);
+  if (!ok) enqueue(body);
 }
 
 // src/context.ts

package/dist/index.mjs

@@ -4,7 +4,9 @@ function init(apiKey, options) {
   if (!apiKey || typeof apiKey !== "string") throw new Error("[OpsVeritas] apiKey is required");
   _config = {
     apiKey,
-    endpoint: (options?.endpoint ?? "https://agents.opsveritas.com").replace(/\/$/, "")
+    endpoint: (options?.endpoint ?? "https://agents.opsveritas.com").replace(/\/$/, ""),
+    // Opt-in via init() or the OPSVERITAS_METADATA_ONLY=true env var. Defaults off (unchanged behavior).
+    metadataOnly: options?.metadataOnly ?? (typeof process !== "undefined" && process.env?.OPSVERITAS_METADATA_ONLY === "true")
   };
 }
 function getConfig() {
@@ -16,19 +18,77 @@ function getConfig() {
 import { AsyncLocalStorage } from "async_hooks";
 
 // src/http.ts
-async function sendExecution(payload) {
-  const { apiKey, endpoint } = getConfig();
+var RETRY_BACKOFF_MS = [500, 2e3, 5e3];
+var MAX_BUFFER = 200;
+var buffer = [];
+var flushing = false;
+function sleep(ms) {
+  return new Promise((resolve) => {
+    const t = setTimeout(resolve, ms);
+    if (typeof t?.unref === "function") t.unref();
+  });
+}
+function scrubForMetadataOnly(payload) {
+  return {
+    ...payload,
+    output_summary: void 0,
+    error_message: payload.error_message != null ? "[redacted \u2014 metadata-only mode]" : payload.error_message
+  };
+}
+async function postOnce(endpoint, apiKey, body) {
   try {
-    await fetch(`${endpoint}/webhooks/agent-execution`, {
+    const res = await fetch(`${endpoint}/webhooks/agent-execution`, {
       method: "POST",
-      headers: {
-        "Content-Type": "application/json",
-        "x-opsveritas-key": apiKey
-      },
-      body: JSON.stringify(payload)
+      headers: { "Content-Type": "application/json", "x-opsveritas-key": apiKey },
+      body: JSON.stringify(body)
     });
+    if (res.ok) return "ok";
+    if (res.status >= 400 && res.status < 500) return "drop";
+    return "retry";
+  } catch {
+    return "retry";
+  }
+}
+async function deliver(endpoint, apiKey, body) {
+  for (let attempt = 0; ; attempt++) {
+    const outcome = await postOnce(endpoint, apiKey, body);
+    if (outcome === "ok" || outcome === "drop") return true;
+    if (attempt >= RETRY_BACKOFF_MS.length) return false;
+    await sleep(RETRY_BACKOFF_MS[attempt]);
+  }
+}
+function enqueue(body) {
+  buffer.push(body);
+  while (buffer.length > MAX_BUFFER) buffer.shift();
+}
+async function flush(endpoint, apiKey) {
+  if (flushing || buffer.length === 0) return;
+  flushing = true;
+  try {
+    const pending = buffer.splice(0, buffer.length);
+    for (let i = 0; i < pending.length; i++) {
+      const ok = await deliver(endpoint, apiKey, pending[i]);
+      if (!ok) {
+        for (let j = pending.length - 1; j >= i; j--) buffer.unshift(pending[j]);
+        break;
+      }
+    }
+  } finally {
+    flushing = false;
+  }
+}
+async function sendExecution(payload) {
+  let cfg;
+  try {
+    cfg = getConfig();
   } catch {
+    return;
   }
+  const { apiKey, endpoint, metadataOnly } = cfg;
+  const body = metadataOnly ? scrubForMetadataOnly(payload) : payload;
+  void flush(endpoint, apiKey);
+  const ok = await deliver(endpoint, apiKey, body);
+  if (!ok) enqueue(body);
 }
 
 // src/context.ts

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "opsveritas-sdk",
-  "version": "0.1.4",
-  "description": "Monitor your AI agents with 2 lines of code",
+  "version": "0.2.0",
+  "description": "Monitor your AI agents in 3 lines of code — tokens, cost, latency, and silent failures",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",