elastic-opentelemetry-instrumentation-openai: fix tracing of openai client optional params (#12)

Fix some precedence bugs when settings optional client attributes,
before the fixes all the values had `true` as value.

Author: xrmx

instrumentation/elastic-opentelemetry-instrumentation-openai/src/opentelemetry/instrumentation/openai/helpers.py

@@ -112,17 +112,17 @@ def _get_span_attributes_from_wrapper(instance, kwargs):
                 elif scheme == "https":
                     span_attributes[SERVER_PORT] = 443
 
-    if frequency_penalty := kwargs.get("frequency_penalty") is not None:
+    if (frequency_penalty := kwargs.get("frequency_penalty")) is not None:
         span_attributes[GEN_AI_REQUEST_FREQUENCY_PENALTY] = frequency_penalty
-    if max_tokens := kwargs.get("max_tokens") is not None:
+    if (max_tokens := kwargs.get("max_completion_tokens", kwargs.get("max_tokens"))) is not None:
         span_attributes[GEN_AI_REQUEST_MAX_TOKENS] = max_tokens
-    if presence_penalty := kwargs.get("presence_penalty") is not None:
+    if (presence_penalty := kwargs.get("presence_penalty")) is not None:
         span_attributes[GEN_AI_REQUEST_PRESENCE_PENALTY] = presence_penalty
-    if temperature := kwargs.get("temperature") is not None:
+    if (temperature := kwargs.get("temperature")) is not None:
         span_attributes[GEN_AI_REQUEST_TEMPERATURE] = temperature
-    if top_p := kwargs.get("top_p") is not None:
+    if (top_p := kwargs.get("top_p")) is not None:
         span_attributes[GEN_AI_REQUEST_TOP_P] = top_p
-    if stop_sequences := kwargs.get("stop") is not None:
+    if (stop_sequences := kwargs.get("stop")) is not None:
         if isinstance(stop_sequences, str):
             stop_sequences = [stop_sequences]
         span_attributes[GEN_AI_REQUEST_STOP_SEQUENCES] = stop_sequences

instrumentation/elastic-opentelemetry-instrumentation-openai/tests/cassettes/TestChatCompletions.test_all_the_client_options.yaml

@@ -0,0 +1,98 @@
+interactions:
+- request:
+    body: '{"messages": [{"role": "user", "content": "Answer in up to 3 words: Which
+      ocean contains the falkland islands?"}], "model": "gpt-4o-mini", "frequency_penalty":
+      0, "max_completion_tokens": 100, "presence_penalty": 0, "stop": "foo", "temperature":
+      1, "top_p": 1}'
+    headers:
+      accept:
+      - application/json
+      accept-encoding:
+      - gzip, deflate
+      authorization:
+      - Bearer test_openai_api_key
+      connection:
+      - keep-alive
+      content-length:
+      - '260'
+      content-type:
+      - application/json
+      host:
+      - api.openai.com
+      user-agent:
+      - OpenAI/Python 1.50.2
+      x-stainless-arch:
+      - x64
+      x-stainless-async:
+      - 'false'
+      x-stainless-lang:
+      - python
+      x-stainless-os:
+      - Linux
+      x-stainless-package-version:
+      - 1.50.2
+      x-stainless-retry-count:
+      - '0'
+      x-stainless-runtime:
+      - CPython
+      x-stainless-runtime-version:
+      - 3.10.12
+    method: POST
+    uri: https://api.openai.com/v1/chat/completions
+  response:
+    body:
+      string: !!binary |
+        H4sIAAAAAAAAA3SQMU/DMBCF9/wKy3NTpSE0IVslxAZUqoABoch1LompYxv7QoGq/x05aZMysHh4
+        373nd3cICKGipDmhvGHIWyPD1e1TWS8X6/3Lh7q6W6vk+WH3k3zu73ebZUxn3qG378Dx7Jpz3RoJ
+        KLQaMLfAEHzqIo3TNL1JoqQHrS5BelttMEx02AolwjiKkzBKw0V2cjdacHA0J68BIYQc+tf3VCV8
+        0ZxEs7PSgnOsBpqPQ4RQq6VXKHNOOGQK6WyCXCsE1Vff6A4bskLJFApOHjkwNb+ctVB1jvm+qpPy
+        pB/Hz6WujdVbd+KjXgklXFNYYE4r/5FDbWhPjwEhb/2S3Z/e1FjdGixQ70D5wDgZ4uh02gmeGWpk
+        8sKT/ecpSkAmpLu4Ex3qCVVPAdHYsV+Sum+H0BaVUDVYY8VwtsoUVXa9BbZMs4QGx+AXAAD//wMA
+        sMwiB0QCAAA=
+    headers:
+      CF-Cache-Status:
+      - DYNAMIC
+      CF-RAY:
+      - 8cbbd9faeab95a0d-MXP
+      Connection:
+      - keep-alive
+      Content-Encoding:
+      - gzip
+      Content-Type:
+      - application/json
+      Date:
+      - Tue, 01 Oct 2024 10:43:24 GMT
+      Server:
+      - cloudflare
+      Set-Cookie: test_set_cookie
+      Transfer-Encoding:
+      - chunked
+      X-Content-Type-Options:
+      - nosniff
+      access-control-expose-headers:
+      - X-Request-ID
+      openai-organization: test_openai_org_key
+      openai-processing-ms:
+      - '145'
+      openai-version:
+      - '2020-10-01'
+      strict-transport-security:
+      - max-age=31536000; includeSubDomains; preload
+      x-ratelimit-limit-requests:
+      - '10000'
+      x-ratelimit-limit-tokens:
+      - '200000'
+      x-ratelimit-remaining-requests:
+      - '9999'
+      x-ratelimit-remaining-tokens:
+      - '199966'
+      x-ratelimit-reset-requests:
+      - 8.64s
+      x-ratelimit-reset-tokens:
+      - 10ms
+      x-request-id:
+      - req_b2c77a93a9995fac4529c05464b89f7e
+    status:
+      code: 200
+      message: OK
+version: 1

