style: revisit recordException method (#156)

* style: move tracer, span and attributes to hint arg

* fix: one more

* one more

* docs: add changeset

* fix: move spread operator to try-catch block

Author: wrn14897

.changeset/early-toes-try.md

@@ -0,0 +1,8 @@
+---
+'@hyperdx/instrumentation-exception': patch
+'@hyperdx/otel-web': patch
+'@hyperdx/browser': patch
+'@hyperdx/node-opentelemetry': patch
+---
+
+style: move 'tracer', 'span', 'attributes' args to hint (recordException method)

packages/instrumentation-exception/src/browser/index.ts

@@ -78,18 +78,23 @@ export const buildEventFromException = async (
 
 export const recordException = async (
   e: any,
-  hint?: EventHint,
-  tracer?: Tracer,
-  span?: Span,
-  attributes?: Attributes,
+  hint?: EventHint & {
+    tracer?: Tracer;
+    span?: Span;
+    attributes?: Attributes;
+  },
 ) => {
-  const _hint = hint ?? {
-    mechanism: {
-      type: 'generic',
-      handled: true,
-    },
-  };
   try {
+    const { tracer, span, attributes, ...eventHint } = hint ?? {};
+    const _hint =
+      Object.keys(eventHint).length > 0
+        ? eventHint
+        : {
+            mechanism: {
+              type: 'generic',
+              handled: true,
+            },
+          };
     const _eventProcessor = getEventProcessor(tracer ?? defaultTracer);
     const event = await buildEventFromException(e, {
       data: _hint,

packages/instrumentation-exception/src/browser/instrumentations/HyperDXErrorInstrumentation.ts

@@ -114,7 +114,10 @@ export class HyperDXErrorInstrumentation extends InstrumentationBase {
     );
     span.setAttribute('error.message', limitLen(msg, MESSAGE_LIMIT));
     addStackIfUseful(span, err);
-    recordException(err, {}, this.tracer, span).finally(() => {
+    recordException(err, {
+      tracer: this.tracer,
+      span,
+    }).finally(() => {
       span.end(now);
     });
   }
@@ -137,7 +140,10 @@ export class HyperDXErrorInstrumentation extends InstrumentationBase {
     if (firstError) {
       addStackIfUseful(span, firstError);
       // FIXME: record only the first error?
-      recordException(firstError, {}, this.tracer, span).finally(() => {
+      recordException(firstError, {
+        tracer: this.tracer,
+        span,
+      }).finally(() => {
         span.end(now);
       });
     } else {
@@ -169,7 +175,10 @@ export class HyperDXErrorInstrumentation extends InstrumentationBase {
       span.setAttribute('target_xpath', getElementXPath(ev.target, true));
       span.setAttribute('target_src', (ev.target as any).src);
     }
-    recordException(ev, {}, this.tracer, span).finally(() => {
+    recordException(ev, {
+      tracer: this.tracer,
+      span,
+    }).finally(() => {
       span.end(now);
     });
   }

packages/instrumentation-exception/src/node/index.ts

@@ -85,18 +85,23 @@ export const buildEventFromException = async (
 
 export const recordException = async (
   e: any,
-  hint?: EventHint,
-  tracer?: Tracer,
-  span?: Span,
-  attributes?: Attributes,
+  hint?: EventHint & {
+    tracer?: Tracer;
+    span?: Span;
+    attributes?: Attributes;
+  },
 ) => {
-  const _hint = hint ?? {
-    mechanism: {
-      type: 'generic',
-      handled: true,
-    },
-  };
   try {
+    const { tracer, span, attributes, ...eventHint } = hint ?? {};
+    const _hint =
+      Object.keys(eventHint).length > 0
+        ? eventHint
+        : {
+            mechanism: {
+              type: 'generic',
+              handled: true,
+            },
+          };
     const _eventProcessor = getEventProcessor(tracer ?? defaultTracer);
     const event = await buildEventFromException(e, {
       data: _hint,

packages/otel-web/src/index.ts

@@ -710,7 +710,10 @@ export const Rum: RumOtelWebType = {
       return;
     }
     const tracer = this.provider.getTracer('record-exception');
-    _recordException(error, undefined, tracer, undefined, attributes);
+    return _recordException(error, {
+      tracer,
+      attributes,
+    });
   },
 
   error(...args) {