feat: add release please and opt-out of span exceptions

Signed-off-by: Lukas Reining <[email protected]>

Author: lukas-reining

libs/hooks/open-telemetry/src/lib/otel-hook.ts

@@ -32,6 +32,13 @@ export type OpenTelemetryHookOptions = {
    */
   excludeAttributes?: TelemetryAttributesNames[];
 
+  /**
+   * If true, unhandled error or promise rejection during flag resolution, or any attached hooks
+   * will not be recorded on the active span.
+   * By default, exceptions are recorded on the active span, if there is one.
+   */
+  excludeExceptionsFromTrace?: boolean;
+
   /**
    * Takes a telemetry event and returns a telemetry event.
    * This can be used to filter out attributes that are not needed or to add additional attributes.
@@ -47,6 +54,7 @@ export abstract class OpenTelemetryHook {
   protected abstract name: string;
 
   protected attributesToExclude: TelemetryAttributesNames[];
+  protected excludeExceptionsFromTrace: boolean;
   protected safeAttributeMapper: AttributeMapper;
   protected safeEventMutator: EventMutator;
 
@@ -68,6 +76,7 @@ export abstract class OpenTelemetryHook {
       }
     };
     this.attributesToExclude = options?.excludeAttributes ?? [];
+    this.excludeExceptionsFromTrace = options?.excludeExceptionsFromTrace ?? false;
   }
 
   protected toEvaluationEvent(

libs/hooks/open-telemetry/src/lib/traces/tracing-hook.ts

@@ -12,20 +12,24 @@ import { OpenTelemetryHook } from '../otel-hook';
  * OpenTelemetry events.
  */
 export class EventHook extends OpenTelemetryHook implements BaseHook {
-  protected name = LogEventTracingHook.name;
+  protected name = EventHook.name;
   private eventLogger: EventLogger;
 
   constructor(options?: OpenTelemetryHookOptions, logger?: Logger) {
     super(options, logger);
-    this.eventLogger = events.getEventLogger('@openfeature/open-telemetry-hooks', "0.4.0"); // Update version with Release Please
+    // x-release-please-start-version
+    this.eventLogger = events.getEventLogger('@openfeature/open-telemetry-hooks', '0.4.0');
+    // x-release-please-end
   }
 
   finally(hookContext: Readonly<HookContext>, evaluationDetails: EvaluationDetails<FlagValue>) {
     this.eventLogger.emit(this.toEvaluationEvent(hookContext, evaluationDetails));
   }
 
   error(_: HookContext, err: Error) {
-    trace.getActiveSpan()?.recordException(err);
+    if (!this.excludeExceptionsFromTrace) {
+      trace.getActiveSpan()?.recordException(err);
+    }
   }
 }
 
@@ -36,7 +40,7 @@ export class EventHook extends OpenTelemetryHook implements BaseHook {
  * Span events are being deprecated in favor of using log events.
  */
 export class SpanEventHook extends OpenTelemetryHook implements BaseHook {
-  protected name = SpanEventTracingHook.name;
+  protected name = SpanEventHook.name;
 
   constructor(options?: OpenTelemetryHookOptions, logger?: Logger) {
     super(options, logger);
@@ -54,13 +58,18 @@ export class SpanEventHook extends OpenTelemetryHook implements BaseHook {
   }
 
   error(_: HookContext, err: Error) {
-    trace.getActiveSpan()?.recordException(err);
+    if (!this.excludeExceptionsFromTrace) {
+      trace.getActiveSpan()?.recordException(err);
+    }
   }
 }
 
-const tracer = trace.getTracer('span-attributes-tracing-hook');
+// x-release-please-start-version
+const tracer = trace.getTracer('@openfeature/open-telemetry-hooks', '0.4.0');
+// x-release-please-end
+
 const HookContextSpanKey = Symbol('evaluation_span');
-type SpanAttributesTracingHookData = { [HookContestSpanKey]: Span };
+type SpanAttributesTracingHookData = { [HookContextSpanKey]: Span };
 
 /**
  * A hook that creates a new span for each flag evaluation and sets the evaluation
@@ -69,22 +78,22 @@ type SpanAttributesTracingHookData = { [HookContestSpanKey]: Span };
  * If there is no active span, a new root span is created.
  */
 export class SpanHook extends OpenTelemetryHook implements BaseHook {
-  protected name = SpanAttributesTracingHook.name;
+  protected name = SpanHook.name;
 
   constructor(options?: OpenTelemetryHookOptions, logger?: Logger) {
     super(options, logger);
   }
 
   before(hookContext: HookContext<FlagValue, SpanAttributesTracingHookData>) {
     const evaluationSpan = tracer.startSpan('feature_flag.evaluation');
-    hookContext.hookData.set(HookContestSpanKey, evaluationSpan);
+    hookContext.hookData.set(HookContextSpanKey, evaluationSpan);
   }
 
   finally(
     hookContext: Readonly<HookContext<FlagValue, SpanAttributesTracingHookData>>,
     evaluationDetails: EvaluationDetails<FlagValue>,
   ) {
-    const currentSpan = hookContext.hookData.get(HookContestSpanKey);
+    const currentSpan = hookContext.hookData.get(HookContextSpanKey);
     if (!currentSpan) {
       return;
     }
@@ -95,7 +104,10 @@ export class SpanHook extends OpenTelemetryHook implements BaseHook {
     currentSpan.end();
   }
 
-  error(_: HookContext, err: Error) {
-    trace.getActiveSpan()?.recordException(err);
+  error(hookContext: Readonly<HookContext<FlagValue, SpanAttributesTracingHookData>>, err: Error) {
+    if (!this.excludeExceptionsFromTrace) {
+      const currentSpan = hookContext.hookData.get(HookContextSpanKey) ?? trace.getActiveSpan();
+      currentSpan?.recordException(err);
+    }
   }
 }