@tracepanel/js 0.5.0 → 0.7.0

package/dist/koa.js

@@ -0,0 +1,119 @@
+// `app.use(tracepanel())`, first: Koa middleware. The handler of each @koa/router route is a span of its own, named
+// by its route (`/books/:id`), and so is the request's trace. Every response gets what the badge reads
+// (Tracepanel-Id, Server-Timing), an error's answer too, and an HTML page the widget's script: a string or a Buffer
+// has it put into its body, a stream as it passes. What the request carried goes into its trace as the response goes
+// out: its headers, query, cookies, the body a body parser read (`ctx.request.body`, its files), the session
+// (`ctx.session`), and the response's headers. An error is the request's unless Koa answers it below 500 (`ctx.throw(404)`).
+//
+// The handlers are found from the app's middleware, as the request comes: the routers it mounted (`router.routes()`,
+// and the routers nested in them), each route's last function its handler. OpenTelemetry's Koa instrumentation does
+// the same from Koa's `use()`, once, with a span for each middleware besides; here the routes added later count too.
+import { hasBody, parsedBody, requestAttrs, responseHeaders, searchOf } from "./request.js";
+import { runtime } from "./runtime.js";
+import { expressSession } from "./session.js";
+import { inView, statusOf, wasRecorded } from "./view.js";
+import { inject, responseMarks, streamablePage, streamWith } from "./widget.js";
+const FRAMEWORK = "Koa";
+const TRACED = Symbol.for("tracepanel.koa.handler");
+// How many layers each router had when its handlers were traced: a route added since is traced as it comes.
+const seen = new WeakMap();
+/** Each route's handler in a span, in every router among these middleware, and in the routers nested in them. */
+function traceRoutes(middleware) {
+    for (const fn of middleware) {
+        const router = fn.router;
+        if (!router || !Array.isArray(router.stack) || seen.get(router) === router.stack.length)
+            continue;
+        seen.set(router, router.stack.length);
+        for (const layer of router.stack) {
+            if (!Array.isArray(layer.stack))
+                continue;
+            traceRoutes(layer.stack);
+            const last = layer.stack.length - 1;
+            const handler = layer.stack[last];
+            // A route's own layer has its methods; router.use()'s middleware has none.
+            if (!handler || handler.router || handler[TRACED] || layer.methods.length === 0)
+                continue;
+            const route = String(layer.path);
+            const traced = (ctx, next) => inView(route, null, () => handler(ctx, next));
+            traced[TRACED] = true;
+            layer.stack[last] = traced;
+        }
+    }
+}
+function isStream(body) {
+    return body !== null && typeof body === "object" && typeof body.pipe === "function";
+}
+/** What the request carried, the body a parser read, the session as the handler left it, the response's headers. */
+function carried(ctx) {
+    const { request, session } = ctx;
+    const body = hasBody(ctx.headers)
+        ? parsedBody({ contentType: ctx.get("content-type"), body: request.body, files: request.files })
+        : {};
+    return {
+        ...requestAttrs(ctx.headers, searchOf(ctx.originalUrl ?? ctx.url)),
+        ...body,
+        ...expressSession(session),
+        ...responseHeaders(Object.entries(ctx.response.headers)),
+    };
+}
+/** The route @koa/router matched, the request's name. */
+function named(tp, ctx) {
+    const route = ctx._matchedRoute;
+    if (route !== undefined)
+        tp.processor.setRoute(String(route));
+}
+export function tracepanel() {
+    const tp = runtime();
+    return async function tracepanelMiddleware(ctx, next) {
+        if (!tp) {
+            await next();
+            return;
+        }
+        tp.processor.setFramework(FRAMEWORK);
+        const startedMs = performance.now();
+        traceRoutes(ctx.app.middleware);
+        const badge = (status, page) => responseMarks(tp, { method: ctx.method, status, startedMs, page, framework: tp.processor.framework() ?? FRAMEWORK }, ctx.headers, (name) => ctx.response.get(name) || undefined);
+        try {
+            await next();
+        }
+        catch (error) {
+            named(tp, ctx);
+            if (statusOf(error) >= 500 && !wasRecorded(error))
+                tp.processor.addError(error);
+            if (tp.config.captureRequest)
+                tp.processor.setTraceAttrs(carried(ctx));
+            // Koa answers it once it is out of here, its headers cleared but for the error's own: the badge's go with them.
+            const marks = badge(statusOf(error), false);
+            if (marks && error !== null && typeof error === "object") {
+                const own = error.headers;
+                const headers = { ...own, ...marks.headers };
+                if (marks.cookie)
+                    headers["Set-Cookie"] = marks.cookie;
+                Object.assign(error, { headers });
+            }
+            throw error;
+        }
+        named(tp, ctx);
+        if (tp.config.captureRequest)
+            tp.processor.setTraceAttrs(carried(ctx));
+        const { body } = ctx;
+        const header = (name) => ctx.response.get(name) || undefined;
+        const html = Boolean(ctx.response.is("html")) && !header("content-encoding");
+        const whole = typeof body === "string" || Buffer.isBuffer(body);
+        const page = html && (whole || (isStream(body) && streamablePage(header)));
+        const marks = badge(ctx.status, page);
+        if (!marks)
+            return;
+        ctx.set(marks.headers);
+        if (marks.cookie)
+            ctx.append("Set-Cookie", marks.cookie);
+        if (!page || !marks.script)
+            return;
+        // Koa sets the new body's Content-Length, and leaves a stream's out.
+        if (isStream(body))
+            ctx.body = streamWith(body, marks.script);
+        else
+            ctx.body = inject(Buffer.isBuffer(body) ? body.toString("utf8") : body, marks.script);
+    };
+}
+//# sourceMappingURL=koa.js.map

