Reduce ambiguity in the API

open-telemetry · Aug 28, 2023 · 8f71f2c · 8f71f2c
1 parent f70a9df
commit 8f71f2c
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/api/src/trace/span.ts b/api/src/trace/span.ts
@@ -125,9 +125,18 @@ export interface Span {
    * @param [time] the time to set as Span's event time. If not provided,
    *     use the current time.
    */
+  recordException(exception: Exception, time?: TimeInput): void;
+
+  /**
+   * Sets exception as a span event
+   * @param exception the exception the only accepted values are string or Error
+   * @param [attributes] the attributes that will be added to the error event.
+   * @param [time] the time to set as Span's event time. If not provided,
+   *     use the current time.
+   */
   recordException(
     exception: Exception,
-    attributesOrStartTime?: SpanAttributes | TimeInput,
+    attributes?: SpanAttributes,
     time?: TimeInput
   ): void;
 }