@zerolith/otel 0.0.0-canary.20261102.g8292c77

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,31 @@
+# @zerolith/otel
+
+Spans for zerolith applications through `@opentelemetry/api`, the one dependency this package has beyond zerolith. It adds nothing unless installed, and with the API's no-op tracer it costs nothing until an SDK is configured.
+
+```ts
+import { trace } from "@opentelemetry/api";
+import { navigationObserver, tracedHydrate, tracedTransport } from "@zerolith/otel";
+
+const tracer = trace.getTracer("my-app");
+const router = createRouter(appRoutes, { observe: navigationObserver(tracer) });
+const api = createClient<Api>(apiRoutes, { transport: tracedTransport(undefined, tracer) });
+tracedHydrate(App(router), "#app", tracer);
+```
+
+- `navigationObserver` opens a span when a navigation starts and ends it on commit, failure, or cancel, with the route name, the path, and the mode as attributes, and `zerolith.navigation.canceled` on a canceled one.
+- `tracedHydrate` wraps `hydrate` in a span and records the number of mismatches.
+- `tracedTransport` wraps a client transport in a client span per request, with the method, URL, and status, and injects a `traceparent` header from the active span so the server's trace continues the browser's.
+
+The guide is on the [docs site](https://zerolith.dev/guide/observability/).
+
+Status: alpha. Install with `npm install @zerolith/otel@alpha`; the API may change before 1.0.
+
+## Documentation
+
+- The [observability guide](https://zerolith.dev/guide/observability/) explains it with examples that run as tests.
+- The [reference](https://zerolith.dev/reference/zerolith-otel/) lists every export, generated from the source.
+- New to zerolith? The [tutorial](https://zerolith.dev/learn/) builds an app step by step, and the [playground](https://zerolith.dev/playground/) runs code in the browser.
+
+## License
+
+Apache-2.0. See `LICENSE`.

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @zerolith/otel: spans through `@opentelemetry/api` for the three things
+ * worth tracing in a zerolith application: a navigation, a hydration, and
+ * a request of the typed client. The application supplies the tracer, so
+ * the SDK and the exporter stay its choice, and the API's no-op tracer
+ * makes every call free until one is configured.
+ */
+import { type Context, type Tracer } from "@opentelemetry/api";
+import { type HydrateResult, type MountTarget } from "zerolith";
+import type { Transport } from "@zerolith/client";
+import type { NavigationEvent } from "@zerolith/router";
+/**
+ * The `observe` function for `createRouter`: a span named `navigate`
+ * opens when a navigation starts and ends when it commits, fails, or is
+ * canceled by a newer navigation, with `zerolith.route`, `url.path`,
+ * `url.query` when the URL has a query, and `zerolith.navigation.mode` as
+ * attributes, the loader's error recorded on failure, and
+ * `zerolith.navigation.canceled` set on a canceled one, whose status stays
+ * unset. The values of the query keys the URL conventions redact, such as
+ * `sig`, are recorded as `REDACTED`.
+ */
+export declare function navigationObserver(tracer?: Tracer): (event: NavigationEvent) => void;
+/** `hydrate` inside a span named `hydrate`, with the number of mismatches as `zerolith.hydration.mismatches`. */
+export declare function tracedHydrate(view: unknown, container: MountTarget, tracer?: Tracer): HydrateResult;
+/** The W3C `traceparent` header for a context, or undefined when no span is active in it. */
+export declare function traceparent(active?: Context): string | undefined;
+/**
+ * Wraps a transport, or `fetch` when none is given, so every request runs
+ * in a client span named by its method, as `GET`, with
+ * `http.request.method`, `url.full`, and `http.response.status_code`,
+ * carries a `traceparent` header from that span, and records a failed
+ * request as an error. The span is not named by the request's path, which
+ * would give every note its own span name; the HTTP conventions name a
+ * client span by its method when no route template is known. `url.full`
+ * records the values of the query keys the conventions redact, such as
+ * `sig`, as `REDACTED`.
+ */
+export declare function tracedTransport(transport: Transport | undefined, tracer?: Tracer): Transport;
+//# 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;;;;;;GAMG;AACH,OAAO,EAAE,KAAK,OAAO,EAAuC,KAAK,MAAM,EAAkB,MAAM,oBAAoB,CAAC;AACpH,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,WAAW,EAAW,MAAM,UAAU,CAAC;AACzE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAqBxD;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,GAAE,MAAwB,GAAG,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAsCrG;AAED,iHAAiH;AACjH,wBAAgB,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,GAAE,MAAwB,GAAG,aAAa,CAsBpH;AAED,6FAA6F;AAC7F,wBAAgB,WAAW,CAAC,MAAM,GAAE,OAA0B,GAAG,MAAM,GAAG,SAAS,CAQlF;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,EAAE,MAAM,GAAE,MAAwB,GAAG,SAAS,CA8B7G"}

package/dist/index.js

@@ -0,0 +1,133 @@
+/**
+ * @zerolith/otel: spans through `@opentelemetry/api` for the three things
+ * worth tracing in a zerolith application: a navigation, a hydration, and
+ * a request of the typed client. The application supplies the tracer, so
+ * the SDK and the exporter stay its choice, and the API's no-op tracer
+ * makes every call free until one is configured.
+ */
+import { SpanKind, SpanStatusCode, context, trace } from "@opentelemetry/api";
+import { hydrate } from "zerolith";
+/** The tracer used when none is given: the API's tracer for this package, a no-op until an SDK registers a provider. */
+function defaultTracer() {
+    return trace.getTracer("@zerolith/otel");
+}
+/** The query keys whose values the URL conventions redact by default, such as a signed URL's signature. */
+const SENSITIVE_QUERY = new Set(["X-Amz-Signature", "X-Amz-Credential", "X-Amz-Security-Token", "sig", "X-Goog-Signature"]);
+/** A URL's query component without its `?`, with the value of each key the conventions redact replaced by `REDACTED`. */
+function redactedQuery(search) {
+    return search.replace(/^\?/, "").split("&").map((pair) => {
+        const key = pair.split("=", 1)[0] ?? "";
+        return SENSITIVE_QUERY.has(key) ? `${key}=REDACTED` : pair;
+    }).join("&");
+}
+/**
+ * The `observe` function for `createRouter`: a span named `navigate`
+ * opens when a navigation starts and ends when it commits, fails, or is
+ * canceled by a newer navigation, with `zerolith.route`, `url.path`,
+ * `url.query` when the URL has a query, and `zerolith.navigation.mode` as
+ * attributes, the loader's error recorded on failure, and
+ * `zerolith.navigation.canceled` set on a canceled one, whose status stays
+ * unset. The values of the query keys the URL conventions redact, such as
+ * `sig`, are recorded as `REDACTED`.
+ */
+export function navigationObserver(tracer = defaultTracer()) {
+    const open = new Map();
+    return (event) => {
+        if (event.type === "start") {
+            const query = redactedQuery(event.url.search);
+            const span = tracer.startSpan("navigate", {
+                kind: SpanKind.INTERNAL,
+                attributes: { "url.path": event.url.pathname, ...(query === "" ? {} : { "url.query": query }), "zerolith.navigation.mode": event.mode }
+            });
+            open.set(event.id, span);
+            return;
+        }
+        const span = open.get(event.id);
+        if (span === undefined) {
+            return;
+        }
+        open.delete(event.id);
+        if (event.type === "commit") {
+            span.setAttribute("zerolith.route", event.name ?? "");
+            span.setStatus({ code: SpanStatusCode.OK });
+        }
+        else if (event.type === "cancel") {
+            span.setAttribute("zerolith.navigation.canceled", true);
+        }
+        else {
+            const error = event.error;
+            span.recordException(error instanceof Error ? error : new Error(String(error)));
+            span.setStatus({ code: SpanStatusCode.ERROR, message: error instanceof Error ? error.message : String(error) });
+        }
+        span.end();
+    };
+}
+/** `hydrate` inside a span named `hydrate`, with the number of mismatches as `zerolith.hydration.mismatches`. */
+export function tracedHydrate(view, container, tracer = defaultTracer()) {
+    return tracer.startActiveSpan("hydrate", (span) => {
+        try {
+            const result = hydrate(view, container);
+            span.setAttribute("zerolith.hydration.mismatches", result.mismatches.length);
+            span.setStatus({ code: SpanStatusCode.OK });
+            return result;
+        }
+        catch (error) {
+            span.recordException(error instanceof Error ? error : new Error(String(error)));
+            span.setStatus({ code: SpanStatusCode.ERROR });
+            throw error;
+        }
+        finally {
+            span.end();
+        }
+    });
+}
+/** The W3C `traceparent` header for a context, or undefined when no span is active in it. */
+export function traceparent(active = context.active()) {
+    const span = trace.getSpanContext(active);
+    if (span === undefined || !trace.isSpanContextValid(span)) {
+        return undefined;
+    }
+    return `00-${span.traceId}-${span.spanId}-${span.traceFlags.toString(16).padStart(2, "0")}`;
+}
+/**
+ * Wraps a transport, or `fetch` when none is given, so every request runs
+ * in a client span named by its method, as `GET`, with
+ * `http.request.method`, `url.full`, and `http.response.status_code`,
+ * carries a `traceparent` header from that span, and records a failed
+ * request as an error. The span is not named by the request's path, which
+ * would give every note its own span name; the HTTP conventions name a
+ * client span by its method when no route template is known. `url.full`
+ * records the values of the query keys the conventions redact, such as
+ * `sig`, as `REDACTED`.
+ */
+export function tracedTransport(transport, tracer = defaultTracer()) {
+    const send = transport ?? ((request) => fetch(request));
+    return (request) => {
+        const full = new URL(request.url);
+        full.search = redactedQuery(full.search);
+        return tracer.startActiveSpan(request.method, { kind: SpanKind.CLIENT, attributes: { "http.request.method": request.method, "url.full": full.href } }, async (span) => {
+            try {
+                const header = traceparent();
+                const traced = header === undefined ? request : new Request(request, { headers: withHeader(request.headers, "traceparent", header) });
+                const response = await send(traced);
+                span.setAttribute("http.response.status_code", response.status);
+                span.setStatus(response.ok ? { code: SpanStatusCode.OK } : { code: SpanStatusCode.ERROR, message: `HTTP ${response.status}` });
+                return response;
+            }
+            catch (error) {
+                span.recordException(error instanceof Error ? error : new Error(String(error)));
+                span.setStatus({ code: SpanStatusCode.ERROR, message: error instanceof Error ? error.message : String(error) });
+                throw error;
+            }
+            finally {
+                span.end();
+            }
+        });
+    };
+}
+function withHeader(headers, name, value) {
+    const copy = new Headers(headers);
+    copy.set(name, value);
+    return copy;
+}
+//# 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;;;;;;GAMG;AACH,OAAO,EAA2B,QAAQ,EAAE,cAAc,EAAe,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AACpH,OAAO,EAAwC,OAAO,EAAE,MAAM,UAAU,CAAC;AAIzE,wHAAwH;AACxH,SAAS,aAAa;IAElB,OAAO,KAAK,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;AAC7C,CAAC;AAED,2GAA2G;AAC3G,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,KAAK,EAAE,kBAAkB,CAAC,CAAC,CAAC;AAE5H,yHAAyH;AACzH,SAAS,aAAa,CAAC,MAAc;IAEjC,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QAErD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACxC,OAAO,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC;IAC/D,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACjB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAM,GAAW,aAAa,EAAE;IAE/D,MAAM,IAAI,GAAG,IAAI,GAAG,EAAgB,CAAC;IACrC,OAAO,CAAC,KAAK,EAAE,EAAE;QAEb,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAC1B,CAAC;YACG,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAC9C,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC,UAAU,EAAE;gBACtC,IAAI,EAAE,QAAQ,CAAC,QAAQ;gBACvB,UAAU,EAAE,EAAE,UAAU,EAAE,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,EAAE,0BAA0B,EAAE,KAAK,CAAC,IAAI,EAAE;aAC1I,CAAC,CAAC;YACH,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;YACzB,OAAO;QACX,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAChC,IAAI,IAAI,KAAK,SAAS,EACtB,CAAC;YACG,OAAO;QACX,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACtB,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAC3B,CAAC;YACG,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;YACtD,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE,CAAC,CAAC;QAChD,CAAC;aACI,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAChC,CAAC;YACG,IAAI,CAAC,YAAY,CAAC,8BAA8B,EAAE,IAAI,CAAC,CAAC;QAC5D,CAAC;aAED,CAAC;YACG,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;YAC1B,IAAI,CAAC,eAAe,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAChF,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACpH,CAAC;QACD,IAAI,CAAC,GAAG,EAAE,CAAC;IACf,CAAC,CAAC;AACN,CAAC;AAED,iHAAiH;AACjH,MAAM,UAAU,aAAa,CAAC,IAAa,EAAE,SAAsB,EAAE,MAAM,GAAW,aAAa,EAAE;IAEjG,OAAO,MAAM,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE;QAE9C,IACA,CAAC;YACG,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACxC,IAAI,CAAC,YAAY,CAAC,+BAA+B,EAAE,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC7E,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE,CAAC,CAAC;YAC5C,OAAO,MAAM,CAAC;QAClB,CAAC;QACD,OAAO,KAAK,EACZ,CAAC;YACG,IAAI,CAAC,eAAe,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAChF,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC;YAC/C,MAAM,KAAK,CAAC;QAChB,CAAC;gBAED,CAAC;YACG,IAAI,CAAC,GAAG,EAAE,CAAC;QACf,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAED,6FAA6F;AAC7F,MAAM,UAAU,WAAW,CAAC,MAAM,GAAY,OAAO,CAAC,MAAM,EAAE;IAE1D,MAAM,IAAI,GAAG,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAC1C,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,EACzD,CAAC;QACG,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,OAAO,MAAM,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;AAChG,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,eAAe,CAAC,SAAgC,EAAE,MAAM,GAAW,aAAa,EAAE;IAE9F,MAAM,IAAI,GAAc,SAAS,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IACnE,OAAO,CAAC,OAAO,EAAE,EAAE;QAEf,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzC,OAAO,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE,qBAAqB,EAAE,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAElK,IACA,CAAC;gBACG,MAAM,MAAM,GAAG,WAAW,EAAE,CAAC;gBAC7B,MAAM,MAAM,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,OAAO,EAAE,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;gBACtI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC;gBACpC,IAAI,CAAC,YAAY,CAAC,2BAA2B,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;gBAChE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBAC/H,OAAO,QAAQ,CAAC;YACpB,CAAC;YACD,OAAO,KAAK,EACZ,CAAC;gBACG,IAAI,CAAC,eAAe,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAChF,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBAChH,MAAM,KAAK,CAAC;YAChB,CAAC;oBAED,CAAC;gBACG,IAAI,CAAC,GAAG,EAAE,CAAC;YACf,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;AACN,CAAC;AAED,SAAS,UAAU,CAAC,OAAgB,EAAE,IAAY,EAAE,KAAa;IAE7D,MAAM,IAAI,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACtB,OAAO,IAAI,CAAC;AAChB,CAAC"}

package/package.json

@@ -0,0 +1,57 @@
+{
+    "name": "@zerolith/otel",
+    "version": "0.0.0-canary.20261102.g8292c77",
+    "description": "OpenTelemetry spans for zerolith applications through @opentelemetry/api: a span per navigation, per hydration, and per request of the typed client with traceparent propagation",
+    "license": "Apache-2.0",
+    "author": "molexxxx",
+    "homepage": "https://zerolith.dev/",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/molexxxx/zerolith.git",
+        "directory": "packages/otel"
+    },
+    "bugs": {
+        "url": "https://github.com/molexxxx/zerolith/issues"
+    },
+    "keywords": [
+        "zerolith",
+        "opentelemetry",
+        "tracing"
+    ],
+    "type": "module",
+    "sideEffects": false,
+    "engines": {
+        "node": ">=24.0.0"
+    },
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "default": "./dist/index.js"
+        },
+        "./package.json": "./package.json"
+    },
+    "files": [
+        "dist",
+        "src",
+        "LICENSE",
+        "README.md"
+    ],
+    "scripts": {
+        "build": "tsc -p tsconfig.build.json"
+    },
+    "peerDependencies": {
+        "@opentelemetry/api": ">=1.9.0 <2.0.0",
+        "@zerolith/client": "^0.0.0-canary.20261102.g8292c77",
+        "@zerolith/router": "^0.0.0-canary.20261102.g8292c77",
+        "zerolith": "^0.0.0-canary.20261102.g8292c77"
+    },
+    "peerDependenciesMeta": {
+        "@zerolith/client": { "optional": true },
+        "@zerolith/router": { "optional": true }
+    },
+    "devDependencies": {
+        "@zerolith/client": "^0.0.0-canary.20261102.g8292c77",
+        "@zerolith/router": "^0.0.0-canary.20261102.g8292c77",
+        "zerolith": "^0.0.0-canary.20261102.g8292c77"
+    }
+}

package/src/index.ts

@@ -0,0 +1,166 @@
+/**
+ * @zerolith/otel: spans through `@opentelemetry/api` for the three things
+ * worth tracing in a zerolith application: a navigation, a hydration, and
+ * a request of the typed client. The application supplies the tracer, so
+ * the SDK and the exporter stay its choice, and the API's no-op tracer
+ * makes every call free until one is configured.
+ */
+import { type Context, type Span, SpanKind, SpanStatusCode, type Tracer, context, trace } from "@opentelemetry/api";
+import { type HydrateResult, type MountTarget, hydrate } from "zerolith";
+import type { Transport } from "@zerolith/client";
+import type { NavigationEvent } from "@zerolith/router";
+
+/** The tracer used when none is given: the API's tracer for this package, a no-op until an SDK registers a provider. */
+function defaultTracer(): Tracer
+{
+    return trace.getTracer("@zerolith/otel");
+}
+
+/** The query keys whose values the URL conventions redact by default, such as a signed URL's signature. */
+const SENSITIVE_QUERY = new Set(["X-Amz-Signature", "X-Amz-Credential", "X-Amz-Security-Token", "sig", "X-Goog-Signature"]);
+
+/** A URL's query component without its `?`, with the value of each key the conventions redact replaced by `REDACTED`. */
+function redactedQuery(search: string): string
+{
+    return search.replace(/^\?/, "").split("&").map((pair) =>
+    {
+        const key = pair.split("=", 1)[0] ?? "";
+        return SENSITIVE_QUERY.has(key) ? `${key}=REDACTED` : pair;
+    }).join("&");
+}
+
+/**
+ * The `observe` function for `createRouter`: a span named `navigate`
+ * opens when a navigation starts and ends when it commits, fails, or is
+ * canceled by a newer navigation, with `zerolith.route`, `url.path`,
+ * `url.query` when the URL has a query, and `zerolith.navigation.mode` as
+ * attributes, the loader's error recorded on failure, and
+ * `zerolith.navigation.canceled` set on a canceled one, whose status stays
+ * unset. The values of the query keys the URL conventions redact, such as
+ * `sig`, are recorded as `REDACTED`.
+ */
+export function navigationObserver(tracer: Tracer = defaultTracer()): (event: NavigationEvent) => void
+{
+    const open = new Map<number, Span>();
+    return (event) =>
+    {
+        if (event.type === "start")
+        {
+            const query = redactedQuery(event.url.search);
+            const span = tracer.startSpan("navigate", {
+                kind: SpanKind.INTERNAL,
+                attributes: { "url.path": event.url.pathname, ...(query === "" ? {} : { "url.query": query }), "zerolith.navigation.mode": event.mode }
+            });
+            open.set(event.id, span);
+            return;
+        }
+        const span = open.get(event.id);
+        if (span === undefined)
+        {
+            return;
+        }
+        open.delete(event.id);
+        if (event.type === "commit")
+        {
+            span.setAttribute("zerolith.route", event.name ?? "");
+            span.setStatus({ code: SpanStatusCode.OK });
+        }
+        else if (event.type === "cancel")
+        {
+            span.setAttribute("zerolith.navigation.canceled", true);
+        }
+        else
+        {
+            const error = event.error;
+            span.recordException(error instanceof Error ? error : new Error(String(error)));
+            span.setStatus({ code: SpanStatusCode.ERROR, message: error instanceof Error ? error.message : String(error) });
+        }
+        span.end();
+    };
+}
+
+/** `hydrate` inside a span named `hydrate`, with the number of mismatches as `zerolith.hydration.mismatches`. */
+export function tracedHydrate(view: unknown, container: MountTarget, tracer: Tracer = defaultTracer()): HydrateResult
+{
+    return tracer.startActiveSpan("hydrate", (span) =>
+    {
+        try
+        {
+            const result = hydrate(view, container);
+            span.setAttribute("zerolith.hydration.mismatches", result.mismatches.length);
+            span.setStatus({ code: SpanStatusCode.OK });
+            return result;
+        }
+        catch (error)
+        {
+            span.recordException(error instanceof Error ? error : new Error(String(error)));
+            span.setStatus({ code: SpanStatusCode.ERROR });
+            throw error;
+        }
+        finally
+        {
+            span.end();
+        }
+    });
+}
+
+/** The W3C `traceparent` header for a context, or undefined when no span is active in it. */
+export function traceparent(active: Context = context.active()): string | undefined
+{
+    const span = trace.getSpanContext(active);
+    if (span === undefined || !trace.isSpanContextValid(span))
+    {
+        return undefined;
+    }
+    return `00-${span.traceId}-${span.spanId}-${span.traceFlags.toString(16).padStart(2, "0")}`;
+}
+
+/**
+ * Wraps a transport, or `fetch` when none is given, so every request runs
+ * in a client span named by its method, as `GET`, with
+ * `http.request.method`, `url.full`, and `http.response.status_code`,
+ * carries a `traceparent` header from that span, and records a failed
+ * request as an error. The span is not named by the request's path, which
+ * would give every note its own span name; the HTTP conventions name a
+ * client span by its method when no route template is known. `url.full`
+ * records the values of the query keys the conventions redact, such as
+ * `sig`, as `REDACTED`.
+ */
+export function tracedTransport(transport: Transport | undefined, tracer: Tracer = defaultTracer()): Transport
+{
+    const send: Transport = transport ?? ((request) => fetch(request));
+    return (request) =>
+    {
+        const full = new URL(request.url);
+        full.search = redactedQuery(full.search);
+        return tracer.startActiveSpan(request.method, { kind: SpanKind.CLIENT, attributes: { "http.request.method": request.method, "url.full": full.href } }, async (span) =>
+        {
+            try
+            {
+                const header = traceparent();
+                const traced = header === undefined ? request : new Request(request, { headers: withHeader(request.headers, "traceparent", header) });
+                const response = await send(traced);
+                span.setAttribute("http.response.status_code", response.status);
+                span.setStatus(response.ok ? { code: SpanStatusCode.OK } : { code: SpanStatusCode.ERROR, message: `HTTP ${response.status}` });
+                return response;
+            }
+            catch (error)
+            {
+                span.recordException(error instanceof Error ? error : new Error(String(error)));
+                span.setStatus({ code: SpanStatusCode.ERROR, message: error instanceof Error ? error.message : String(error) });
+                throw error;
+            }
+            finally
+            {
+                span.end();
+            }
+        });
+    };
+}
+
+function withHeader(headers: Headers, name: string, value: string): Headers
+{
+    const copy = new Headers(headers);
+    copy.set(name, value);
+    return copy;
+}