convex-langfuse 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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,334 @@
+# convex-langfuse
+
+**Send LLM traces, generations, and scores from your Convex app to Langfuse.** Reactive local queries, OpenTelemetry-native ingestion.
+
+[![npm version](https://img.shields.io/npm/v/convex-langfuse)](https://www.npmjs.com/package/convex-langfuse)
+[![Convex Component](https://www.convex.dev/components/badge/sholajegede/convex-langfuse)](https://www.convex.dev/components/sholajegede/convex-langfuse)
+[![npm downloads](https://img.shields.io/npm/dw/convex-langfuse)](https://www.npmjs.com/package/convex-langfuse)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](./LICENSE)
+
+```ts
+const langfuse = new Langfuse(components.convexLangfuse, {
+  publicKey: process.env.LANGFUSE_PUBLIC_KEY!,
+  secretKey: process.env.LANGFUSE_SECRET_KEY!,
+});
+
+// Log a completed LLM call
+const { traceId } = await langfuse.logGeneration(ctx, {
+  name: "chat-completion",
+  userId: "user_123",
+  model: "gpt-5",
+  input: prompt,
+  output: completion,
+  inputTokens: 120,
+  outputTokens: 340,
+});
+
+// Attach a user rating or eval score to it
+await langfuse.recordScore(ctx, { traceId, name: "user-rating", value: 1 });
+```
+
+## What this does
+
+Most Langfuse integrations assume a long-lived Node process that can hold an OpenTelemetry span open for the duration of an LLM call. Convex actions are short, stateless, request/response functions — there's no "open a span, await a stream, close it later." This component is built for that shape: you call it once, with the finished input/output/timing/usage already in hand, and it does the rest.
+
+Under the hood it exports a single completed [OpenTelemetry span](https://langfuse.com/integrations/native/opentelemetry) per call, using Langfuse's documented span attribute conventions (`langfuse.observation.*`, `langfuse.trace.*`) — no OpenTelemetry SDK dependency, just `fetch`. This matters more than it sounds: Langfuse's older `/api/public/ingestion` batch endpoint is **deprecated and sunsets on Langfuse Cloud on November 16, 2026**. Building against the OTLP endpoint from day one means this component doesn't need a rewrite in a few months.
+
+Alongside the export, every trace, generation, and score is mirrored into Convex tables so you can query them reactively — build a live "recent generations" or "token usage" view without a separate call to Langfuse's API.
+
+- **One-shot logging** — `logGeneration()` / `logSpan()` take a finished call and export it as a proper Langfuse trace + observation
+- **Scoring** — `recordScore()` attaches an evaluation or user-rating score to any trace
+- **Reactive local queries** — traces, observations, and scores are all queryable live from Convex
+- **No SDK dependency** — talks to Langfuse's OTLP/HTTP and Scores REST endpoints directly over `fetch`
+
+## Table of Contents
+
+- [Install](#install)
+- [Quick Start](#quick-start)
+- [Usage](#usage)
+- [Continuing a Trace](#continuing-a-trace)
+- [API Reference](#api-reference)
+- [Type Reference](#type-reference)
+- [Database Schema](#database-schema)
+- [Testing](#testing)
+- [Example App](#example-app)
+- [Limitations](#limitations)
+- [Troubleshooting](#troubleshooting)
+- [Contributing](#contributing)
+- [Changelog](#changelog)
+
+## Install
+
+```bash
+npm install convex-langfuse
+```
+
+**Requirements:** Convex v1.33.1 or later, Node.js 18+, a [Langfuse](https://langfuse.com) project (Cloud or self-hosted, OTel-compatible)
+
+## Quick Start
+
+Three steps to send traces from your Convex app to Langfuse.
+
+### 1. Add the component
+
+In `convex/convex.config.ts`:
+
+```ts
+import { defineApp } from "convex/server";
+import convexLangfuse from "convex-langfuse/convex.config";
+
+const app = defineApp();
+app.use(convexLangfuse);
+
+export default app;
+```
+
+### 2. Set environment variables
+
+```bash
+npx convex env set LANGFUSE_PUBLIC_KEY pk-lf-xxxxxxxxxxxx
+npx convex env set LANGFUSE_SECRET_KEY sk-lf-xxxxxxxxxxxx
+```
+
+### 3. Initialize the client
+
+In `convex/observability.ts`:
+
+```ts
+import { components } from "./_generated/api";
+import { Langfuse } from "convex-langfuse";
+
+export const langfuse = new Langfuse(components.convexLangfuse, {
+  publicKey: process.env.LANGFUSE_PUBLIC_KEY!,
+  secretKey: process.env.LANGFUSE_SECRET_KEY!,
+  // baseUrl defaults to the EU Langfuse Cloud region — set it for US/JP/self-hosted
+});
+```
+
+Import `langfuse` from this file in any Convex action that calls an LLM.
+
+## Usage
+
+### Log a generation
+
+```ts
+export const chat = action({
+  args: { userId: v.string(), prompt: v.string() },
+  handler: async (ctx, args) => {
+    const completion = await callYourModel(args.prompt);
+
+    const { traceId } = await langfuse.logGeneration(ctx, {
+      name: "chat-completion",
+      userId: args.userId,
+      model: "gpt-5",
+      input: args.prompt,
+      output: completion,
+      inputTokens: completion.usage.inputTokens,
+      outputTokens: completion.usage.outputTokens,
+    });
+
+    return { completion, traceId };
+  },
+});
+// Returns: { traceId, observationId }
+```
+
+### Log a non-LLM step
+
+```ts
+await langfuse.logSpan(ctx, {
+  traceId,
+  name: "vector-search",
+  input: { query },
+  output: { matches },
+});
+```
+
+### Record a score
+
+```ts
+export const rate = action({
+  args: { traceId: v.string(), value: v.number() },
+  handler: async (ctx, args) => {
+    await langfuse.recordScore(ctx, {
+      traceId: args.traceId,
+      name: "user-rating",
+      value: args.value, // e.g. 1 for thumbs up, 0 for thumbs down
+    });
+    return null;
+  },
+});
+```
+
+### Read a trace reactively
+
+```ts
+export const getTrace = query({
+  args: { traceId: v.string() },
+  handler: async (ctx, args) => langfuse.getTrace(ctx, args),
+});
+
+export const getObservations = query({
+  args: { traceId: v.string() },
+  handler: async (ctx, args) => langfuse.listObservations(ctx, args),
+});
+```
+
+## Continuing a Trace
+
+Pass the `traceId` returned from the first call into subsequent `logGeneration()`/`logSpan()` calls to group multiple observations (a retrieval step, then a generation, then a tool call) under one trace in the Langfuse UI:
+
+```ts
+const { traceId } = await langfuse.logSpan(ctx, { name: "retrieve-context", ... });
+await langfuse.logGeneration(ctx, { traceId, name: "generate-answer", ... });
+```
+
+## API Reference
+
+| Method | Kind | Description |
+| --- | --- | --- |
+| `logGeneration(ctx, args)` | action | Exports a completed LLM call as a Langfuse generation |
+| `logSpan(ctx, args)` | action | Exports a completed non-LLM step as a Langfuse span |
+| `recordScore(ctx, args)` | action | Attaches an evaluation/rating score to a trace |
+| `getTrace(ctx, args)` | query | Fetch one trace by id |
+| `listTracesByUser(ctx, args)` | query | List a user's traces, newest first |
+| `listTracesBySession(ctx, args)` | query | List a session's traces, newest first |
+| `listObservations(ctx, args)` | query | List a trace's observations, oldest first |
+| `listScores(ctx, args)` | query | List a trace's scores |
+| `listRecentTraces(ctx, args?)` | query | Every trace, newest first, regardless of user/session — for a history view or dashboard |
+| `getStats(ctx)` | query | Aggregate trace/observation/score counts for a small dashboard |
+
+## Type Reference
+
+```ts
+type LogObservationArgs = {
+  traceId?: string;       // omit to start a new trace
+  traceName?: string;
+  userId?: string;
+  sessionId?: string;
+  tags?: string[];
+  release?: string;
+  traceMetadata?: Record<string, unknown>;
+
+  name: string;
+  input?: unknown;
+  output?: unknown;
+  model?: string;
+  inputTokens?: number;
+  outputTokens?: number;
+  level?: "DEBUG" | "DEFAULT" | "WARNING" | "ERROR";
+  statusMessage?: string;
+  metadata?: Record<string, unknown>;
+  startTime?: number;      // ms epoch, defaults to now
+  endTime?: number;        // ms epoch, defaults to startTime
+};
+
+type Trace = {
+  traceId: string;
+  name: string;
+  userId?: string;
+  sessionId?: string;
+  tags?: string[];
+  metadata?: string;
+  release?: string;
+};
+
+type Observation = {
+  observationId: string;
+  traceId: string;
+  type: "span" | "generation" | "event" | "embedding" | "agent" | "tool"
+      | "chain" | "retriever" | "guardrail" | "evaluator";
+  name: string;
+  input?: string;
+  output?: string;
+  model?: string;
+  inputTokens?: number;
+  outputTokens?: number;
+  level: "DEBUG" | "DEFAULT" | "WARNING" | "ERROR";
+  statusMessage?: string;
+  metadata?: string;
+  startedAt: number;
+  endedAt: number;
+};
+
+type Score = {
+  scoreId: string;
+  traceId: string;
+  name: string;
+  value: number;
+  comment?: string;
+};
+```
+
+## Database Schema
+
+```ts
+traces: {
+  traceId, name, userId?, sessionId?, tags?, metadata?, release?,
+  createdAt, updatedAt,
+}
+
+observations: {
+  observationId, traceId, type, name, input?, output?, model?,
+  inputTokens?, outputTokens?, level, statusMessage?, metadata?,
+  startedAt, endedAt, createdAt,
+}
+
+scores: {
+  scoreId, traceId, name, value, comment?, createdAt,
+}
+```
+
+`listRecentTraces()` and `getStats()` read across these tables directly with a full scan — fine for a history view or small dashboard, not intended as a high-volume production query path.
+
+## Testing
+
+```bash
+npm run test
+```
+
+Component logic is tested with [`convex-test`](https://www.npmjs.com/package/convex-test) in `src/component/lib.test.ts`. Import `convex-langfuse/test` in your own app to register this component's schema against your test instance.
+
+## Example App
+
+`example/` is a full Vite + React demo that exercises the entire component end to end against your own Langfuse account:
+
+- **Log a generation** — simulate a finished chat completion (model, prompt, completion, token counts, tags) and export it as a Langfuse generation.
+- **Continue the trace** — attach a non-LLM step (a retrieval, a tool call, a guardrail check) to the same trace via `logSpan()`.
+- **Rate the response** — attach a 👍/👎 `recordScore()` call, with an optional comment.
+- **Trace explorer** — look up any trace by id, or browse the traces recorded for a given user/session, all reactive.
+- **History** — every trace ever recorded in the deployment, newest first, independent of the browser-local demo identity that resets on reload. Expand a trace to see its full generation/step/score detail, and hit **Replay this** to recreate the whole scenario as a brand-new trace live, without retyping anything — useful for anyone poking at the demo who wants to see the flow without filling out forms themselves.
+- **Activity console** — a side-docked live log of every call this app makes into the Langfuse client. Since Langfuse ingestion is one-way (no webhooks call back into Convex), this is the closest thing to a live feed the example has.
+
+Run it from the repo root:
+
+```bash
+npm install --legacy-peer-deps
+npx convex env set LANGFUSE_PUBLIC_KEY pk-lf-xxxxxxxxxxxx
+npx convex env set LANGFUSE_SECRET_KEY sk-lf-xxxxxxxxxxxx
+npm run dev
+```
+
+`npm run dev` starts the Convex backend and the Vite frontend together — there's no need to `cd example` or run either one separately.
+
+## Limitations
+
+- No live/streaming spans — each call exports one already-finished observation. For a call you want to see "in progress," log it once it completes rather than trying to open and later close a span.
+- Trace-level fields (`userId`, `sessionId`, `tags`, `metadata`) are attached to every span you log under that trace, per Langfuse's own OTel guidance for filterable trace attributes — there's no separate "create trace" call.
+- This component does not vendor the Langfuse SDK or an OpenTelemetry SDK; it constructs minimal OTLP/HTTP JSON payloads directly, which keeps it dependency-free but means it only covers the attributes this README documents.
+
+## Troubleshooting
+
+**Nothing shows up in the Langfuse UI** — confirm `baseUrl` matches your project's region (EU, US, JP, HIPAA, or your self-hosted URL) and that the OTLP endpoint isn't blocked by a firewall between Convex and Langfuse.
+
+**401 from Langfuse** — `publicKey`/`secretKey` are combined into a Basic auth header; confirm both are set and belong to the same project.
+
+**Generation shows no cost/usage** — cost is computed by Langfuse from `inputTokens`/`outputTokens` and the model's pricing table; confirm `model` matches a model name Langfuse recognizes for your provider.
+
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md).
+
+## Changelog
+
+See [CHANGELOG.md](./CHANGELOG.md).

package/dist/client/_generated/_ignore.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=_ignore.d.ts.map

package/dist/client/_generated/_ignore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_ignore.d.ts","sourceRoot":"","sources":["../../../src/client/_generated/_ignore.ts"],"names":[],"mappings":""}

package/dist/client/_generated/_ignore.js

@@ -0,0 +1,3 @@
+"use strict";
+// This is only here so convex-test can detect a _generated folder
+//# sourceMappingURL=_ignore.js.map

package/dist/client/_generated/_ignore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_ignore.js","sourceRoot":"","sources":["../../../src/client/_generated/_ignore.ts"],"names":[],"mappings":";AAAA,kEAAkE"}