@skein-js/langsmith 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,90 @@
+# @skein-js/langsmith
+
+> LangSmith tracing for skein-js — run identity and thread grouping on every graph call.
+
+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
+
+LangSmith's tracer already instruments everything inside your graph — every LLM call, tool, and
+chain. What it **can't** know on its own is what a "run" is on your server, so without help every run
+lands in LangSmith as an anonymous root trace: no thread, no assistant, no user.
+
+This package supplies that identity. Above all it sets **`session_id`**, the key LangSmith's
+**Threads** view groups on — so a conversation reads as one thread in LangSmith exactly as it does
+through the Agent Protocol.
+
+It deliberately does **not** attach a tracer of its own. `@langchain/core` already installs a global
+tracer when `LANGSMITH_TRACING` is on; adding a second would send every span twice — you'd pay double
+and couldn't trust the numbers. Instead this sink makes sure that one tracer is switched on and
+properly configured, then enriches what it sends.
+
+## Install
+
+```bash
+pnpm add @skein-js/langsmith langsmith
+```
+
+`langsmith` and `@langchain/core` are optional peers — `@langchain/core` you already have via
+LangGraph.
+
+## Usage
+
+Set `LANGSMITH_API_KEY` and you're done — the sink reads it, switches tracing on, and enriches every
+run:
+
+```ts
+import { createLangSmithTelemetry } from "@skein-js/langsmith";
+import { embedInMemoryGraphs } from "@skein-js/server-kit";
+import { createExpressServer } from "@skein-js/express";
+
+const telemetry = createLangSmithTelemetry();
+const server = await createExpressServer({
+  deps: embedInMemoryGraphs({ agent }, { overrides: telemetry ? { telemetry } : {} }),
+});
+```
+
+`createLangSmithTelemetry()` returns `undefined` when LangSmith isn't configured, so the ternary above
+is the whole "is it enabled" story.
+
+Using the CLI? Don't write any of this — declare it in `langgraph.json` and `skein dev` / `skein start`
+wire it up:
+
+```json
+{ "telemetry": { "langsmith": true } }
+```
+
+With `LANGSMITH_API_KEY` set, even that is optional: the adapter is auto-detected. See
+[docs/observability.md](../../docs/observability.md).
+
+## What lands in LangSmith
+
+| Where      | What                                                                                 |
+| ---------- | ------------------------------------------------------------------------------------ |
+| `metadata` | `session_id` (= thread id), `run_id`, `thread_id`, `assistant_id`, `graph_id`        |
+| `metadata` | `ls_user_id` when auth is configured, `skein_trigger` (`wait`/`stream`/`background`) |
+| `tags`     | `skein`, `graph:<id>`, `trigger:<how>`, `assistant:<id>`                             |
+| Run name   | the graph id                                                                         |
+
+## API
+
+- **`createLangSmithTelemetry(options?): TelemetrySink | undefined`** — returns `undefined` when
+  LangSmith is not configured (no API key and no explicit `projectName`), so the result can be passed
+  straight through.
+  - `apiKey` — defaults to `LANGSMITH_API_KEY` / `LANGCHAIN_API_KEY`
+  - `projectName` — defaults to `LANGSMITH_PROJECT` / `LANGCHAIN_PROJECT`
+  - `endpoint` — defaults to `LANGSMITH_ENDPOINT`, for self-hosted LangSmith
+  - `enableTracing` — whether to switch the global tracer on when it isn't already (default `true`).
+    Existing environment values are never overwritten, so a deliberate `LANGSMITH_TRACING=false`
+    is respected.
+  - `env` — the environment to read and write; defaults to `process.env`.
+
+## 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,48 @@
+import { TelemetrySink } from '@skein-js/core';
+export { TelemetrySink } from '@skein-js/core';
+
+/** A read-only view of the environment. `process.env` in practice; injected in tests. */
+type Environment = Record<string, string | undefined>;
+interface LangSmithTelemetryOptions {
+    /** The LangSmith project traces land in. Defaults to `LANGSMITH_PROJECT` / `LANGCHAIN_PROJECT`. */
+    projectName?: string;
+    /**
+     * Switch LangChain's global tracer on if it isn't already, by setting `LANGSMITH_TRACING`.
+     * **Off by default** — see the header: enabling tracing starts sending user content to LangSmith,
+     * so it takes an explicit request. `skein` passes `true` when `langgraph.json` declares
+     * `telemetry.langsmith`; setting `LANGSMITH_TRACING=true` yourself has the same effect.
+     *
+     * An existing value is never overwritten, so a deliberate `LANGSMITH_TRACING=false` is respected.
+     *
+     * Credentials are **not** written to the environment either way. Set `LANGSMITH_API_KEY` (and, for
+     * self-hosted, `LANGSMITH_ENDPOINT`) in the environment — that is where LangChain's tracer reads
+     * them from.
+     */
+    enableTracing?: boolean;
+    /** Environment to read (and, with {@link enableTracing}, to set `LANGSMITH_TRACING` in). */
+    env?: Environment;
+}
+/**
+ * Whether LangChain's global tracer is already switched on. Exported so the runtime's provider
+ * detection can require it: finding a `LANGSMITH_API_KEY` is not on its own a request to start
+ * shipping user content off-box, but `LANGSMITH_TRACING=true` is.
+ */
+declare function isLangSmithTracingEnabled(env?: Environment): boolean;
+/**
+ * Build a {@link TelemetrySink} that makes skein's runs legible in LangSmith, or `undefined` when
+ * LangSmith is not configured — so a caller can pass the result straight through without branching.
+ *
+ * Enabled when an API key is present (from `options` or the environment), or when a `projectName` is
+ * given explicitly.
+ *
+ * ```ts
+ * const telemetry = createLangSmithTelemetry();
+ * const deps = embedInMemoryGraphs(graphs, { overrides: telemetry ? { telemetry } : {} });
+ * ```
+ *
+ * Traces are grouped into LangSmith **Threads** by `session_id`, which is set to skein's thread id —
+ * so a conversation reads as one thread there just as it does through the Agent Protocol.
+ */
+declare function createLangSmithTelemetry(options?: LangSmithTelemetryOptions): TelemetrySink | undefined;
+
+export { type LangSmithTelemetryOptions, createLangSmithTelemetry, isLangSmithTracingEnabled };

