@kohaku-ui/otel 0.1.0

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,18 @@
+# @kohaku-ui/otel
+
+Opt-in OpenTelemetry layer for kohaku: turns compose observer callbacks into spans. Ships no exporter or SDK wiring.
+
+Part of [kohaku](https://github.com/yosuque/kohaku), a reference implementation of the
+[Kohaku Protocol](https://github.com/yosuque/kohaku/blob/main/spec/SPEC.md): UI treated as data
+(a declarative UI Spec), with generation separated from rendering.
+
+```bash
+npm install @kohaku-ui/otel
+```
+
+The packages in this scope share a single version and are designed to be installed together.
+
+- Documentation: https://github.com/yosuque/kohaku#readme
+- Source: https://github.com/yosuque/kohaku/tree/main/packages/otel
+
+Licensed under the Apache License, Version 2.0.

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { createOtelComposeObserver, DEFAULT_OTEL_ATTRIBUTE_NAMES, type OtelAttributeNames, type OtelComposeObserverOptions, } from "./observer.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,4BAA4B,EAC5B,KAAK,kBAAkB,EACvB,KAAK,0BAA0B,GAChC,MAAM,eAAe,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { createOtelComposeObserver, DEFAULT_OTEL_ATTRIBUTE_NAMES, } from "./observer.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,4BAA4B,GAG7B,MAAM,eAAe,CAAC"}

package/dist/observer.d.ts

@@ -0,0 +1,75 @@
+import type { ComposeObserver } from "@kohaku-ui/composer";
+import { type Tracer } from "@opentelemetry/api";
+/**
+ * Attribute key names emitted by createOtelComposeObserver's spans. The 5 `gen_ai.*` keys follow
+ * OpenTelemetry's Generative AI semantic conventions
+ * (https://opentelemetry.io/docs/specs/semconv/gen-ai/), which are still in "Development" status as of
+ * this writing -- **the key spellings here are not a stability guarantee**, only this package's current
+ * best-effort mapping. Every name is therefore independently overridable via
+ * `createOtelComposeObserver({ attributes })`, so a future semconv rename (or a product's own convention)
+ * does not require waiting on a kohaku release. The `kohaku.*` keys are this package's own, unaffiliated
+ * with any external convention, and equally overridable for the same reason (an operator's collector /
+ * dashboards may already expect different names).
+ */
+export interface OtelAttributeNames {
+    operationName: string;
+    providerName: string;
+    requestModel: string;
+    usageInputTokens: string;
+    usageOutputTokens: string;
+    tier: string;
+    cache: string;
+    intentHash: string;
+    correlationId: string;
+    durationMs: string;
+}
+/** createOtelComposeObserver's default attribute key names (see OtelAttributeNames' doc comment). */
+export declare const DEFAULT_OTEL_ATTRIBUTE_NAMES: OtelAttributeNames;
+export interface OtelComposeObserverOptions {
+    /**
+     * The @opentelemetry/api Tracer to record spans on. Defaults to
+     * `trace.getTracer("@kohaku-ui/otel")` -- a no-op tracer when no SDK/TracerProvider is registered
+     * globally, which is exactly the safe default for KOHAKU_OTEL unset/off: every call below still runs,
+     * simply recording into a tracer that discards everything.
+     */
+    tracer?: Tracer;
+    /** Overrides for one or more attribute key names (see OtelAttributeNames). Unspecified keys keep their default (DEFAULT_OTEL_ATTRIBUTE_NAMES). */
+    attributes?: Partial<OtelAttributeNames>;
+    /**
+     * `gen_ai.provider.name`'s value (e.g. "anthropic", "openai", "ollama"). ComposeTrace carries only a
+     * model id (LlmPort.modelId), never a provider name, so this package cannot derive it on its own --
+     * pass the provider kohaku's LlmPort is actually configured with, or a function of the model id for a
+     * host mixing providers. Omitted (default): the attribute is simply not set on any span.
+     */
+    providerName?: string | ((model: string) => string | undefined);
+}
+/**
+ * Creates a ComposeObserver that records each compose as an OpenTelemetry span (thin layer: no exporter /
+ * SDK setup here -- that is left to the host process, see docs/user-guide.md's "Trace context / OTel"
+ * section). Combine with a product's own observer via @kohaku-ui/composer's `composeObservers`.
+ *
+ * - `onComposed`: one span named "kohaku.compose" per delivered Spec, ending OK (or ERROR when
+ *   trace.fallback is set -- a delivered-but-degraded Spec), with the gen_ai.* / kohaku.* attributes above.
+ *   Its `startTime` is backdated by `trace.durationMs` so the span's length approximates the actual compose
+ *   time instead of always reading ~0 (see composedAttributes' `durationMs` attribute for the exact figure).
+ * - `onError`: one ERROR-status span (the exception recorded via span.recordException when it is an Error)
+ *   for a genuine generation failure -- phase "hard" or "cache" only. Phases "fallback" (a
+ *   degraded-but-delivered Spec) and "cancelled" (a caller abort, not a real failure -- see
+ *   ComposeErrorContext's doc comment) create **no span here**: both outcomes still reach `onComposed` with
+ *   their own single ERROR/OK span (a fallback compose always calls onComposed too, with `trace.fallback`
+ *   set), so recording a second span in onError for either would double-count it -- e.g. one degraded
+ *   delivery would otherwise produce two ERROR spans and roughly double the apparent fallback rate as soon
+ *   as `KOHAKU_OTEL=1`. This mirrors the hosts' own lineage-recording skip for "cancelled" (a client
+ *   disconnect must not inflate fallback-rate analytics either).
+ * - `onBudgetCheckError`: **not a failure** (generation continues normally) -- recorded as its own span
+ *   ("kohaku.budget_check", not "kohaku.compose" -- see BUDGET_CHECK_SPAN_NAME's doc comment) with a
+ *   span event, never an ERROR status.
+ *
+ * Every hook is a plain function: any exception it throws (or a rejected Promise it returns) is swallowed
+ * by @kohaku-ui/composer's own observer fire-and-forget wrapping (fireObserverHook, used by both a bare
+ * ComposeObserver and composeObservers' per-observer isolation) -- this package relies on that existing
+ * fail-open contract rather than duplicating try/catch here, so a broken/misconfigured Tracer (e.g. no
+ * TracerProvider registered, or one that throws) never fails a compose.
+ */
+export declare function createOtelComposeObserver(options?: OtelComposeObserverOptions): ComposeObserver;
+//# sourceMappingURL=observer.d.ts.map

package/dist/observer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"observer.d.ts","sourceRoot":"","sources":["../src/observer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAuB,eAAe,EAA8B,MAAM,qBAAqB,CAAC;AAC5G,OAAO,EAUL,KAAK,MAAM,EACZ,MAAM,oBAAoB,CAAC;AAE5B;;;;;;;;;;GAUG;AACH,MAAM,WAAW,kBAAkB;IACjC,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,qGAAqG;AACrG,eAAO,MAAM,4BAA4B,EAAE,kBAW1C,CAAC;AAsBF,MAAM,WAAW,0BAA0B;IACzC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kJAAkJ;IAClJ,UAAU,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACzC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC,CAAC;CACjE;AAgFD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,GAAE,0BAA+B,GAAG,eAAe,CAuCnG"}

package/dist/observer.js

@@ -0,0 +1,170 @@
+import { createTraceState, isSpanContextValid, context as otelContext, trace as otelTrace, SpanStatusCode, } from "@opentelemetry/api";
+/** createOtelComposeObserver's default attribute key names (see OtelAttributeNames' doc comment). */
+export const DEFAULT_OTEL_ATTRIBUTE_NAMES = {
+    operationName: "gen_ai.operation.name",
+    providerName: "gen_ai.provider.name",
+    requestModel: "gen_ai.request.model",
+    usageInputTokens: "gen_ai.usage.input_tokens",
+    usageOutputTokens: "gen_ai.usage.output_tokens",
+    tier: "kohaku.tier",
+    cache: "kohaku.cache",
+    intentHash: "kohaku.intent_hash",
+    correlationId: "kohaku.correlation_id",
+    durationMs: "kohaku.duration_ms",
+};
+/** The span name onComposed / onError record under (a real compose attempt). */
+const SPAN_NAME = "kohaku.compose";
+/**
+ * The span name onBudgetCheckError records under. Deliberately distinct from SPAN_NAME: a budget-check
+ * failure is not a compose (generation continues normally around it -- see BudgetCheckErrorContext's doc
+ * comment), so folding it into "kohaku.compose" would pollute the compose span count with an unrelated event
+ * that carries no trace context (BudgetCheckErrorContext has no traceContext field to parent it under).
+ */
+const BUDGET_CHECK_SPAN_NAME = "kohaku.budget_check";
+/**
+ * `gen_ai.operation.name`'s value for a kohaku compose span. Fixed ("chat"): kohaku's L1/L2 generation is a
+ * structured-output (schema-constrained) chat completion, the closest of GenAI semconv's enumerated
+ * operation names. Set only when ComposeTrace.model is present -- an L0 fixed Spec or a cache hit never
+ * calls an LLM at all, so no span for one ever asserts a gen_ai.* attribute for an operation it did not
+ * perform.
+ */
+const GEN_AI_OPERATION_NAME = "chat";
+/**
+ * Reconstructs a parent `Context` from a `ComposeTrace`/`ComposeErrorContext`'s `traceContext` (the
+ * caller's own W3C trace, propagated via `ComposeOptions.traceContext` -- see TraceContext's doc comment
+ * in @kohaku-ui/composer), so the span created here becomes a **child** of the caller's trace instead of
+ * always starting a fresh root trace. Fail-open: a missing or malformed traceContext (defense in depth --
+ * host-rest/host-mcp-apps already validate before ever setting this field) simply falls back to the
+ * ambient active Context (today's un-parented behavior), never throws.
+ */
+function parentContextFrom(traceContext) {
+    const active = otelContext.active();
+    if (traceContext == null)
+        return active;
+    const parts = traceContext.traceparent.split("-");
+    if (parts.length !== 4)
+        return active;
+    const [, traceId, spanId, flagsHex] = parts;
+    const flags = Number.parseInt(flagsHex ?? "", 16);
+    const spanContext = {
+        traceId: traceId ?? "",
+        spanId: spanId ?? "",
+        traceFlags: Number.isNaN(flags) ? 0 : flags,
+        isRemote: true,
+        ...(traceContext.tracestate != null ? { traceState: createTraceState(traceContext.tracestate) } : {}),
+    };
+    if (!isSpanContextValid(spanContext))
+        return active;
+    return otelTrace.setSpanContext(active, spanContext);
+}
+function providerNameFor(model, providerName) {
+    if (model == null || providerName == null)
+        return undefined;
+    return typeof providerName === "function" ? providerName(model) : providerName;
+}
+/** Builds the onComposed span's attributes from a ComposeTrace (see OtelAttributeNames' doc comment). */
+function composedAttributes(trace, names, providerName) {
+    const attrs = {
+        [names.tier]: trace.tier,
+        [names.cache]: trace.cache,
+        [names.intentHash]: trace.intent.hash,
+        [names.durationMs]: trace.durationMs,
+    };
+    if (trace.correlationId != null)
+        attrs[names.correlationId] = trace.correlationId;
+    if (trace.model != null) {
+        attrs[names.operationName] = GEN_AI_OPERATION_NAME;
+        attrs[names.requestModel] = trace.model;
+        const provider = providerNameFor(trace.model, providerName);
+        if (provider != null)
+            attrs[names.providerName] = provider;
+    }
+    if (trace.usage != null) {
+        attrs[names.usageInputTokens] = trace.usage.inputTokens;
+        attrs[names.usageOutputTokens] = trace.usage.outputTokens;
+    }
+    return attrs;
+}
+/** Builds the onError span's attributes from a ComposeErrorContext (only the fields it actually has). */
+function errorAttributes(ctx, names) {
+    const attrs = {};
+    if (ctx.intent != null)
+        attrs[names.intentHash] = ctx.intent.hash;
+    if (ctx.tier != null)
+        attrs[names.tier] = ctx.tier;
+    if (ctx.correlationId != null)
+        attrs[names.correlationId] = ctx.correlationId;
+    return attrs;
+}
+function endWithComposedStatus(span, trace) {
+    span.setStatus(trace.fallback != null
+        ? { code: SpanStatusCode.ERROR, message: trace.fallback.reason }
+        : { code: SpanStatusCode.OK });
+    span.end();
+}
+/**
+ * Creates a ComposeObserver that records each compose as an OpenTelemetry span (thin layer: no exporter /
+ * SDK setup here -- that is left to the host process, see docs/user-guide.md's "Trace context / OTel"
+ * section). Combine with a product's own observer via @kohaku-ui/composer's `composeObservers`.
+ *
+ * - `onComposed`: one span named "kohaku.compose" per delivered Spec, ending OK (or ERROR when
+ *   trace.fallback is set -- a delivered-but-degraded Spec), with the gen_ai.* / kohaku.* attributes above.
+ *   Its `startTime` is backdated by `trace.durationMs` so the span's length approximates the actual compose
+ *   time instead of always reading ~0 (see composedAttributes' `durationMs` attribute for the exact figure).
+ * - `onError`: one ERROR-status span (the exception recorded via span.recordException when it is an Error)
+ *   for a genuine generation failure -- phase "hard" or "cache" only. Phases "fallback" (a
+ *   degraded-but-delivered Spec) and "cancelled" (a caller abort, not a real failure -- see
+ *   ComposeErrorContext's doc comment) create **no span here**: both outcomes still reach `onComposed` with
+ *   their own single ERROR/OK span (a fallback compose always calls onComposed too, with `trace.fallback`
+ *   set), so recording a second span in onError for either would double-count it -- e.g. one degraded
+ *   delivery would otherwise produce two ERROR spans and roughly double the apparent fallback rate as soon
+ *   as `KOHAKU_OTEL=1`. This mirrors the hosts' own lineage-recording skip for "cancelled" (a client
+ *   disconnect must not inflate fallback-rate analytics either).
+ * - `onBudgetCheckError`: **not a failure** (generation continues normally) -- recorded as its own span
+ *   ("kohaku.budget_check", not "kohaku.compose" -- see BUDGET_CHECK_SPAN_NAME's doc comment) with a
+ *   span event, never an ERROR status.
+ *
+ * Every hook is a plain function: any exception it throws (or a rejected Promise it returns) is swallowed
+ * by @kohaku-ui/composer's own observer fire-and-forget wrapping (fireObserverHook, used by both a bare
+ * ComposeObserver and composeObservers' per-observer isolation) -- this package relies on that existing
+ * fail-open contract rather than duplicating try/catch here, so a broken/misconfigured Tracer (e.g. no
+ * TracerProvider registered, or one that throws) never fails a compose.
+ */
+export function createOtelComposeObserver(options = {}) {
+    const tracer = options.tracer ?? otelTrace.getTracer("@kohaku-ui/otel");
+    const names = { ...DEFAULT_OTEL_ATTRIBUTE_NAMES, ...options.attributes };
+    return {
+        onComposed(trace) {
+            // startTime is an approximation (Date.now() minus the already-elapsed durationMs), not the compose's
+            // true wall-clock start -- close enough to keep the span's length representative in a trace waterfall
+            // rather than always reading ~0, without threading a real start timestamp through ComposeTrace.
+            const span = tracer.startSpan(SPAN_NAME, { startTime: Date.now() - trace.durationMs }, parentContextFrom(trace.traceContext));
+            span.setAttributes(composedAttributes(trace, names, options.providerName));
+            endWithComposedStatus(span, trace);
+        },
+        onError(ctx, error) {
+            // "fallback" and "cancelled" are both already represented by onComposed's own span (see this
+            // function's doc comment) -- recording a span here too would double-count them.
+            if (ctx.phase === "fallback" || ctx.phase === "cancelled")
+                return;
+            const span = tracer.startSpan(SPAN_NAME, {}, parentContextFrom(ctx.traceContext));
+            span.setAttributes(errorAttributes(ctx, names));
+            if (error instanceof Error)
+                span.recordException(error);
+            const message = error instanceof Error ? error.message : (ctx.reason ?? ctx.phase);
+            span.setStatus({ code: SpanStatusCode.ERROR, message });
+            span.end();
+        },
+        onBudgetCheckError(ctx) {
+            // This is not a failure notification (generation continues) -- see BudgetCheckErrorContext's doc
+            // comment -- so it becomes a span event, never an ERROR status. BudgetCheckErrorContext carries no
+            // traceContext (unlike ComposeTrace/ComposeErrorContext -- out of this package's scope to add), so
+            // this always starts from the ambient active Context.
+            const span = tracer.startSpan(BUDGET_CHECK_SPAN_NAME, {}, otelContext.active());
+            span.setAttributes({ [names.tier]: ctx.tier, [names.intentHash]: ctx.intent.hash });
+            span.addEvent("kohaku.budget_check_error");
+            span.end();
+        },
+    };
+}
+//# sourceMappingURL=observer.js.map

package/dist/observer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"observer.js","sourceRoot":"","sources":["../src/observer.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,gBAAgB,EAChB,kBAAkB,EAClB,OAAO,IAAI,WAAW,EACtB,KAAK,IAAI,SAAS,EAGlB,cAAc,GAEf,MAAM,oBAAoB,CAAC;AA0B5B,qGAAqG;AACrG,MAAM,CAAC,MAAM,4BAA4B,GAAuB;IAC9D,aAAa,EAAE,uBAAuB;IACtC,YAAY,EAAE,sBAAsB;IACpC,YAAY,EAAE,sBAAsB;IACpC,gBAAgB,EAAE,2BAA2B;IAC7C,iBAAiB,EAAE,4BAA4B;IAC/C,IAAI,EAAE,aAAa;IACnB,KAAK,EAAE,cAAc;IACrB,UAAU,EAAE,oBAAoB;IAChC,aAAa,EAAE,uBAAuB;IACtC,UAAU,EAAE,oBAAoB;CACjC,CAAC;AAEF,gFAAgF;AAChF,MAAM,SAAS,GAAG,gBAAgB,CAAC;AAEnC;;;;;GAKG;AACH,MAAM,sBAAsB,GAAG,qBAAqB,CAAC;AAErD;;;;;;GAMG;AACH,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAqBrC;;;;;;;GAOG;AACH,SAAS,iBAAiB,CAAC,YAAsC;IAC/D,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC;IACpC,IAAI,YAAY,IAAI,IAAI;QAAE,OAAO,MAAM,CAAC;IACxC,MAAM,KAAK,GAAG,YAAY,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAClD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,MAAM,CAAC;IACtC,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC;IAC5C,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;IAClD,MAAM,WAAW,GAAgB;QAC/B,OAAO,EAAE,OAAO,IAAI,EAAE;QACtB,MAAM,EAAE,MAAM,IAAI,EAAE;QACpB,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK;QAC3C,QAAQ,EAAE,IAAI;QACd,GAAG,CAAC,YAAY,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,gBAAgB,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACtG,CAAC;IACF,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC;QAAE,OAAO,MAAM,CAAC;IACpD,OAAO,SAAS,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AACvD,CAAC;AAED,SAAS,eAAe,CACtB,KAAyB,EACzB,YAAwD;IAExD,IAAI,KAAK,IAAI,IAAI,IAAI,YAAY,IAAI,IAAI;QAAE,OAAO,SAAS,CAAC;IAC5D,OAAO,OAAO,YAAY,KAAK,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;AACjF,CAAC;AAED,yGAAyG;AACzG,SAAS,kBAAkB,CACzB,KAAmB,EACnB,KAAyB,EACzB,YAAwD;IAExD,MAAM,KAAK,GAAe;QACxB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,IAAI;QACxB,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,KAAK;QAC1B,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI;QACrC,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU;KACrC,CAAC;IACF,IAAI,KAAK,CAAC,aAAa,IAAI,IAAI;QAAE,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC;IAClF,IAAI,KAAK,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;QACxB,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,qBAAqB,CAAC;QACnD,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC;QACxC,MAAM,QAAQ,GAAG,eAAe,CAAC,KAAK,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QAC5D,IAAI,QAAQ,IAAI,IAAI;YAAE,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAC;IAC7D,CAAC;IACD,IAAI,KAAK,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;QACxB,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC;QACxD,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC;IAC5D,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,yGAAyG;AACzG,SAAS,eAAe,CAAC,GAAwB,EAAE,KAAyB;IAC1E,MAAM,KAAK,GAAe,EAAE,CAAC;IAC7B,IAAI,GAAG,CAAC,MAAM,IAAI,IAAI;QAAE,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;IAClE,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI;QAAE,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC;IACnD,IAAI,GAAG,CAAC,aAAa,IAAI,IAAI;QAAE,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,GAAG,CAAC,aAAa,CAAC;IAC9E,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,qBAAqB,CAAC,IAAU,EAAE,KAAmB;IAC5D,IAAI,CAAC,SAAS,CACZ,KAAK,CAAC,QAAQ,IAAI,IAAI;QACpB,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE;QAChE,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE,CAChC,CAAC;IACF,IAAI,CAAC,GAAG,EAAE,CAAC;AACb,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,UAAU,yBAAyB,CAAC,OAAO,GAA+B,EAAE;IAChF,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,SAAS,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IACxE,MAAM,KAAK,GAAuB,EAAE,GAAG,4BAA4B,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAE7F,OAAO;QACL,UAAU,CAAC,KAAK;YACd,qGAAqG;YACrG,sGAAsG;YACtG,gGAAgG;YAChG,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAC3B,SAAS,EACT,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,UAAU,EAAE,EAC5C,iBAAiB,CAAC,KAAK,CAAC,YAAY,CAAC,CACtC,CAAC;YACF,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC;YAC3E,qBAAqB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,CAAC,GAAG,EAAE,KAAK;YAChB,6FAA6F;YAC7F,gFAAgF;YAChF,IAAI,GAAG,CAAC,KAAK,KAAK,UAAU,IAAI,GAAG,CAAC,KAAK,KAAK,WAAW;gBAAE,OAAO;YAClE,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,EAAE,iBAAiB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;YAClF,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;YAChD,IAAI,KAAK,YAAY,KAAK;gBAAE,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;YACxD,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;YACnF,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;YACxD,IAAI,CAAC,GAAG,EAAE,CAAC;QACb,CAAC;QACD,kBAAkB,CAAC,GAAG;YACpB,iGAAiG;YACjG,mGAAmG;YACnG,mGAAmG;YACnG,sDAAsD;YACtD,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC,sBAAsB,EAAE,EAAE,EAAE,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;YAChF,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;YACpF,IAAI,CAAC,QAAQ,CAAC,2BAA2B,CAAC,CAAC;YAC3C,IAAI,CAAC,GAAG,EAAE,CAAC;QACb,CAAC;KACF,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@kohaku-ui/otel",
+  "version": "0.1.0",
+  "description": "Opt-in OpenTelemetry layer for kohaku: turns compose observer callbacks into spans. Ships no exporter or SDK wiring.",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@kohaku-ui/composer": "^0.1.0"
+  },
+  "peerDependencies": {
+    "@opentelemetry/api": "^1.9.1",
+    "zod": "^4.6.2"
+  },
+  "devDependencies": {
+    "@opentelemetry/api": "^1.9.1",
+    "@types/node": "^25.9.6",
+    "typescript": "7.0.2",
+    "vitest": "^4.1.11",
+    "zod": "^4.6.2",
+    "@kohaku-ui/spec-core": "^0.1.0"
+  },
+  "license": "Apache-2.0",
+  "homepage": "https://github.com/yosuque/kohaku/tree/main/packages/otel#readme",
+  "bugs": {
+    "url": "https://github.com/yosuque/kohaku/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yosuque/kohaku.git",
+    "directory": "packages/otel"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "build": "rm -rf dist && tsc -p tsconfig.build.json"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts"
+}