@openclaw/diagnostics-otel 2026.1.29 → 2026.2.2

package/index.ts

@@ -1,6 +1,5 @@
 import type { OpenClawPluginApi } from "openclaw/plugin-sdk";
 import { emptyPluginConfigSchema } from "openclaw/plugin-sdk";
-
 import { createDiagnosticsOtelService } from "./src/service.js";
 
 const plugin = {

package/package.json

@@ -1,13 +1,8 @@
 {
   "name": "@openclaw/diagnostics-otel",
-  "version": "2026.1.29",
-  "type": "module",
+  "version": "2026.2.2",
   "description": "OpenClaw diagnostics OpenTelemetry exporter",
-  "openclaw": {
-    "extensions": [
-      "./index.ts"
-    ]
-  },
+  "type": "module",
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/api-logs": "^0.211.0",
@@ -20,5 +15,13 @@
     "@opentelemetry/sdk-node": "^0.211.0",
     "@opentelemetry/sdk-trace-base": "^2.5.0",
     "@opentelemetry/semantic-conventions": "^1.39.0"
+  },
+  "devDependencies": {
+    "openclaw": "workspace:*"
+  },
+  "openclaw": {
+    "extensions": [
+      "./index.ts"
+    ]
   }
 }

package/src/service.test.ts

@@ -103,8 +103,8 @@ vi.mock("openclaw/plugin-sdk", async () => {
   };
 });
 
-import { createDiagnosticsOtelService } from "./service.js";
 import { emitDiagnosticEvent } from "openclaw/plugin-sdk";