instrumentation/elastic-opentelemetry-instrumentation-openai/tests/test_chat_completions.py

@@ -25,7 +25,13 @@
 from opentelemetry.trace import SpanKind, StatusCode
 from opentelemetry.semconv._incubating.attributes.gen_ai_attributes import (
     GEN_AI_OPERATION_NAME,
+    GEN_AI_REQUEST_FREQUENCY_PENALTY,
+    GEN_AI_REQUEST_MAX_TOKENS,
     GEN_AI_REQUEST_MODEL,
+    GEN_AI_REQUEST_PRESENCE_PENALTY,
+    GEN_AI_REQUEST_STOP_SEQUENCES,
+    GEN_AI_REQUEST_TEMPERATURE,
+    GEN_AI_REQUEST_TOP_P,
     GEN_AI_SYSTEM,
     GEN_AI_RESPONSE_ID,
     GEN_AI_RESPONSE_MODEL,
@@ -222,6 +228,62 @@ def test_basic(self):
         self.assertOperationDurationMetric(operation_duration_metric)
         self.assertTokenUsageMetric(token_usage_metric)
 
+    def test_all_the_client_options(self):
+        messages = [
+            {
+                "role": "user",
+                "content": "Answer in up to 3 words: Which ocean contains the falkland islands?",
+            }
+        ]
+
+        chat_completion = self.client.chat.completions.create(
+            model=OPENAI_TOOL_MODEL,
+            messages=messages,
+            frequency_penalty=0,
+            max_completion_tokens=100,
+            presence_penalty=0,
+            temperature=1,
+            top_p=1,
+            stop="foo",
+        )
+
+        self.assertEqual(chat_completion.choices[0].message.content, "South Atlantic Ocean.")
+
+        spans = self.get_finished_spans()
+        self.assertEqual(len(spans), 1)
+
+        span = spans[0]
+        self.assertEqual(span.name, f"chat {OPENAI_TOOL_MODEL}")
+        self.assertEqual(span.kind, SpanKind.CLIENT)
+        self.assertEqual(span.status.status_code, StatusCode.UNSET)
+
+        self.assertEqual(
+            dict(span.attributes),
+            {
+                GEN_AI_OPERATION_NAME: "chat",
+                GEN_AI_REQUEST_FREQUENCY_PENALTY: 0,
+                GEN_AI_REQUEST_MAX_TOKENS: 100,
+                GEN_AI_REQUEST_MODEL: OPENAI_TOOL_MODEL,
+                GEN_AI_REQUEST_PRESENCE_PENALTY: 0,
+                GEN_AI_REQUEST_STOP_SEQUENCES: ("foo",),
+                GEN_AI_REQUEST_TEMPERATURE: 1,
+                GEN_AI_REQUEST_TOP_P: 1,
+                GEN_AI_SYSTEM: "openai",
+                GEN_AI_RESPONSE_ID: "chatcmpl-ADUdg61PwWqn3FPn4VNkz4vwMkS62",
+                GEN_AI_RESPONSE_MODEL: OPENAI_TOOL_MODEL + "-2024-07-18",  # Note it is more specific than request!,
+                GEN_AI_RESPONSE_FINISH_REASONS: ("stop",),
+                GEN_AI_USAGE_INPUT_TOKENS: 24,
+                GEN_AI_USAGE_OUTPUT_TOKENS: 4,
+                SERVER_ADDRESS: "api.openai.com",
+                SERVER_PORT: 443,
+            },
+        )
+        self.assertEqual(span.events, ())
+
+        operation_duration_metric, token_usage_metric = self.get_sorted_metrics()
+        self.assertOperationDurationMetric(operation_duration_metric)
+        self.assertTokenUsageMetric(token_usage_metric)
+
     def test_function_calling_with_tools(self):
         tools = [
             {