@arizeai/openinference-instrumentation-openai 4.4.0 → 4.4.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/openinference-instrumentation-openai",
-  "version": "4.4.0",
+  "version": "4.4.2",
   "private": false,
   "description": "OpenInference instrumentation for OpenAI",
   "keywords": [],
@@ -28,8 +28,8 @@
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/core": "^2.8.0",
     "@opentelemetry/instrumentation": "^0.46.0",
-    "@arizeai/openinference-core": "2.8.0",
-    "@arizeai/openinference-semantic-conventions": "2.14.0"
+    "@arizeai/openinference-core": "2.8.1",
+    "@arizeai/openinference-semantic-conventions": "2.15.0"
   },
   "devDependencies": {
     "@opentelemetry/exporter-trace-otlp-proto": "^0.50.0",

package/src/instrumentation.ts

@@ -327,6 +327,7 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
             },
           });
           const execContext = getExecContext(span);
+          const recordError = (error: unknown) => endSpanWithError(span, error);
           const execPromise = safeExecuteInTheMiddle(
             () => {
               return context.with(trace.setSpan(execContext, span), () => {
@@ -336,12 +337,7 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
             (error) => {
               // Push the error to the span
               if (error) {
-                span.recordException(error);
-                span.setStatus({
-                  code: SpanStatusCode.ERROR,
-                  message: error.message,
-                });
-                span.end();
+                recordError(error);
               }
             },
           );
@@ -375,6 +371,7 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
 
             return result;
           };
+          observeRejection(execPromise, recordError);
           const wrappedPromise = invokeMaybeAPIPromise(execPromise, wrappedPromiseThen);
           return context.bind(execContext, wrappedPromise);
         };
@@ -404,7 +401,7 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
             },
           });
           const execContext = getExecContext(span);
-
+          const recordError = (error: unknown) => endSpanWithError(span, error);
           const execPromise = safeExecuteInTheMiddle(
             () => {
               return context.with(trace.setSpan(execContext, span), () => {
@@ -414,12 +411,7 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
             (error) => {
               // Push the error to the span
               if (error) {
-                span.recordException(error);
-                span.setStatus({
-                  code: SpanStatusCode.ERROR,
-                  message: error.message,
-                });
-                span.end();
+                recordError(error);
               }
             },
           );
@@ -439,6 +431,7 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
             }
             return result;
           };
+          observeRejection(execPromise, recordError);
           const wrappedPromise = invokeMaybeAPIPromise(execPromise, wrappedPromiseThen);
           return context.bind(execContext, wrappedPromise);
         };
@@ -472,6 +465,7 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
             },
           });
           const execContext = getExecContext(span);
+          const recordError = (error: unknown) => endSpanWithError(span, error);
           const execPromise = safeExecuteInTheMiddle(
             () => {
               return context.with(trace.setSpan(execContext, span), () => {
@@ -481,12 +475,7 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
             (error) => {
               // Push the error to the span
               if (error) {
-                span.recordException(error);
-                span.setStatus({
-                  code: SpanStatusCode.ERROR,
-                  message: error.message,
-                });
-                span.end();
+                recordError(error);
               }
             },
           );
@@ -496,12 +485,14 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
               span.setAttributes({
                 // Do not record the output data as it can be large
                 ...getEmbeddingEmbeddingsAttributes(result),
+                ...getEmbeddingUsageAttributes(result),
               });
             }
             span.setStatus({ code: SpanStatusCode.OK });
             span.end();
             return result;
           };
+          observeRejection(execPromise, recordError);
           const wrappedPromise = invokeMaybeAPIPromise(execPromise, wrappedPromiseThen);
           return context.bind(execContext, wrappedPromise);
         };
@@ -536,6 +527,7 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
               },
             });
             const execContext = getExecContext(span);
+            const recordError = (error: unknown) => endSpanWithError(span, error);
             const execPromise = safeExecuteInTheMiddle(
               () => {
                 return context.with(trace.setSpan(execContext, span), () => {
@@ -545,12 +537,7 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
               (error) => {
                 // Push the error to the span
                 if (error) {
-                  span.recordException(error);
-                  span.setStatus({
-                    code: SpanStatusCode.ERROR,
-                    message: error.message,
-                  });
-                  span.end();
+                  recordError(error);
                 }
               },
             );
@@ -588,6 +575,7 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
 
               return result;
             };
+            observeRejection(execPromise, recordError);
             const wrappedPromise = invokeMaybeAPIPromise(execPromise, wrappedPromiseThen);
             return context.bind(execContext, wrappedPromise);
           };
@@ -616,14 +604,7 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
               },
             });
             const execContext = getExecContext(span);
-            const recordError = (error: unknown) => {
-              span.recordException(error instanceof Error ? error : String(error));
-              span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: error instanceof Error ? error.message : String(error),
-              });
-              span.end();
-            };
+            const recordError = (error: unknown) => endSpanWithError(span, error);
             const execPromise = safeExecuteInTheMiddle(
               () => {
                 return context.with(trace.setSpan(execContext, span), () => {
@@ -1001,6 +982,19 @@ function getEmbeddingEmbeddingsAttributes(response: CreateEmbeddingResponse): At
   }, {});
 }
 
+/**
+ * Get the token usage of an embedding response
+ */
+function getEmbeddingUsageAttributes(response: CreateEmbeddingResponse): Attributes {
+  if (!response.usage) {
+    return {};
+  }
+  return {
+    [SemanticConventions.LLM_TOKEN_COUNT_PROMPT]: response.usage.prompt_tokens,
+    [SemanticConventions.LLM_TOKEN_COUNT_TOTAL]: response.usage.total_tokens,
+  };
+}
+
 /**
  * Consumes the stream chunks and adds them to the span
  */
@@ -1114,7 +1108,8 @@ function isAPIPromise<T>(promise: unknown): promise is APIPromise<T> {
  * failed request would leave its span open. For an APIPromise the rejection is
  * observed through `asResponse()`, which settles with the underlying HTTP
  * promise and never parses the body: parsing it here as well would consume the
- * body before the caller reads it.
+ * body before the caller reads it. So only a failed request is observed, not a
+ * response body that fails to parse.
  *
  * @param promise - The value returned by the original SDK method
  * @param onRejected - Called with the rejection reason
@@ -1127,6 +1122,24 @@ function observeRejection(promise: unknown, onRejected: (error: unknown) => void
   }
 }
 
+/**
+ * Records the error on the span, sets its status to ERROR, and ends it.
+ *
+ * Used both when the SDK method throws synchronously and, through
+ * {@link observeRejection}, when its promise rejects (#3845).
+ *
+ * @param span - The span to end
+ * @param error - The thrown or rejected value, which need not be an Error
+ */
+function endSpanWithError(span: Span, error: unknown): void {
+  span.recordException(error instanceof Error ? error : String(error));
+  span.setStatus({
+    code: SpanStatusCode.ERROR,
+    message: error instanceof Error ? error.message : String(error),
+  });
+  span.end();
+}
+
 /**
  * Invokes the thennable of a promise or an APIPromise.
  *

package/src/version.ts

@@ -1,2 +1,2 @@
 // this is an auto-generated file. see js/scripts/version-update.js
-export const VERSION = "4.4.0";
+export const VERSION = "4.4.2";