@cedvict/http-guardian-plugin-otel 0.0.1-next.10 → 0.0.1-next.8

package/README.md

@@ -1,76 +1,9 @@
 # @cedvict/http-guardian-plugin-otel
 
-OpenTelemetry plugin for http-guardian. Wraps each request in an active span,
-sets standard `http.*` attributes and propagates status into
-`SpanStatusCode.OK` / `ERROR`.
+OpenTelemetry plugin for http-guardian.
 
 ## Usage
 
 ```ts
 import { otelPlugin } from "@cedvict/http-guardian-plugin-otel";
-import { createHttpClient, createApiParserStructured, bearerAuth } from "@cedvict/http-guardian";
-
-const api = createHttpClient({
-  baseUrl: "https://api.example.com",
-  auth: bearerAuth(() => token),
-  parser: createApiParserStructured(),
-  plugins: [
-    otelPlugin({
-      tracerName: "my-app",
-      spanName: (ctx) => `HTTP ${ctx.method} ${new URL(ctx.url).pathname}`,
-      redactUrl: (u) => u,
-    }),
-  ],
-});
-```
-
-By default the plugin auto-detects `@opentelemetry/api` at runtime. You can
-also inject the API module explicitly via `otelPlugin({ api })`.
-
-## Linking to a backend trace
-
-When the response envelope carries a `traceId` / `spanId` (e.g. via
-[`createApiParserStructured`](../http-guardian)), you can stamp those on the
-client-side span so traces stitch together end-to-end.
-
-The plugin exposes `setAttributes(span, ctx, res, err)` for exactly this:
-
-```ts
-import { createApiParserStructured, type Guard } from "@cedvict/http-guardian";
-
-otelPlugin({
-  setAttributes: (span, ctx) => {
-    const traceId = ctx.meta?.traceId;
-    const spanId = ctx.meta?.spanId;
-    if (traceId) span.setAttribute("backend.trace_id", traceId);
-    if (spanId) span.setAttribute("backend.span_id", spanId);
-  },
-});
-```
-
-### Outbound `traceparent` header
-
-If your backend joins traces via the W3C `traceparent` header, inject it
-**before** the request leaves with a small guard. The current OTel context
-exposes the active span; format follows
-[trace-context spec](https://www.w3.org/TR/trace-context/):
-
-```ts
-import * as otel from "@opentelemetry/api";
-import type { Guard } from "@cedvict/http-guardian";
-
-const traceparentGuard: Guard = async (ctx, next) => {
-  const span = otel.trace.getActiveSpan();
-  const sc = span?.spanContext();
-  if (sc && sc.traceId && sc.spanId) {
-    const flags = (sc.traceFlags ?? 0).toString(16).padStart(2, "0");
-    ctx.headers.set("traceparent", `00-${sc.traceId}-${sc.spanId}-${flags}`);
-  }
-  return next(ctx);
-};
-
-createHttpClient({
-  guards: [traceparentGuard],   // runs before the otel guard's next()
-  plugins: [otelPlugin()],
-});
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cedvict/http-guardian-plugin-otel",
-  "version": "0.0.1-next.10",
+  "version": "0.0.1-next.8",
   "description": "OpenTelemetry plugin for http-guardian.",
   "type": "module",
   "exports": {
@@ -54,6 +54,6 @@
     "@typescript-eslint/eslint-plugin": "^8.0.0"
   },
   "dependencies": {
-    "@cedvict/http-guardian": "^0.0.1-next.10"
+    "@cedvict/http-guardian": "^0.0.1-next.8"
   }
 }