@drej/otel 0.1.1 → 0.2.0

package/dist/index.d.mts

@@ -0,0 +1,32 @@
+import { Tracer } from "@opentelemetry/api";
+import { SandboxHooks } from "@drej/core";
+
+//#region src/index.d.ts
+interface OtelHooksOptions {
+  /** Include exit code as a span attribute on exec spans. Default: true. */
+  recordExitCode?: boolean;
+}
+/**
+ * Returns `SandboxHooks` that emit OpenTelemetry traces for every sandbox run.
+ *
+ * Pass the result via the `hooks` field of `SandboxOptions` when calling `client.sandbox()`.
+ *
+ * Span structure:
+ * ```
+ * sandbox.run            ← root span (sandboxId attribute)
+ *   sandbox.exec         ← child per exec (cmd, exitCode, seq)
+ *   sandbox.checkpoint   ← child per checkpoint (snapshotId)
+ * ```
+ *
+ * @example
+ * ```ts
+ * import { otelHooks } from "@drej/otel";
+ * import { trace } from "@opentelemetry/api";
+ *
+ * const tracer = trace.getTracer("my-app");
+ * const sb = await client.sandbox({ image: "node:22", resources: { cpu: "500m", memory: "256Mi" }, hooks: otelHooks(tracer) });
+ * ```
+ */
+declare function otelHooks(tracer: Tracer, opts?: OtelHooksOptions): SandboxHooks;
+//#endregion
+export { OtelHooksOptions, otelHooks };

package/dist/index.mjs

@@ -0,0 +1,83 @@
+import { SpanStatusCode, context, trace } from "@opentelemetry/api";
+//#region src/index.ts
+/**
+* Returns `SandboxHooks` that emit OpenTelemetry traces for every sandbox run.
+*
+* Pass the result via the `hooks` field of `SandboxOptions` when calling `client.sandbox()`.
+*
+* Span structure:
+* ```
+* sandbox.run            ← root span (sandboxId attribute)
+*   sandbox.exec         ← child per exec (cmd, exitCode, seq)
+*   sandbox.checkpoint   ← child per checkpoint (snapshotId)
+* ```
+*
+* @example
+* ```ts
+* import { otelHooks } from "@drej/otel";
+* import { trace } from "@opentelemetry/api";
+*
+* const tracer = trace.getTracer("my-app");
+* const sb = await client.sandbox({ image: "node:22", resources: { cpu: "500m", memory: "256Mi" }, hooks: otelHooks(tracer) });
+* ```
+*/
+function otelHooks(tracer, opts = {}) {
+	const { recordExitCode = true } = opts;
+	let rootSpan;
+	let rootCtx;
+	const execSpans = /* @__PURE__ */ new Map();
+	return {
+		onSandboxCreated(sandboxId, name) {
+			rootCtx = context.active();
+			rootSpan = tracer.startSpan("sandbox.run", { attributes: {
+				"drej.sandbox.id": sandboxId,
+				"drej.sandbox.name": name
+			} }, rootCtx);
+		},
+		onExecStart(sandboxId, seq, cmd) {
+			if (!rootSpan || !rootCtx) return;
+			const spanCtx = trace.setSpan(rootCtx, rootSpan);
+			const span = tracer.startSpan("sandbox.exec", { attributes: {
+				"drej.sandbox.id": sandboxId,
+				"drej.exec.seq": seq,
+				"drej.exec.cmd": cmd
+			} }, spanCtx);
+			execSpans.set(seq, span);
+		},
+		onExecComplete(_sandboxId, seq, result) {
+			const span = execSpans.get(seq);
+			if (!span) return;
+			if (recordExitCode) span.setAttribute("process.exit_code", result.exitCode);
+			span.setStatus({ code: result.exitCode === 0 ? SpanStatusCode.OK : SpanStatusCode.ERROR });
+			span.end();
+			execSpans.delete(seq);
+		},
+		onCheckpoint(sandboxId, snapshotId, name) {
+			if (!rootSpan || !rootCtx) return;
+			const spanCtx = trace.setSpan(rootCtx, rootSpan);
+			const span = tracer.startSpan("sandbox.checkpoint", { attributes: {
+				"drej.sandbox.id": sandboxId,
+				"drej.snapshot.id": snapshotId,
+				...name ? { "drej.checkpoint.name": name } : {}
+			} }, spanCtx);
+			span.setStatus({ code: SpanStatusCode.OK });
+			span.end();
+		},
+		onSandboxClosed(_sandboxId) {
+			rootSpan?.setStatus({ code: SpanStatusCode.OK });
+			rootSpan?.end();
+			rootSpan = void 0;
+		},
+		onSandboxFailed(_sandboxId, error) {
+			rootSpan?.recordException(error);
+			rootSpan?.setStatus({
+				code: SpanStatusCode.ERROR,
+				message: error.message
+			});
+			rootSpan?.end();
+			rootSpan = void 0;
+		}
+	};
+}
+//#endregion
+export { otelHooks };

package/package.json

@@ -1,12 +1,23 @@
 {
   "name": "@drej/otel",
-  "version": "0.1.1",
+  "version": "0.2.0",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.mts"
+    }
+  },
   "publishConfig": {
     "access": "public"
   },
