@skein-js/otel 0.11.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,95 @@
+# @skein-js/otel
+
+> OpenTelemetry spans and metrics for skein-js runs — works with any OTLP backend.
+
+Part of **[skein-js](../../README.md)** — a TypeScript [Agent Protocol](https://github.com/langchain-ai/agent-protocol) server for [LangGraph.js](https://github.com/langchain-ai/langgraphjs), and a drop-in replacement for the LangGraph CLI.
+
+## What's here
+
+One `skein.run` span per run, plus a run counter and a duration histogram.
+
+This package depends on the OpenTelemetry **API only** — never the SDK, never an exporter. That is
+the whole reason one small package covers **Datadog, Grafana, Honeycomb, Jaeger, New Relic, Sentry**
+and anything else that speaks OTLP: your app owns the SDK, the resource, and where data goes, exactly
+as it already does for the rest of your service. skein just contributes spans and metrics to it.
+
+If no SDK is registered, the API's no-op implementation takes over and this costs almost nothing.
+
+## Install
+
+```bash
+pnpm add @skein-js/otel @opentelemetry/api
+```
+
+You also need an OTel SDK in your app (`@opentelemetry/sdk-node` or a vendor distribution) — that's
+what actually exports the data.
+
+## Usage
+
+```ts
+import { createOtelTelemetry } from "@skein-js/otel";
+import { embedInMemoryGraphs } from "@skein-js/server-kit";
+import { createExpressServer } from "@skein-js/express";
+
+const server = await createExpressServer({
+  deps: embedInMemoryGraphs({ agent }, { overrides: { telemetry: createOtelTelemetry() } }),
+});
+```
+
+Unlike the LangSmith and PostHog sinks this never returns `undefined`: there is nothing to configure.
+Whether anything is _recorded_ is decided by whether your host registered an SDK.
+
+Using the CLI? Declare it in `langgraph.json` instead:
+
+```json
+{ "telemetry": { "otel": true } }
+```
+
+See [docs/observability.md](../../docs/observability.md).
+
+## What it emits
+
+**Span** `skein.run <graph_id>`, from the moment a run starts executing to the moment it settles:
+
+| Attribute                                                                |                                              |
+| ------------------------------------------------------------------------ | -------------------------------------------- |
+| `skein.run.id` · `skein.thread.id` · `skein.assistant.id`                | identity                                     |
+| `skein.graph.id` · `skein.run.trigger` · `skein.run.status`              | what ran, how it started, how it ended       |
+| `skein.run.queue_ms` · `skein.run.frames`                                | queue wait (background runs), frames emitted |
+| `skein.run.failing_nodes`                                                | the node(s) that threw, when identifiable    |
+| `gen_ai.operation.name` · `gen_ai.agent.name` · `gen_ai.conversation.id` | GenAI semconv equivalents                    |
+
+A failed run records the exception (stack and `cause` chain intact) and sets an `ERROR` status.
+
+**Metrics** — `skein.runs` (counter) and `skein.run.duration` (histogram, ms), both dimensioned by
+graph, trigger, and status. Deliberately **low-cardinality**: no run, thread, or user id, so these
+stay cheap in Prometheus and friends.
+
+## Spans inside the graph
+
+skein reports the _run_. For LLM- and tool-level spans, add a LangChain instrumentation —
+[`@traceloop/node-server-sdk`](https://github.com/traceloop/openllmetry-js) or
+[`@arizeai/openinference-instrumentation-langchain`](https://github.com/Arize-ai/openinference).
+
+Those spans are **correlated with** the run span, not **nested under** it. Nesting would need the run
+span to be _active_ in the OTel context for the whole of the graph's execution, and the sink seam is
+a pair of one-shot notifications with no way to hold a context open between them. Join on
+`skein.run.id` or `gen_ai.conversation.id` and you get the same grouping in a query — but you won't
+see generations indented under the run in a trace waterfall.
+
+## API
+
+- **`createOtelTelemetry(options?): TelemetrySink`** — always returns a sink.
+  - `scopeName` / `scopeVersion` — instrumentation scope; defaults to `"@skein-js/otel"`
+  - `metrics` — emit the counter and histogram (default `true`)
+  - `api` — a pre-resolved `{ tracer, meter }`, to pick a specific provider or capture spans in tests
+
+## Learn more
+
+- [Observability](../../docs/observability.md) — traces, metrics, and writing your own sink
+- [Errors & logging](../../docs/errors-and-logging.md) — the other two reporting surfaces
+- [skein-js overview](../../docs/index.md)
+
+## License
+
+[Apache-2.0](../../LICENSE)

package/dist/index.d.ts

@@ -0,0 +1,71 @@
+import { TelemetrySink } from '@skein-js/core';
+export { TelemetrySink } from '@skein-js/core';
+
+interface OtelSpan {
+    setAttribute(key: string, value: string | number | boolean): unknown;
+    setStatus(status: {
+        code: number;
+        message?: string;
+    }): unknown;
+    recordException(exception: Error): unknown;
+    end(endTime?: Date): void;
+}
+interface OtelTracer {
+    startSpan(name: string, options?: {
+        attributes?: Record<string, string | number | boolean>;
+        startTime?: Date;
+    }): OtelSpan;
+}
+interface OtelCounter {
+    add(value: number, attributes?: Record<string, string | number | boolean>): void;
+}
+interface OtelHistogram {
+    record(value: number, attributes?: Record<string, string | number | boolean>): void;
+}
+interface OtelMeter {
+    createCounter(name: string, options?: {
+        description?: string;
+        unit?: string;
+    }): OtelCounter;
+    createHistogram(name: string, options?: {
+        description?: string;
+        unit?: string;
+    }): OtelHistogram;
+}
+/** The pieces of the OTel API a caller can inject, so tests need no SDK. */
+interface OtelApiLike {
+    tracer: OtelTracer;
+    meter?: OtelMeter;
+}
+interface OtelTelemetryOptions {
+    /**
+     * Instrumentation scope name, as it appears on every span and metric. Defaults to
+     * `"@skein-js/otel"`; change it if you want skein's spans attributed to your own service scope.
+     */
+    scopeName?: string;
+    /** Instrumentation scope version. */
+    scopeVersion?: string;
+    /** Emit the `skein.runs` counter and `skein.run.duration` histogram. On by default. */
+    metrics?: boolean;
+    /**
+     * A pre-resolved API surface. Supply one to control which tracer/meter is used, or to capture
+     * spans in tests. When omitted, `@opentelemetry/api`'s global providers are used.
+     */
+    api?: OtelApiLike;
+}
+/**
+ * Build a {@link TelemetrySink} that records each run as an OpenTelemetry span, plus run-count and
+ * duration metrics.
+ *
+ * Unlike the LangSmith and PostHog sinks this never returns `undefined`: there is nothing to
+ * configure. Whether anything is *recorded* is decided by whether the host registered an OTel SDK —
+ * if it didn't, the API's no-op tracer silently discards, which is the behaviour you want.
+ *
+ * ```ts
+ * // The host sets up the SDK however it likes (NodeSDK, auto-instrumentation, a vendor distro):
+ * const deps = embedInMemoryGraphs(graphs, { overrides: { telemetry: createOtelTelemetry() } });
+ * ```
+ */
+declare function createOtelTelemetry(options?: OtelTelemetryOptions): TelemetrySink;
+
+export { type OtelApiLike, type OtelTelemetryOptions, createOtelTelemetry };

package/dist/index.js

@@ -0,0 +1,136 @@
+// src/otel-telemetry.ts
+var SPAN_STATUS_OK = 1;
+var SPAN_STATUS_ERROR = 2;
+var MAX_IN_FLIGHT_SPANS = 1e4;
+function isFailure(status) {
+  return status === "error" || status === "timeout";
+}
+function runAttributes(context) {
+  const attributes = {
+    "skein.run.id": context.runId,
+    "skein.thread.id": context.threadId,
+    "skein.graph.id": context.graphId,
+    "skein.run.trigger": context.trigger,
+    // The closest semconv equivalents, so a GenAI-aware backend groups skein runs with everything
+    // else it already understands.
+    "gen_ai.operation.name": "invoke_agent",
+    "gen_ai.agent.name": context.graphId,
+    "gen_ai.conversation.id": context.threadId
+  };
+  if (context.assistantId !== void 0) attributes["skein.assistant.id"] = context.assistantId;
+  if (context.userId !== void 0) attributes["skein.user.id"] = context.userId;
+  return attributes;
+}
+function metricAttributes(context, status) {
+  return {
+    "skein.graph.id": context.graphId,
+    "skein.run.trigger": context.trigger,
+    "skein.run.status": status
+  };
+}
+async function loadGlobalApi(scopeName, scopeVersion) {
+  try {
+    const otel = await import("@opentelemetry/api");
+    return {
+      tracer: otel.trace.getTracer(scopeName, scopeVersion),
+      ...otel.metrics ? { meter: otel.metrics.getMeter(scopeName, scopeVersion) } : {}
+    };
+  } catch {
+    return void 0;
+  }
+}
+function createOtelTelemetry(options = {}) {
+  const scopeName = options.scopeName ?? "@skein-js/otel";
+  const wantMetrics = options.metrics ?? true;
+  let api = options.api;
+  let buffered = api === void 0 ? [] : void 0;
+  const handlers = { emit: () => {
+  } };
+  if (api === void 0) {
+    void loadGlobalApi(scopeName, options.scopeVersion).then((resolved) => {
+      api = resolved;
+      const pending = buffered ?? [];
+      buffered = void 0;
+      if (resolved) for (const event of pending) handlers.emit(event);
+    });
+  }
+  let runCounter;
+  let durationHistogram;
+  const instruments = (meter) => {
+    runCounter ??= meter.createCounter("skein.runs", {
+      description: "Runs that reached a terminal status, dimensioned by that status."
+    });
+    durationHistogram ??= meter.createHistogram("skein.run.duration", {
+      description: "How long a run took, from running to settled.",
+      unit: "ms"
+    });
+    return { runCounter, durationHistogram };
+  };
+  const inFlight = /* @__PURE__ */ new Map();
+  handlers.emit = (event) => {
+    const active = api;
+    if (!active) return;
+    if (event.type === "run.started") {
+      if (inFlight.size >= MAX_IN_FLIGHT_SPANS) return;
+      inFlight.set(
+        event.context.runId,
+        active.tracer.startSpan(`skein.run ${event.context.graphId}`, {
+          attributes: {
+            ...runAttributes(event.context),
+            ...event.queuedMs !== void 0 ? { "skein.run.queue_ms": event.queuedMs } : {}
+          },
+          startTime: event.startedAt
+        })
+      );
+      return;
+    }
+    const span = inFlight.get(event.context.runId);
+    inFlight.delete(event.context.runId);
+    if (span) {
+      span.setAttribute("skein.run.status", event.status);
+      span.setAttribute("skein.run.frames", event.frameCount);
+      if (event.failingNodes?.length) {
+        span.setAttribute("skein.run.failing_nodes", event.failingNodes.join(","));
+      }
+      if (isFailure(event.status)) {
+        if (event.cause) span.recordException(event.cause);
+        span.setStatus({
+          code: SPAN_STATUS_ERROR,
+          ...event.error ? { message: event.error.message } : {}
+        });
+      } else {
+        span.setStatus({ code: SPAN_STATUS_OK });
+      }
+      span.end(event.endedAt);
+    }
+    if (wantMetrics && active.meter) {
+      const { runCounter: counter, durationHistogram: histogram } = instruments(active.meter);
+      const attributes = metricAttributes(event.context, event.status);
+      counter.add(1, attributes);
+      histogram.record(event.durationMs, attributes);
+    }
+  };
+  return {
+    name: "otel",
+    onRunEvent(event) {
+      if (buffered) {
+        if (buffered.length < MAX_IN_FLIGHT_SPANS) buffered.push(event);
+        return;
+      }
+      handlers.emit(event);
+    },
+    async shutdown() {
+      for (const span of inFlight.values()) {
+        try {
+          span.setStatus({ code: SPAN_STATUS_ERROR, message: "Run did not report completion." });
+          span.end();
+        } catch {
+        }
+      }
+      inFlight.clear();
+    }
+  };
+}
+export {
+  createOtelTelemetry
+};

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@skein-js/otel",
+  "version": "0.11.0",
+  "description": "OpenTelemetry spans and metrics for skein-js runs — works with any OTLP backend.",
+  "license": "Apache-2.0",
+  "author": "Maina Wycliffe <wmmaina7@gmail.com>",
+  "homepage": "https://github.com/skein-js/skein-js/tree/main/packages/telemetry-otel#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/skein-js/skein-js.git",
+    "directory": "packages/telemetry-otel"
+  },
+  "bugs": {
+    "url": "https://github.com/skein-js/skein-js/issues"
+  },
+  "keywords": [
+    "typescript",
+    "langgraph",
+    "agent-protocol",
+    "telemetry",
+    "observability",
+    "opentelemetry",
+    "otel",
+    "tracing",
+    "metrics"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "@skein-js/core": "0.11.0"
+  },
+  "peerDependencies": {
+    "@opentelemetry/api": ">=1.9.0"
+  },
+  "peerDependenciesMeta": {
+    "@opentelemetry/api": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@opentelemetry/api": "^1.9.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}