package/dist/index.js

@@ -0,0 +1,57 @@
+// src/langsmith-telemetry.ts
+function readEnv(env, ...names) {
+  for (const name of names) {
+    const value = env[name];
+    if (typeof value === "string" && value.length > 0) return value;
+  }
+  return void 0;
+}
+function processEnv() {
+  return globalThis.process?.env ?? {};
+}
+function isLangSmithTracingEnabled(env = processEnv()) {
+  const value = readEnv(env, "LANGSMITH_TRACING", "LANGCHAIN_TRACING_V2");
+  return value === "true" || value === "1";
+}
+function createLangSmithTelemetry(options = {}) {
+  const env = options.env ?? processEnv();
+  const apiKey = readEnv(env, "LANGSMITH_API_KEY", "LANGCHAIN_API_KEY");
+  const projectName = options.projectName ?? readEnv(env, "LANGSMITH_PROJECT", "LANGCHAIN_PROJECT");
+  if (apiKey === void 0 && projectName === void 0) return void 0;
+  if (options.enableTracing === true && readEnv(env, "LANGSMITH_TRACING", "LANGCHAIN_TRACING_V2") === void 0) {
+    env["LANGSMITH_TRACING"] = "true";
+  }
+  if (projectName !== void 0 && env["LANGSMITH_PROJECT"] === void 0) {
+    env["LANGSMITH_PROJECT"] = projectName;
+  }
+  return {
+    name: "langsmith",
+    traceMetadata(context) {
+      const metadata = {
+        // `session_id` is the key LangSmith's Threads view groups on. Emitting it is what turns a
+        // pile of unrelated traces into a readable conversation.
+        session_id: context.threadId,
+        skein_trigger: context.trigger
+      };
+      if (context.assistantId !== void 0) metadata["skein_assistant_id"] = context.assistantId;
+      if (context.userId !== void 0) metadata["ls_user_id"] = context.userId;
+      return metadata;
+    },
+    traceTags(context) {
+      const tags = [`trigger:${context.trigger}`];
+      if (context.assistantId !== void 0) tags.push(`assistant:${context.assistantId}`);
+      return tags;
+    },
+    async flush() {
+      try {
+        const { awaitAllCallbacks } = await import("@langchain/core/callbacks/promises");
+        await awaitAllCallbacks?.();
+      } catch {
+      }
+    }
+  };
+}
+export {
+  createLangSmithTelemetry,
+  isLangSmithTracingEnabled
+};

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@skein-js/langsmith",
+  "version": "0.11.0",
+  "description": "LangSmith tracing for skein-js — run identity and thread grouping on every graph call.",
+  "license": "Apache-2.0",
+  "author": "Maina Wycliffe <wmmaina7@gmail.com>",
+  "homepage": "https://github.com/skein-js/skein-js/tree/main/packages/telemetry-langsmith#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/skein-js/skein-js.git",
+    "directory": "packages/telemetry-langsmith"
+  },
+  "bugs": {
+    "url": "https://github.com/skein-js/skein-js/issues"
+  },
+  "keywords": [
+    "typescript",
+    "langgraph",
+    "agent-protocol",
+    "telemetry",
+    "observability",
+    "langsmith",
+    "tracing"
+  ],
+  "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": {
+    "langsmith": ">=0.3.0",
+    "@langchain/core": ">=0.3.0"
+  },
+  "peerDependenciesMeta": {
+    "langsmith": {
+      "optional": true
+    },
+    "@langchain/core": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "langsmith": "^0.7.3",
+    "@langchain/core": "^1.2.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}