-  "main": "./src/index.ts",
-  "peerDependencies": {
-    "@opentelemetry/api": "^1.0.0"
+  "scripts": {
+    "build": "tsdown"
   },
   "dependencies": {
     "@drej/core": "workspace:*"
@@ -14,6 +25,10 @@
   "devDependencies": {
     "@opentelemetry/api": "1.9.1",
     "bun-types": "1.3.14",
+    "tsdown": "0.22.3",
     "typescript": "6.0.3"
+  },
+  "peerDependencies": {
+    "@opentelemetry/api": "^1.0.0"
   }
 }

package/CHANGELOG.md

@@ -1,12 +0,0 @@
-# @drej/otel
-
-## 0.1.1
-
-### Patch Changes
-
-- Updated dependencies [22b8a32]
-- Updated dependencies [799b6dd]
-- Updated dependencies [8d9d8bb]
-- Updated dependencies [2fd33e0]
-- Updated dependencies [0d94c2a]
-  - @drej/core@0.3.0

package/src/index.ts

@@ -1,117 +0,0 @@
-import type { Tracer, Span, SpanStatusCode } from "@opentelemetry/api";
-import { SpanStatusCode as StatusCode, context, trace } from "@opentelemetry/api";
-import type {
-  WorkflowHooks,
-  StepHookInfo,
-  StepCompleteHookInfo,
-  StepFailedHookInfo,
-  WorkflowCompleteHookInfo,
-  WorkflowFailedHookInfo,
-  WorkflowHookInfo,
-} from "@drej/core";
-
-export interface OtelHooksOptions {
-  /** Include sandbox ID as a span attribute when present in step output. Default: true. */
-  recordSandboxId?: boolean;
-  /** Include exit code as a span attribute on exec_command steps. Default: true. */
-  recordExitCode?: boolean;
-}
-
-/**
- * Returns `WorkflowHooks` that emit OpenTelemetry traces for every workflow run.
- *
- * Pass the result to `client.run(wf, { hooks: otelHooks(tracer) })`.
- *
- * Span structure:
- * ```
- * workflow.run          ← root span, name = workflow name
- *   workflow.step       ← child per step, name = step type
- *   workflow.step
- * ```
- *
- * @example
- * ```ts
- * import { otelHooks } from "@drej/otel";
- * import { trace } from "@opentelemetry/api";
- *
- * const tracer = trace.getTracer("my-app");
- * const run = await client.run(wf, { hooks: otelHooks(tracer) });
- * ```
- */
-export function otelHooks(tracer: Tracer, opts: OtelHooksOptions = {}): WorkflowHooks {
-  const { recordSandboxId = true, recordExitCode = true } = opts;
-
-  let rootSpan: Span | undefined;
-  let rootCtx: ReturnType<typeof context.active> | undefined;
-  const stepSpans = new Map<number, Span>();
-
-  return {
-    onWorkflowStart({ workflowName, runId }: WorkflowHookInfo) {
-      rootCtx = context.active();
-      rootSpan = tracer.startSpan(
-        "workflow.run",
-        {
-          attributes: {
-            "drej.workflow.name": workflowName,
-            "drej.run.id": runId,
-          },
-        },
-        rootCtx,
-      );
-    },
-
-    onStepStart({ stepIndex, stepId }: StepHookInfo) {
-      if (!rootSpan || !rootCtx) return;
-      const spanCtx = trace.setSpan(rootCtx, rootSpan);
-      const span = tracer.startSpan(
-        "workflow.step",
-        {
-          attributes: {
-            "drej.step.index": stepIndex,
-            "drej.step.type": stepId,
-          },
-        },
-        spanCtx,
-      );
-      stepSpans.set(stepIndex, span);
-    },
-
-    onStepComplete({ stepIndex, output }: StepCompleteHookInfo) {
-      const span = stepSpans.get(stepIndex);
-      if (!span) return;
-      if (recordSandboxId) {
-        const sandboxId = (output as Record<string, unknown>)?.sandboxId;
-        if (typeof sandboxId === "string") span.setAttribute("drej.sandbox.id", sandboxId);
-      }
-      if (recordExitCode) {
-        const exitCode = (output as Record<string, unknown>)?.exitCode;
-        if (typeof exitCode === "number") span.setAttribute("process.exit_code", exitCode);
-      }
-      span.setStatus({ code: StatusCode.OK });
-      span.end();
-      stepSpans.delete(stepIndex);
-    },
-
-    onStepFailed({ stepIndex, error }: StepFailedHookInfo) {
-      const span = stepSpans.get(stepIndex);
-      if (!span) return;
-      span.recordException(error);
-      span.setStatus({ code: StatusCode.ERROR, message: error.message });
-      span.end();
-      stepSpans.delete(stepIndex);
-    },
-
-    onWorkflowComplete(_info: WorkflowCompleteHookInfo) {
-      rootSpan?.setStatus({ code: StatusCode.OK });
-      rootSpan?.end();
-      rootSpan = undefined;
-    },
-
-    onWorkflowFailed({ error }: WorkflowFailedHookInfo) {
-      rootSpan?.recordException(error);
-      rootSpan?.setStatus({ code: StatusCode.ERROR, message: error.message });
-      rootSpan?.end();
-      rootSpan = undefined;
-    },
-  };
-}

package/tsconfig.json

@@ -1,13 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ESNext",
-    "module": "ESNext",
-    "moduleResolution": "bundler",
-    "strict": true,
-    "noEmit": true,
-    "skipLibCheck": true,
-    "allowImportingTsExtensions": true,
-    "types": ["bun-types"]
-  },
-  "include": ["src"]
-}