+import { createDiagnosticsOtelService } from "./service.js";
 
 describe("diagnostics-otel service", () => {
   beforeEach(() => {
@@ -192,13 +192,19 @@ describe("diagnostics-otel service", () => {
     });
 
     expect(telemetryState.counters.get("openclaw.webhook.received")?.add).toHaveBeenCalled();
-    expect(telemetryState.histograms.get("openclaw.webhook.duration_ms")?.record).toHaveBeenCalled();
+    expect(
+      telemetryState.histograms.get("openclaw.webhook.duration_ms")?.record,
+    ).toHaveBeenCalled();
     expect(telemetryState.counters.get("openclaw.message.queued")?.add).toHaveBeenCalled();
     expect(telemetryState.counters.get("openclaw.message.processed")?.add).toHaveBeenCalled();
-    expect(telemetryState.histograms.get("openclaw.message.duration_ms")?.record).toHaveBeenCalled();
+    expect(
+      telemetryState.histograms.get("openclaw.message.duration_ms")?.record,
+    ).toHaveBeenCalled();
     expect(telemetryState.histograms.get("openclaw.queue.wait_ms")?.record).toHaveBeenCalled();
     expect(telemetryState.counters.get("openclaw.session.stuck")?.add).toHaveBeenCalled();
-    expect(telemetryState.histograms.get("openclaw.session.stuck_age_ms")?.record).toHaveBeenCalled();
+    expect(
+      telemetryState.histograms.get("openclaw.session.stuck_age_ms")?.record,
+    ).toHaveBeenCalled();
     expect(telemetryState.counters.get("openclaw.run.attempt")?.add).toHaveBeenCalled();
 
     const spanNames = telemetryState.tracer.startSpan.mock.calls.map((call) => call[0]);
@@ -209,7 +215,7 @@ describe("diagnostics-otel service", () => {
     expect(registerLogTransportMock).toHaveBeenCalledTimes(1);
     expect(registeredTransports).toHaveLength(1);
     registeredTransports[0]?.({
-      0: "{\"subsystem\":\"diagnostic\"}",
+      0: '{"subsystem":"diagnostic"}',
       1: "hello",
       _meta: { logLevelName: "INFO", date: new Date() },
     });

package/src/service.ts

@@ -1,5 +1,6 @@
-import { metrics, trace, SpanStatusCode } from "@opentelemetry/api";
 import type { SeverityNumber } from "@opentelemetry/api-logs";
+import type { DiagnosticEventPayload, OpenClawPluginService } from "openclaw/plugin-sdk";
+import { metrics, trace, SpanStatusCode } from "@opentelemetry/api";
 import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-http";
 import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-http";
 import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
@@ -9,8 +10,6 @@ import { PeriodicExportingMetricReader } from "@opentelemetry/sdk-metrics";
 import { NodeSDK } from "@opentelemetry/sdk-node";
 import { ParentBasedSampler, TraceIdRatioBasedSampler } from "@opentelemetry/sdk-trace-base";
 import { SemanticResourceAttributes } from "@opentelemetry/semantic-conventions";
-
-import type { DiagnosticEventPayload, OpenClawPluginService } from "openclaw/plugin-sdk";
 import { onDiagnosticEvent, registerLogTransport } from "openclaw/plugin-sdk";
 
 const DEFAULT_SERVICE_NAME = "openclaw";
@@ -21,14 +20,22 @@ function normalizeEndpoint(endpoint?: string): string | undefined {
 }
 
 function resolveOtelUrl(endpoint: string | undefined, path: string): string | undefined {
-  if (!endpoint) return undefined;
-  if (endpoint.includes("/v1/")) return endpoint;
+  if (!endpoint) {
+    return undefined;
+  }
+  if (endpoint.includes("/v1/")) {
+    return endpoint;
+  }
   return `${endpoint}/${path}`;
 }
 
 function resolveSampleRate(value: number | undefined): number | undefined {
-  if (typeof value !== "number" || !Number.isFinite(value)) return undefined;
-  if (value < 0 || value > 1) return undefined;
+  if (typeof value !== "number" || !Number.isFinite(value)) {
+    return undefined;
+  }
+  if (value < 0 || value > 1) {
+    return undefined;
+  }
   return value;
 }
 
@@ -43,7 +50,9 @@ export function createDiagnosticsOtelService(): OpenClawPluginService {
     async start(ctx) {
       const cfg = ctx.config.diagnostics;
       const otel = cfg?.otel;
-      if (!cfg?.enabled || !otel?.enabled) return;
+      if (!cfg?.enabled || !otel?.enabled) {
+        return;
+      }
 
       const protocol = otel.protocol ?? process.env.OTEL_EXPORTER_OTLP_PROTOCOL ?? "http/protobuf";
       if (protocol !== "http/protobuf") {
@@ -60,7 +69,9 @@ export function createDiagnosticsOtelService(): OpenClawPluginService {
       const tracesEnabled = otel.traces !== false;
       const metricsEnabled = otel.metrics !== false;
       const logsEnabled = otel.logs === true;
-      if (!tracesEnabled && !metricsEnabled && !logsEnabled) return;
+      if (!tracesEnabled && !metricsEnabled && !logsEnabled) {
+        return;
+      }
 
       const resource = new Resource({
         [SemanticResourceAttributes.SERVICE_NAME]: serviceName,
@@ -106,7 +117,7 @@ export function createDiagnosticsOtelService(): OpenClawPluginService {
             : {}),
         });
 
-        await sdk.start();
+        sdk.start();
       }
 
       const logSeverityMap: Record<string, SeverityNumber> = {
@@ -201,11 +212,12 @@ export function createDiagnosticsOtelService(): OpenClawPluginService {
         });
         logProvider = new LoggerProvider({ resource });
         logProvider.addLogRecordProcessor(
-          new BatchLogRecordProcessor(logExporter, {
-            ...(typeof otel.flushIntervalMs === "number"
+          new BatchLogRecordProcessor(
+            logExporter,
+            typeof otel.flushIntervalMs === "number"
               ? { scheduledDelayMillis: Math.max(1000, otel.flushIntervalMs) }
-              : {}),
-          }),
+              : {},
+          ),
         );
         const otelLogger = logProvider.getLogger("openclaw");
 
@@ -237,7 +249,7 @@ export function createDiagnosticsOtelService(): OpenClawPluginService {
 
           const numericArgs = Object.entries(logObj)
             .filter(([key]) => /^\d+$/.test(key))
-            .sort((a, b) => Number(a[0]) - Number(b[0]))
+            .toSorted((a, b) => Number(a[0]) - Number(b[0]))
             .map(([, value]) => value);
 
           let bindings: Record<string, unknown> | undefined;
@@ -267,13 +279,19 @@ export function createDiagnosticsOtelService(): OpenClawPluginService {
           const attributes: Record<string, string | number | boolean> = {
             "openclaw.log.level": logLevelName,
           };
-          if (meta?.name) attributes["openclaw.logger"] = meta.name;
+          if (meta?.name) {
+            attributes["openclaw.logger"] = meta.name;
+          }
           if (meta?.parentNames?.length) {
             attributes["openclaw.logger.parents"] = meta.parentNames.join(".");
           }
           if (bindings) {
             for (const [key, value] of Object.entries(bindings)) {
-              if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") {
+              if (
+                typeof value === "string" ||
+                typeof value === "number" ||
+                typeof value === "boolean"
+              ) {
                 attributes[`openclaw.${key}`] = value;
               } else if (value != null) {
                 attributes[`openclaw.${key}`] = safeStringify(value);
@@ -283,9 +301,15 @@ export function createDiagnosticsOtelService(): OpenClawPluginService {
           if (numericArgs.length > 0) {
             attributes["openclaw.log.args"] = safeStringify(numericArgs);
           }
-          if (meta?.path?.filePath) attributes["code.filepath"] = meta.path.filePath;
-          if (meta?.path?.fileLine) attributes["code.lineno"] = Number(meta.path.fileLine);
-          if (meta?.path?.method) attributes["code.function"] = meta.path.method;
+          if (meta?.path?.filePath) {
+            attributes["code.filepath"] = meta.path.filePath;
+          }
+          if (meta?.path?.fileLine) {
+            attributes["code.lineno"] = Number(meta.path.fileLine);
+          }
+          if (meta?.path?.method) {
+            attributes["code.function"] = meta.path.method;
+          }
           if (meta?.path?.filePathWithLine) {
             attributes["openclaw.code.location"] = meta.path.filePathWithLine;
           }
@@ -322,30 +346,47 @@ export function createDiagnosticsOtelService(): OpenClawPluginService {
         };
 
         const usage = evt.usage;
-        if (usage.input) tokensCounter.add(usage.input, { ...attrs, "openclaw.token": "input" });
-        if (usage.output) tokensCounter.add(usage.output, { ...attrs, "openclaw.token": "output" });
-        if (usage.cacheRead)
+        if (usage.input) {
+          tokensCounter.add(usage.input, { ...attrs, "openclaw.token": "input" });
+        }
+        if (usage.output) {
+          tokensCounter.add(usage.output, { ...attrs, "openclaw.token": "output" });
+        }
+        if (usage.cacheRead) {
           tokensCounter.add(usage.cacheRead, { ...attrs, "openclaw.token": "cache_read" });
-        if (usage.cacheWrite)
+        }
+        if (usage.cacheWrite) {
           tokensCounter.add(usage.cacheWrite, { ...attrs, "openclaw.token": "cache_write" });
-        if (usage.promptTokens)
+        }
+        if (usage.promptTokens) {
           tokensCounter.add(usage.promptTokens, { ...attrs, "openclaw.token": "prompt" });
-        if (usage.total) tokensCounter.add(usage.total, { ...attrs, "openclaw.token": "total" });
+        }
+        if (usage.total) {
+          tokensCounter.add(usage.total, { ...attrs, "openclaw.token": "total" });
+        }
 
-        if (evt.costUsd) costCounter.add(evt.costUsd, attrs);
-        if (evt.durationMs) durationHistogram.record(evt.durationMs, attrs);
-        if (evt.context?.limit)
+        if (evt.costUsd) {
+          costCounter.add(evt.costUsd, attrs);
+        }
+        if (evt.durationMs) {
+          durationHistogram.record(evt.durationMs, attrs);
+        }
+        if (evt.context?.limit) {
           contextHistogram.record(evt.context.limit, {
             ...attrs,
             "openclaw.context": "limit",
           });
-        if (evt.context?.used)
+        }
+        if (evt.context?.used) {
           contextHistogram.record(evt.context.used, {
             ...attrs,
             "openclaw.context": "used",
           });
+        }
 
-        if (!tracesEnabled) return;
+        if (!tracesEnabled) {
+          return;
+        }
         const spanAttrs: Record<string, string | number> = {
           ...attrs,
           "openclaw.sessionKey": evt.sessionKey ?? "",
@@ -381,9 +422,13 @@ export function createDiagnosticsOtelService(): OpenClawPluginService {
         if (typeof evt.durationMs === "number") {
           webhookDurationHistogram.record(evt.durationMs, attrs);
         }
-        if (!tracesEnabled) return;
+        if (!tracesEnabled) {
+          return;
+        }
         const spanAttrs: Record<string, string | number> = { ...attrs };
-        if (evt.chatId !== undefined) spanAttrs["openclaw.chatId"] = String(evt.chatId);
+        if (evt.chatId !== undefined) {
+          spanAttrs["openclaw.chatId"] = String(evt.chatId);
+        }
         const span = spanWithDuration("openclaw.webhook.processed", spanAttrs, evt.durationMs);
         span.end();
       };
@@ -396,12 +441,16 @@ export function createDiagnosticsOtelService(): OpenClawPluginService {
           "openclaw.webhook": evt.updateType ?? "unknown",
         };
         webhookErrorCounter.add(1, attrs);
-        if (!tracesEnabled) return;
+        if (!tracesEnabled) {
+          return;
+        }
         const spanAttrs: Record<string, string | number> = {
           ...attrs,
           "openclaw.error": evt.error,
         };
-        if (evt.chatId !== undefined) spanAttrs["openclaw.chatId"] = String(evt.chatId);
+        if (evt.chatId !== undefined) {
+          spanAttrs["openclaw.chatId"] = String(evt.chatId);
+        }
         const span = tracer.startSpan("openclaw.webhook.error", {
           attributes: spanAttrs,
         });
@@ -433,13 +482,25 @@ export function createDiagnosticsOtelService(): OpenClawPluginService {
         if (typeof evt.durationMs === "number") {
           messageDurationHistogram.record(evt.durationMs, attrs);
         }
-        if (!tracesEnabled) return;
+        if (!tracesEnabled) {
+          return;
+        }
         const spanAttrs: Record<string, string | number> = { ...attrs };
-        if (evt.sessionKey) spanAttrs["openclaw.sessionKey"] = evt.sessionKey;
-        if (evt.sessionId) spanAttrs["openclaw.sessionId"] = evt.sessionId;
-        if (evt.chatId !== undefined) spanAttrs["openclaw.chatId"] = String(evt.chatId);
-        if (evt.messageId !== undefined) spanAttrs["openclaw.messageId"] = String(evt.messageId);
-        if (evt.reason) spanAttrs["openclaw.reason"] = evt.reason;
+        if (evt.sessionKey) {
+          spanAttrs["openclaw.sessionKey"] = evt.sessionKey;
+        }
+        if (evt.sessionId) {
+          spanAttrs["openclaw.sessionId"] = evt.sessionId;
+        }
+        if (evt.chatId !== undefined) {
+          spanAttrs["openclaw.chatId"] = String(evt.chatId);
+        }
+        if (evt.messageId !== undefined) {
+          spanAttrs["openclaw.messageId"] = String(evt.messageId);
+        }
+        if (evt.reason) {
+          spanAttrs["openclaw.reason"] = evt.reason;
+        }
         const span = spanWithDuration("openclaw.message.processed", spanAttrs, evt.durationMs);
         if (evt.outcome === "error") {
           span.setStatus({ code: SpanStatusCode.ERROR, message: evt.error });
@@ -470,7 +531,9 @@ export function createDiagnosticsOtelService(): OpenClawPluginService {
         evt: Extract<DiagnosticEventPayload, { type: "session.state" }>,
       ) => {
         const attrs: Record<string, string> = { "openclaw.state": evt.state };
-        if (evt.reason) attrs["openclaw.reason"] = evt.reason;
+        if (evt.reason) {
+          attrs["openclaw.reason"] = evt.reason;
+        }
         sessionStateCounter.add(1, attrs);
       };
 
@@ -482,10 +545,16 @@ export function createDiagnosticsOtelService(): OpenClawPluginService {
         if (typeof evt.ageMs === "number") {
           sessionStuckAgeHistogram.record(evt.ageMs, attrs);
         }
-        if (!tracesEnabled) return;
+        if (!tracesEnabled) {
+          return;
+        }
         const spanAttrs: Record<string, string | number> = { ...attrs };
-        if (evt.sessionKey) spanAttrs["openclaw.sessionKey"] = evt.sessionKey;
-        if (evt.sessionId) spanAttrs["openclaw.sessionId"] = evt.sessionId;
+        if (evt.sessionKey) {
+          spanAttrs["openclaw.sessionKey"] = evt.sessionKey;
+        }
+        if (evt.sessionId) {
+          spanAttrs["openclaw.sessionId"] = evt.sessionId;
+        }
         spanAttrs["openclaw.queueDepth"] = evt.queueDepth ?? 0;
         spanAttrs["openclaw.ageMs"] = evt.ageMs;
         const span = tracer.startSpan("openclaw.session.stuck", { attributes: spanAttrs });