@moostjs/otel 0.4.14 → 0.4.16

package/dist/index.cjs

@@ -117,6 +117,49 @@ function getMoostMetrics() {
     return moostMetrics;
 }
 
+function withSpan(span, cb, postProcess) {
+    const _span = typeof span.name === 'string' && !span.spanContext
+        ? span
+        : api.trace
+            .getTracer('default')
+            .startSpan(span.name, span.options);
+    let result = undefined;
+    const finalizeSpan = (e, r) => {
+        if (e) {
+            _span.recordException(e);
+        }
+        if (postProcess) {
+            postProcess(_span, e, r);
+        }
+        else {
+            _span.end();
+        }
+    };
+    api.context.with(api.trace.setSpan(api.context.active(), _span), () => {
+        try {
+            result = cb();
+        }
+        catch (error) {
+            finalizeSpan(error, undefined);
+            throw error;
+        }
+        if (result instanceof Promise) {
+            result
+                .then(r => {
+                finalizeSpan(undefined, r);
+                return r;
+            })
+                .catch(error => {
+                finalizeSpan(error, undefined);
+            });
+        }
+        else {
+            finalizeSpan(undefined, result);
+        }
+    });
+    return result;
+}
+
 const tracer = api.trace.getTracer('moost-tracer');
 class SpanInjector extends moost.ContextInjector {
     constructor() {
@@ -135,10 +178,11 @@ class SpanInjector extends moost.ContextInjector {
             }
             else {
                 const span = tracer.startSpan(name, {
+                    kind: api.SpanKind.INTERNAL,
                     attributes: attrs,
                 });
                 return this.withSpan(span, fn, {
-                    rootSpan: false,
+                    withMetrics: false,
                     endSpan: true,
                 });
             }
@@ -174,7 +218,7 @@ class SpanInjector extends moost.ContextInjector {
         if (span) {
             registerSpan(span);
             return this.withSpan(span, cb, {
-                rootSpan: true,
+                withMetrics: true,
                 endSpan: eventType !== 'HTTP',
             });
         }
@@ -217,8 +261,17 @@ class SpanInjector extends moost.ContextInjector {
         if (method === '__SYSTEM__') {
             return;
         }
+        const { getSpan } = useOtelContext();
         if (name === 'Handler:not_found') {
             const chm = this.getControllerHandlerMeta();
+            const span = getSpan();
+            if (span) {
+                const eventType = this.getEventType();
+                if (eventType === 'HTTP') {
+                    const req = this.getRequest();
+                    span.updateName(`${req?.method || ''} ${req?.url}`);
+                }
+            }
             this.startEventMetrics(chm.attrs, route);
         }
         else if (name === 'Controller:registered') {
@@ -227,7 +280,6 @@ class SpanInjector extends moost.ContextInjector {
             if (!chm.ignoreMeter) {
                 this.startEventMetrics(chm.attrs, _route);
             }
-            const { getSpan } = useOtelContext();
             const span = getSpan();
             if (span) {
                 span.setAttributes(chm.attrs);
@@ -244,48 +296,20 @@ class SpanInjector extends moost.ContextInjector {
         }
     }
     withSpan(span, cb, opts) {
-        let result;
-        let exception;
-        const endSpan = (error) => {
-            if (error) {
-                span.recordException(error);
+        return withSpan(span, cb, (_span, exception, result) => {
+            if (result instanceof Error) {
+                _span.recordException(result);
             }
-            if (opts.rootSpan) {
+            if (opts.withMetrics) {
                 const chm = this.getControllerHandlerMeta();
                 if (!chm.ignoreMeter) {
-                    this.endEventMetrics(chm.attrs, error);
+                    this.endEventMetrics(chm.attrs, result instanceof Error ? result : exception);
                 }
             }
             if (opts.endSpan) {
-                span.end();
-            }
-        };
-        api.context.with(api.trace.setSpan(api.context.active(), span), () => {
-            try {
-                result = cb();
-            }
-            catch (error) {
-                exception = error;
-                endSpan(exception);
+                _span.end();
             }
         });
-        const ret = result;
-        if (!exception) {
-            if (ret && ret instanceof Promise) {
-                ret
-                    .then(r => {
-                    endSpan(r instanceof Error ? r : undefined);
-                    return r;
-                })
-                    .catch(error => {
-                    endSpan(error);
-                });
-            }
-            else {
-                endSpan(ret instanceof Error ? ret : undefined);
-            }
-        }
-        return ret;
     }
     startEventMetrics(a, route) {
         if (a['moost.event_type'] === 'HTTP') {
@@ -1212,3 +1236,4 @@ exports.useOtelContext = useOtelContext;
 exports.useOtelPropagation = useOtelPropagation;
 exports.useSpan = useSpan;
 exports.useTrace = useTrace;
+exports.withSpan = withSpan;

package/dist/index.d.ts

@@ -230,7 +230,7 @@ declare class SpanInjector extends ContextInjector<TContextInjectorHook> {
     };
     hook(method: string, name: 'Handler:not_found' | 'Handler:routed' | 'Controller:registered', route?: string): void;
     withSpan<T>(span: Span, cb: () => T, opts: {
-        rootSpan: boolean;
+        withMetrics: boolean;
         endSpan: boolean;
     }): T;
     startEventMetrics(a: Record<string, string | number | boolean | undefined>, route?: string): void;
@@ -242,4 +242,23 @@ declare class SpanInjector extends ContextInjector<TContextInjectorHook> {
     }) | undefined;
 }
 
-export { MoostBatchSpanProcessor, MoostSimpleSpanProcessor, OtelIgnoreMeter, OtelIgnoreSpan, SpanInjector, type TOtelContext, type TOtelMate, enableOtelForMoost, getOtelMate, shouldSpanBeIgnored, useOtelContext, useOtelPropagation, useSpan, useTrace };
+type TPostSpanProcessFn<T> = (span: Span, exception: Error | undefined, result: Awaited<T> | undefined) => void;
+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 };

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { trace, context, metrics } from '@opentelemetry/api';
+import { trace, context, metrics, SpanKind } from '@opentelemetry/api';
 import { useAsyncEventContext as useAsyncEventContext$1, ContextInjector, useControllerContext, getConstructor as getConstructor$2, replaceContextInjector } from 'moost';
 import { randomUUID } from 'crypto';
 import { AsyncLocalStorage } from 'node:async_hooks';
@@ -115,6 +115,49 @@ function getMoostMetrics() {
     return moostMetrics;
 }
 
+function withSpan(span, cb, postProcess) {
+    const _span = typeof span.name === 'string' && !span.spanContext
+        ? span
+        : trace
+            .getTracer('default')
+            .startSpan(span.name, span.options);
+    let result = undefined;
+    const finalizeSpan = (e, r) => {
+        if (e) {
+            _span.recordException(e);
+        }
+        if (postProcess) {
+            postProcess(_span, e, r);
+        }
+        else {
+            _span.end();
+        }
+    };
+    context.with(trace.setSpan(context.active(), _span), () => {
+        try {
+            result = cb();
+        }
+        catch (error) {
+            finalizeSpan(error, undefined);
+            throw error;
+        }
+        if (result instanceof Promise) {
+            result
+                .then(r => {
+                finalizeSpan(undefined, r);
+                return r;
+            })
+                .catch(error => {
+                finalizeSpan(error, undefined);
+            });
+        }
+        else {
+            finalizeSpan(undefined, result);
+        }
+    });
+    return result;
+}
+
 const tracer = trace.getTracer('moost-tracer');
 class SpanInjector extends ContextInjector {
     constructor() {
@@ -133,10 +176,11 @@ class SpanInjector extends ContextInjector {
             }
             else {
                 const span = tracer.startSpan(name, {
+                    kind: SpanKind.INTERNAL,
                     attributes: attrs,
                 });
                 return this.withSpan(span, fn, {
-                    rootSpan: false,
+                    withMetrics: false,
                     endSpan: true,
                 });
             }
@@ -172,7 +216,7 @@ class SpanInjector extends ContextInjector {
         if (span) {
             registerSpan(span);
             return this.withSpan(span, cb, {
-                rootSpan: true,
+                withMetrics: true,
                 endSpan: eventType !== 'HTTP',
             });
         }
@@ -215,8 +259,17 @@ class SpanInjector extends ContextInjector {
         if (method === '__SYSTEM__') {
             return;
         }
+        const { getSpan } = useOtelContext();
         if (name === 'Handler:not_found') {
             const chm = this.getControllerHandlerMeta();
+            const span = getSpan();
+            if (span) {
+                const eventType = this.getEventType();
+                if (eventType === 'HTTP') {
+                    const req = this.getRequest();
+                    span.updateName(`${req?.method || ''} ${req?.url}`);
+                }
+            }
             this.startEventMetrics(chm.attrs, route);
         }
         else if (name === 'Controller:registered') {
@@ -225,7 +278,6 @@ class SpanInjector extends ContextInjector {
             if (!chm.ignoreMeter) {
                 this.startEventMetrics(chm.attrs, _route);
             }
-            const { getSpan } = useOtelContext();
             const span = getSpan();
             if (span) {
                 span.setAttributes(chm.attrs);
@@ -242,48 +294,20 @@ class SpanInjector extends ContextInjector {
         }
     }
     withSpan(span, cb, opts) {
-        let result;
-        let exception;
-        const endSpan = (error) => {
-            if (error) {
-                span.recordException(error);
+        return withSpan(span, cb, (_span, exception, result) => {
+            if (result instanceof Error) {
+                _span.recordException(result);
             }
-            if (opts.rootSpan) {
+            if (opts.withMetrics) {
                 const chm = this.getControllerHandlerMeta();
                 if (!chm.ignoreMeter) {
-                    this.endEventMetrics(chm.attrs, error);
+                    this.endEventMetrics(chm.attrs, result instanceof Error ? result : exception);
                 }
             }
             if (opts.endSpan) {
-                span.end();
-            }
-        };
-        context.with(trace.setSpan(context.active(), span), () => {
-            try {
-                result = cb();
-            }
-            catch (error) {
-                exception = error;
-                endSpan(exception);
+                _span.end();
             }
         });
-        const ret = result;
-        if (!exception) {
-            if (ret && ret instanceof Promise) {
-                ret
-                    .then(r => {
-                    endSpan(r instanceof Error ? r : undefined);
-                    return r;
-                })
-                    .catch(error => {
-                    endSpan(error);
-                });
-            }
-            else {
-                endSpan(ret instanceof Error ? ret : undefined);
-            }
-        }
-        return ret;
     }
     startEventMetrics(a, route) {
         if (a['moost.event_type'] === 'HTTP') {
@@ -1198,4 +1222,4 @@ class MoostSimpleSpanProcessor extends SimpleSpanProcessor {
     }
 }
 
-export { MoostBatchSpanProcessor, MoostSimpleSpanProcessor, OtelIgnoreMeter, OtelIgnoreSpan, SpanInjector, enableOtelForMoost, getOtelMate, shouldSpanBeIgnored, useOtelContext, useOtelPropagation, useSpan, useTrace };
+export { MoostBatchSpanProcessor, MoostSimpleSpanProcessor, OtelIgnoreMeter, OtelIgnoreSpan, SpanInjector, enableOtelForMoost, getOtelMate, shouldSpanBeIgnored, useOtelContext, useOtelPropagation, useSpan, useTrace, withSpan };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moostjs/otel",
-  "version": "0.4.14",
+  "version": "0.4.16",
   "description": "@moostjs/otel",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
@@ -39,6 +39,6 @@
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/sdk-trace-base": "^1.25.1",
-    "moost": "0.4.14"
+    "moost": "0.4.16"
   }
 }