package/dist/koa.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"koa.js","sourceRoot":"","sources":["../src/koa.ts"],"names":[],"mappings":"AAAA,oHAAoH;AACpH,uGAAuG;AACvG,oHAAoH;AACpH,qHAAqH;AACrH,6GAA6G;AAC7G,6HAA6H;AAC7H,EAAE;AACF,qHAAqH;AACrH,oHAAoH;AACpH,qHAAqH;AAKrH,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAC5F,OAAO,EAAgB,OAAO,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEhF,MAAM,SAAS,GAAG,KAAK,CAAC;AACxB,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;AAYpD,4GAA4G;AAC5G,MAAM,IAAI,GAAG,IAAI,OAAO,EAAkB,CAAC;AAE3C,iHAAiH;AACjH,SAAS,WAAW,CAAC,UAAyB;IAC5C,KAAK,MAAM,EAAE,IAAI,UAAU,EAAE,CAAC;QAC5B,MAAM,MAAM,GAAG,EAAE,CAAC,MAAM,CAAC;QACzB,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,KAAK,CAAC,MAAM;YAAE,SAAS;QAClG,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACtC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;gBAAE,SAAS;YAC1C,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACzB,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;YACpC,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAClC,2EAA2E;YAC3E,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;gBAAE,SAAS;YAC1F,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACjC,MAAM,MAAM,GAAO,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;YAChF,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;YACtB,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;QAC7B,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,QAAQ,CAAC,IAAa;IAC7B,OAAO,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAQ,IAAiB,CAAC,IAAI,KAAK,UAAU,CAAC;AACpG,CAAC;AAOD,oHAAoH;AACpH,SAAS,OAAO,CAAC,GAAY;IAC3B,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,GAAwB,CAAC;IACtD,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;QAC/B,CAAC,CAAC,UAAU,CAAC,EAAE,WAAW,EAAE,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;QAChG,CAAC,CAAC,EAAE,CAAC;IACP,OAAO;QACL,GAAG,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAClE,GAAG,IAAI;QACP,GAAG,cAAc,CAAC,OAAO,CAAC;QAC1B,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;KACzD,CAAC;AACJ,CAAC;AAED,yDAAyD;AACzD,SAAS,KAAK,CAAC,EAAW,EAAE,GAAY;IACtC,MAAM,KAAK,GAAI,GAA6C,CAAC,aAAa,CAAC;IAC3E,IAAI,KAAK,KAAK,SAAS;QAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,UAAU;IACxB,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC;IACrB,OAAO,KAAK,UAAU,oBAAoB,CAAC,GAAY,EAAE,IAAU;QACjE,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,MAAM,IAAI,EAAE,CAAC;YACb,OAAO;QACT,CAAC;QACD,EAAE,CAAC,SAAS,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QACrC,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QACpC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,UAAkB,CAAC,CAAC;QACxC,MAAM,KAAK,GAAG,CAAC,MAAc,EAAE,IAAa,EAAE,EAAE,CAC9C,aAAa,CACX,EAAE,EACF,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,SAAS,EAAE,EACjG,GAAG,CAAC,OAAO,EACX,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,SAAS,CAC9C,CAAC;QACJ,IAAI,CAAC;YACH,MAAM,IAAI,EAAE,CAAC;QACf,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,KAAK,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;YACf,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;gBAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChF,IAAI,EAAE,CAAC,MAAM,CAAC,cAAc;gBAAE,EAAE,CAAC,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;YACvE,gHAAgH;YAChH,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;YAC5C,IAAI,KAAK,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACzD,MAAM,GAAG,GAAI,KAA+C,CAAC,OAAO,CAAC;gBACrE,MAAM,OAAO,GAA4B,EAAE,GAAG,GAAG,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;gBACtE,IAAI,KAAK,CAAC,MAAM;oBAAE,OAAO,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;gBACvD,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;YACpC,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;QACD,KAAK,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QACf,IAAI,EAAE,CAAC,MAAM,CAAC,cAAc;YAAE,EAAE,CAAC,SAAS,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QACvE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC;QACrB,MAAM,MAAM,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC;QACrE,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;QAC7E,MAAM,KAAK,GAAG,OAAO,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChE,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC3E,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACtC,IAAI,CAAC,KAAK;YAAE,OAAO;QACnB,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvB,IAAI,KAAK,CAAC,MAAM;YAAE,GAAG,CAAC,MAAM,CAAC,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACzD,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM;YAAE,OAAO;QACnC,qEAAqE;QACrE,IAAI,QAAQ,CAAC,IAAI,CAAC;YAAE,GAAG,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;;YACzD,GAAG,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAE,IAAe,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACzG,CAAC,CAAC;AACJ,CAAC"}

package/dist/llm.d.ts

@@ -0,0 +1,20 @@
+import { InstrumentationBase, InstrumentationNodeModuleDefinition } from "@opentelemetry/instrumentation";
+/** The span kind of an LLM call, in `tracepanel.span_kind`. */
+export declare const KIND = "llm";
+/** The instrumentation scope of Anthropic's SDK's own spans: the processor leaves them out. */
+export declare const ANTHROPIC_SCOPE = "com.anthropic.sdk";
+/** OpenAI's and Anthropic's clients, their API calls as LLM call spans. */
+export declare class LlmInstrumentation extends InstrumentationBase {
+    constructor();
+    protected init(): InstrumentationNodeModuleDefinition[];
+    private patch;
+}
+type Fetch = (input: string | URL | Request, init?: RequestInit) => Promise<Response>;
+/**
+ * fetch(), its calls to a model's API (a POST of JSON with a model to a known endpoint) as LLM call spans: what the
+ * AI SDK's providers and other clients of these APIs send. One an SDK's client makes is that call's already.
+ */
+export declare function llmFetch<F extends Fetch>(fetch: F): F;
+/** globalThis.fetch, its LLM calls traced, once per process. */
+export declare function traceLlmFetch(): void;
+export {};