@moostjs/otel 0.4.7 → 0.4.9

package/dist/index.d.ts

@@ -4,15 +4,18 @@ import * as _prostojs_mate from '@prostojs/mate';
 import { TMateParamMeta } from '@prostojs/mate';
 import { TProvideRegistry, TReplaceRegistry } from '@prostojs/infact';
 import { BatchSpanProcessor, ReadableSpan, SimpleSpanProcessor } from '@opentelemetry/sdk-trace-base';
+import { IncomingMessage, ServerResponse } from 'http';
+import { ContextInjector, TContextInjectorHook } from 'moost';
 
 interface TOtelContext {
     otel?: {
         span?: Span;
+        route?: string;
     };
 }
 declare function useOtelContext(): {
     trace: _opentelemetry_api.TraceAPI;
-    withChildSpan: <T>(name: string, cb: (...a: any[]) => T, opts?: SpanOptions) => T | (() => T);
+    withChildSpan: <T>(name: string, cb: (...a: any[]) => T, opts?: SpanOptions) => () => T;
     getSpan: () => Span | undefined;
     getSpanContext: () => _opentelemetry_api.SpanContext | undefined;
     getPropagationHeaders: () => {
@@ -23,6 +26,7 @@ declare function useOtelContext(): {
         tracestate?: undefined;
     };
     registerSpan: (span: Span) => unknown;
+    pushSpan: (span: Span) => void;
 };
 declare function useTrace(): _opentelemetry_api.TraceAPI;
 declare function useSpan(): Span | undefined;
@@ -50,6 +54,10 @@ declare function enableOtelForMoost(): void;
  * 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;
 
 type TAny = any;
 type TAnyFn = (...a: TAny[]) => unknown;
@@ -167,6 +175,7 @@ interface TCommonMoostMeta {
 
 interface TOtelMate {
     otelIgnoreSpan: boolean;
+    otelIgnoreMeter: boolean;
 }
 declare function getOtelMate(): _prostojs_mate.Mate<TMoostMetadata<TEmpty> & TOtelMate & {
     params: (TOtelMate & _prostojs_mate.TMateParamMeta)[];
@@ -184,4 +193,40 @@ declare class MoostSimpleSpanProcessor extends SimpleSpanProcessor {
 
 declare function shouldSpanBeIgnored(span: ReadableSpan): boolean;
 
-export { MoostBatchSpanProcessor, MoostSimpleSpanProcessor, OtelIgnoreSpan, type TOtelContext, type TOtelMate, enableOtelForMoost, getOtelMate, shouldSpanBeIgnored, useOtelContext, useOtelPropagation, useSpan, useTrace };
+type TAttributes = Record<string, string | number | boolean>;
+declare class SpanInjector extends ContextInjector<TContextInjectorHook> {
+    with<T>(name: TContextInjectorHook, attributes: TAttributes, cb: () => T): T;
+    with<T>(name: TContextInjectorHook, cb: () => T): T;
+    patchRsponse(): void;
+    startEvent<T>(eventType: string, cb: () => T): T;
+    getEventType(): string;
+    getIgnoreSpan(): boolean | undefined;
+    getControllerHandlerMeta(): {
+        ignoreMeter: boolean | undefined;
+        ignoreSpan: boolean | undefined;
+        attrs: {
+            'moost.controller': string | undefined;
+            'moost.handler': string | undefined;
+            'moost.handler_description': string | undefined;
+            'moost.handler_label': string | undefined;
+            'moost.handler_id': string | undefined;
+            'moost.ignore': boolean | undefined;
+            'moost.route': string | undefined;
+            'moost.event_type': string;
+        };
+    };
+    hook(name: 'Handler:not_found' | 'Handler:routed' | 'C', route?: string): void;
+    withSpan<T>(span: Span, cb: () => T, opts: {
+        rootSpan: boolean;
+        endSpan: boolean;
+    }): T;
+    startEventMetrics(a: Record<string, string | number | boolean | undefined>, route?: string): void;
+    endEventMetrics(a: Record<string, string | number | boolean | undefined>, error?: Error): void;
+    getRequest(): IncomingMessage | undefined;
+    getResponse(): (ServerResponse<IncomingMessage> & {
+        _statusCode?: number | undefined;
+        _contentLength?: number | undefined;
+    }) | undefined;
+}
+
+export { MoostBatchSpanProcessor, MoostSimpleSpanProcessor, OtelIgnoreMeter, OtelIgnoreSpan, SpanInjector, type TOtelContext, type TOtelMate, enableOtelForMoost, getOtelMate, shouldSpanBeIgnored, useOtelContext, useOtelPropagation, useSpan, useTrace };