@moostjs/otel 0.5.29 → 0.5.30

package/dist/index.cjs

@@ -1,4 +1,3 @@
-"use strict";
 //#region rolldown:runtime
 var __create = Object.create;
 var __defProp = Object.defineProperty;
@@ -112,9 +111,20 @@ function getMoostMetrics() {
 
 //#endregion
 //#region packages/otel/src/utils.ts
-function withSpan(span, cb, postProcess) {
+/**
+* Starts or continues a span, executes the callback within the span's context,
+* and handles span completion and error recording. Supports both synchronous and asynchronous callbacks.
+* An optional post-processing callback can be used to enrich the span before it ends.
+*
+* @template T
+* @param {TSpanInput | Span} span - The span input containing name and options, or an existing span.
+* @param {() => T} cb - The callback function to execute within the span's context.
+* @param {TPostSpanProcessFn<T>=} postProcess - An optional post-processing callback to enrich the span before it ends. **CAUTION: When used, you must end the span yourself `span.end()`.**
+* @returns {T} The result of the callback function.
+* @throws {Error} Will throw an error if the callback function throws.
+*/ function withSpan(span, cb, postProcess) {
 	const _span = typeof span.name === "string" && !span.spanContext ? __opentelemetry_api.trace.getTracer("default").startSpan(span.name, span.options) : span;
-	let result = undefined;
+	let result = void 0;
 	const finalizeSpan = (e, r) => {
 		if (e) {
 			_span.recordException(e);
@@ -130,16 +140,16 @@ function withSpan(span, cb, postProcess) {
 		try {
 			result = cb();
 		} catch (error) {
-			finalizeSpan(error, undefined);
+			finalizeSpan(error, void 0);
 			throw error;
 		}
 		if (result instanceof Promise) result.then((r) => {
-			finalizeSpan(undefined, r);
+			finalizeSpan(void 0, r);
 			return r;
 		}).catch((error) => {
-			finalizeSpan(error, undefined);
+			finalizeSpan(error, void 0);
 		});
-		else finalizeSpan(undefined, result);
+		else finalizeSpan(void 0, result);
 	});
 	return result;
 }
@@ -160,7 +170,7 @@ const tracer = __opentelemetry_api.trace.getTracer("moost-tracer");
 var SpanInjector = class extends moost.ContextInjector {
 	with(name, attributes, cb) {
 		const fn = typeof attributes === "function" ? attributes : cb;
-		const attrs = typeof attributes === "object" ? attributes : undefined;
+		const attrs = typeof attributes === "object" ? attributes : void 0;
 		if (name === "Event:start" && attrs?.eventType) return this.startEvent(attrs.eventType, fn);
 		else if (name !== "Event:start") if (this.getIgnoreSpan()) return fn();
 		else {
@@ -181,7 +191,7 @@ var SpanInjector = class extends moost.ContextInjector {
 			const originalWriteHead = res.writeHead;
 			Object.assign(res, { writeHead: (arg0, arg1, arg2) => {
 				res._statusCode = arg0;
-				const headers = typeof arg2 === "object" ? arg2 : typeof arg1 === "object" ? arg1 : undefined;
+				const headers = typeof arg2 === "object" ? arg2 : typeof arg1 === "object" ? arg1 : void 0;
 				res._contentLength = headers?.["content-length"] ? Number(headers["content-length"]) : 0;
 				return originalWriteHead.apply(res, [
 					arg0,
@@ -219,13 +229,13 @@ var SpanInjector = class extends moost.ContextInjector {
 		const { getMethod, getMethodMeta, getController, getControllerMeta, getRoute } = (0, moost.useControllerContext)();
 		const methodName = getMethod();
 		const controller = getController();
-		const cMeta = controller ? getControllerMeta() : undefined;
-		const mMeta = controller ? getMethodMeta() : undefined;
+		const cMeta = controller ? getControllerMeta() : void 0;
+		const mMeta = controller ? getMethodMeta() : void 0;
 		return {
 			ignoreMeter: cMeta?.otelIgnoreMeter || mMeta?.otelIgnoreMeter,
 			ignoreSpan: cMeta?.otelIgnoreSpan || mMeta?.otelIgnoreSpan,
 			attrs: {
-				"moost.controller": controller ? (0, moost.getConstructor)(controller).name : undefined,
+				"moost.controller": controller ? (0, moost.getConstructor)(controller).name : void 0,
 				"moost.handler": methodName,
 				"moost.handler_description": mMeta?.description,
 				"moost.handler_label": mMeta?.label,
@@ -325,8 +335,15 @@ function getOtelMate() {
 //#endregion
 //#region packages/otel/src/otel.decorators.ts
 const mate = getOtelMate();
-const OtelIgnoreSpan = () => mate.decorate("otelIgnoreSpan", true);
-const OtelIgnoreMeter = () => mate.decorate("otelIgnoreMeter", true);
+/**
+* Annotate controller and/or handler to filter
+* out the corresponding spans from transporting
+*
+* Requires use of MoostBatchSpanProcessor or MoostSimpleSpanProcessor
+*/ const OtelIgnoreSpan = () => mate.decorate("otelIgnoreSpan", true);
+/**
+* Annotate controller and/or handler to suppress metrics
+*/ const OtelIgnoreMeter = () => mate.decorate("otelIgnoreMeter", true);
 
 //#endregion
 //#region packages/otel/src/processors/span-filter.ts
@@ -353,16 +370,16 @@ var MoostSimpleSpanProcessor = class extends __opentelemetry_sdk_trace_base.Simp
 };
 
 //#endregion
-exports.MoostBatchSpanProcessor = MoostBatchSpanProcessor
-exports.MoostSimpleSpanProcessor = MoostSimpleSpanProcessor
-exports.OtelIgnoreMeter = OtelIgnoreMeter
-exports.OtelIgnoreSpan = OtelIgnoreSpan
-exports.SpanInjector = SpanInjector
-exports.enableOtelForMoost = enableOtelForMoost
-exports.getOtelMate = getOtelMate
-exports.shouldSpanBeIgnored = shouldSpanBeIgnored
-exports.useOtelContext = useOtelContext
-exports.useOtelPropagation = useOtelPropagation
-exports.useSpan = useSpan
-exports.useTrace = useTrace
-exports.withSpan = withSpan
+exports.MoostBatchSpanProcessor = MoostBatchSpanProcessor;
+exports.MoostSimpleSpanProcessor = MoostSimpleSpanProcessor;
+exports.OtelIgnoreMeter = OtelIgnoreMeter;
+exports.OtelIgnoreSpan = OtelIgnoreSpan;
+exports.SpanInjector = SpanInjector;
+exports.enableOtelForMoost = enableOtelForMoost;
+exports.getOtelMate = getOtelMate;
+exports.shouldSpanBeIgnored = shouldSpanBeIgnored;
+exports.useOtelContext = useOtelContext;
+exports.useOtelPropagation = useOtelPropagation;
+exports.useSpan = useSpan;
+exports.useTrace = useTrace;
+exports.withSpan = withSpan;

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import * as _opentelemetry_api from '@opentelemetry/api';
 import { Span, SpanOptions } from '@opentelemetry/api';
 import { Mate, TMoostMetadata, TMateParamMeta, ContextInjector, TContextInjectorHook } from 'moost';
@@ -43,14 +42,23 @@ declare function useOtelPropagation(): {
     };
     traceId?: string | undefined;
     spanId?: string | undefined;
-    isRemote?: boolean | undefined;
+    isRemote?: boolean;
     traceFlags?: number | undefined;
-    traceState?: _opentelemetry_api.TraceState | undefined;
+    traceState?: _opentelemetry_api.TraceState;
 };
 
 declare function enableOtelForMoost(): void;
 
+/**
+ * Annotate controller and/or handler to filter
+ * out the corresponding spans from transporting
+ *
+ * Requires use of MoostBatchSpanProcessor or MoostSimpleSpanProcessor
+ */
 declare const OtelIgnoreSpan: () => MethodDecorator & ClassDecorator & ParameterDecorator & PropertyDecorator;
+/**
+ * Annotate controller and/or handler to suppress metrics
+ */
 declare const OtelIgnoreMeter: () => MethodDecorator & ClassDecorator & ParameterDecorator & PropertyDecorator;
 
 interface TOtelMate {
@@ -76,7 +84,7 @@ declare function shouldSpanBeIgnored(span: ReadableSpan): boolean;
 type TAttributes = Record<string, string | number | boolean>;
 declare class SpanInjector extends ContextInjector<TContextInjectorHook> {
     metrics: {
-        moostEventDuration: _opentelemetry_api.Histogram<_opentelemetry_api.Attributes>;
+        moostEventDuration: _opentelemetry_api.Histogram;
     };
     with<T>(name: TContextInjectorHook, attributes: TAttributes, cb: () => T): T;
     with<T>(name: TContextInjectorHook, cb: () => T): T;
@@ -107,8 +115,8 @@ declare class SpanInjector extends ContextInjector<TContextInjectorHook> {
     endEventMetrics(a: Record<string, string | number | boolean | undefined>, error?: Error): void;
     getRequest(): IncomingMessage | undefined;
     getResponse(): (ServerResponse<IncomingMessage> & {
-        _statusCode?: number | undefined;
-        _contentLength?: number | undefined;
+        _statusCode?: number;
+        _contentLength?: number;
     }) | undefined;
 }
 
@@ -117,6 +125,19 @@ interface TSpanInput {
     name: string;
     options?: SpanOptions;
 }
+/**
+ * Starts or continues a span, executes the callback within the span's context,
+ * and handles span completion and error recording. Supports both synchronous and asynchronous callbacks.
+ * An optional post-processing callback can be used to enrich the span before it ends.
+ *
+ * @template T
+ * @param {TSpanInput | Span} span - The span input containing name and options, or an existing span.
+ * @param {() => T} cb - The callback function to execute within the span's context.
+ * @param {TPostSpanProcessFn<T>=} postProcess - An optional post-processing callback to enrich the span before it ends. **CAUTION: When used, you must end the span yourself `span.end()`.**
+ * @returns {T} The result of the callback function.
+ * @throws {Error} Will throw an error if the callback function throws.
+ */
 declare function withSpan<T>(span: TSpanInput | Span, cb: () => T, postProcess?: TPostSpanProcessFn<T>): T;
 
-export { MoostBatchSpanProcessor, MoostSimpleSpanProcessor, OtelIgnoreMeter, OtelIgnoreSpan, SpanInjector, type TOtelContext, type TOtelMate, type TPostSpanProcessFn, type TSpanInput, enableOtelForMoost, getOtelMate, shouldSpanBeIgnored, useOtelContext, useOtelPropagation, useSpan, useTrace, withSpan };
+export { MoostBatchSpanProcessor, MoostSimpleSpanProcessor, OtelIgnoreMeter, OtelIgnoreSpan, SpanInjector, enableOtelForMoost, getOtelMate, shouldSpanBeIgnored, useOtelContext, useOtelPropagation, useSpan, useTrace, withSpan };
+export type { TOtelContext, TOtelMate, TPostSpanProcessFn, TSpanInput };

package/dist/index.mjs

@@ -88,9 +88,20 @@ function getMoostMetrics() {
 
 //#endregion
 //#region packages/otel/src/utils.ts
-function withSpan(span, cb, postProcess) {
+/**
+* Starts or continues a span, executes the callback within the span's context,
+* and handles span completion and error recording. Supports both synchronous and asynchronous callbacks.
+* An optional post-processing callback can be used to enrich the span before it ends.
+*
+* @template T
+* @param {TSpanInput | Span} span - The span input containing name and options, or an existing span.
+* @param {() => T} cb - The callback function to execute within the span's context.
+* @param {TPostSpanProcessFn<T>=} postProcess - An optional post-processing callback to enrich the span before it ends. **CAUTION: When used, you must end the span yourself `span.end()`.**
+* @returns {T} The result of the callback function.
+* @throws {Error} Will throw an error if the callback function throws.
+*/ function withSpan(span, cb, postProcess) {
 	const _span = typeof span.name === "string" && !span.spanContext ? trace.getTracer("default").startSpan(span.name, span.options) : span;
-	let result = undefined;
+	let result = void 0;
 	const finalizeSpan = (e, r) => {
 		if (e) {
 			_span.recordException(e);
@@ -106,16 +117,16 @@ function withSpan(span, cb, postProcess) {
 		try {
 			result = cb();
 		} catch (error) {
-			finalizeSpan(error, undefined);
+			finalizeSpan(error, void 0);
 			throw error;
 		}
 		if (result instanceof Promise) result.then((r) => {
-			finalizeSpan(undefined, r);
+			finalizeSpan(void 0, r);
 			return r;
 		}).catch((error) => {
-			finalizeSpan(error, undefined);
+			finalizeSpan(error, void 0);
 		});
-		else finalizeSpan(undefined, result);
+		else finalizeSpan(void 0, result);
 	});
 	return result;
 }
@@ -136,7 +147,7 @@ const tracer = trace.getTracer("moost-tracer");
 var SpanInjector = class extends ContextInjector {
 	with(name, attributes, cb) {
 		const fn = typeof attributes === "function" ? attributes : cb;
-		const attrs = typeof attributes === "object" ? attributes : undefined;
+		const attrs = typeof attributes === "object" ? attributes : void 0;
 		if (name === "Event:start" && attrs?.eventType) return this.startEvent(attrs.eventType, fn);
 		else if (name !== "Event:start") if (this.getIgnoreSpan()) return fn();
 		else {
@@ -157,7 +168,7 @@ var SpanInjector = class extends ContextInjector {
 			const originalWriteHead = res.writeHead;
 			Object.assign(res, { writeHead: (arg0, arg1, arg2) => {
 				res._statusCode = arg0;
-				const headers = typeof arg2 === "object" ? arg2 : typeof arg1 === "object" ? arg1 : undefined;
+				const headers = typeof arg2 === "object" ? arg2 : typeof arg1 === "object" ? arg1 : void 0;
 				res._contentLength = headers?.["content-length"] ? Number(headers["content-length"]) : 0;
 				return originalWriteHead.apply(res, [
 					arg0,
@@ -195,13 +206,13 @@ var SpanInjector = class extends ContextInjector {
 		const { getMethod, getMethodMeta, getController, getControllerMeta, getRoute } = useControllerContext();
 		const methodName = getMethod();
 		const controller = getController();
-		const cMeta = controller ? getControllerMeta() : undefined;
-		const mMeta = controller ? getMethodMeta() : undefined;
+		const cMeta = controller ? getControllerMeta() : void 0;
+		const mMeta = controller ? getMethodMeta() : void 0;
 		return {
 			ignoreMeter: cMeta?.otelIgnoreMeter || mMeta?.otelIgnoreMeter,
 			ignoreSpan: cMeta?.otelIgnoreSpan || mMeta?.otelIgnoreSpan,
 			attrs: {
-				"moost.controller": controller ? getConstructor(controller).name : undefined,
+				"moost.controller": controller ? getConstructor(controller).name : void 0,
 				"moost.handler": methodName,
 				"moost.handler_description": mMeta?.description,
 				"moost.handler_label": mMeta?.label,
@@ -301,8 +312,15 @@ function getOtelMate() {
 //#endregion
 //#region packages/otel/src/otel.decorators.ts
 const mate = getOtelMate();
-const OtelIgnoreSpan = () => mate.decorate("otelIgnoreSpan", true);
-const OtelIgnoreMeter = () => mate.decorate("otelIgnoreMeter", true);
+/**
+* Annotate controller and/or handler to filter
+* out the corresponding spans from transporting
+*
+* Requires use of MoostBatchSpanProcessor or MoostSimpleSpanProcessor
+*/ const OtelIgnoreSpan = () => mate.decorate("otelIgnoreSpan", true);
+/**
+* Annotate controller and/or handler to suppress metrics
+*/ const OtelIgnoreMeter = () => mate.decorate("otelIgnoreMeter", true);
 
 //#endregion
 //#region packages/otel/src/processors/span-filter.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moostjs/otel",
-  "version": "0.5.29",
+  "version": "0.5.30",
   "description": "@moostjs/otel",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
@@ -36,13 +36,15 @@
     "url": "https://github.com/moostjs/moostjs/issues"
   },
   "homepage": "https://github.com/moostjs/moostjs/tree/main/packages/otel#readme",
+  "peerDependencies": {
+    "moost": "^0.5.30"
+  },
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
-    "@opentelemetry/sdk-trace-base": "^1.25.1",
-    "moost": "^0.5.29"
+    "@opentelemetry/sdk-trace-base": "^2.0.1"
   },
   "devDependencies": {
-    "vitest": "^3.0.5"
+    "vitest": "3.2.4"
   },
   "scripts": {
     "pub": "pnpm publish --access public",