chore(openai): add model tag for openai metrics for consistency wit…

…h openai saas integration [backport 2.10] (#10383) Backport 07ecb27 from #10282 to 2.10. Metrics from the OpenAI SaaS integration `(openai.api.usage...)` have a `model` tag. We should also tag metrics from OpenAI APM Integration with `model` for convenience (for example if customers want to use both `openai.api.usage...` metrics and `openai.ratelimit...` metrics in the same dashboard). Addresses #10185 ## Checklist - [x] PR author has checked that all the criteria below are met - The PR description includes an overview of the change - The PR description articulates the motivation for the change - The change includes tests OR the PR description describes a testing strategy - The PR description notes risks associated with the change, if any - Newly-added code is easy to change - The change follows the [library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) - The change includes or references documentation updates if necessary - Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Reviewer has checked that all the criteria below are met - Title is accurate - All changes are related to the pull request's stated goal - Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes - Testing strategy adequately addresses listed risks - Newly-added code is easy to change - Release note makes sense to a user of the library - If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment - Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) Co-authored-by: lievan <[email protected]> Co-authored-by: Yun Kim <[email protected]>
DataDog · Sep 3, 2024 · d1cb550 · d1cb550
1 parent fd0bfa1
commit d1cb550
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 1 deletion.
diff --git a/ddtrace/llmobs/_integrations/openai.py b/ddtrace/llmobs/_integrations/openai.py
@@ -94,11 +94,13 @@ def _logs_tags(cls, span: Span) -> str:
 
     @classmethod
     def _metrics_tags(cls, span: Span) -> List[str]:
+        model_name = span.get_tag("openai.request.model") or ""
         tags = [
             "version:%s" % (config.version or ""),
             "env:%s" % (config.env or ""),
             "service:%s" % (span.service or ""),
-            "openai.request.model:%s" % (span.get_tag("openai.request.model") or ""),
+            "openai.request.model:%s" % model_name,
+            "model:%s" % model_name,
             "openai.request.endpoint:%s" % (span.get_tag("openai.request.endpoint") or ""),
             "openai.request.method:%s" % (span.get_tag("openai.request.method") or ""),
             "openai.organization.id:%s" % (span.get_tag("openai.organization.id") or ""),

diff --git a/releasenotes/notes/openai-model-tag-2482b3d5b2905db9.yaml b/releasenotes/notes/openai-model-tag-2482b3d5b2905db9.yaml
@@ -0,0 +1,4 @@
+---
+features:
+  - |
+    openai: This introduces 'model' tag for openai integration metrics for consistency with the OpenAI SaaS Integration. It has the same value as `openai.request.model`.
diff --git a/tests/contrib/openai/test_openai_v0.py b/tests/contrib/openai/test_openai_v0.py
@@ -151,6 +151,7 @@ def test_completion(
         "env:",
         "service:",
         "openai.request.model:ada",
+        "model:ada",
         "openai.request.endpoint:/v1/completions",
         "openai.request.method:POST",
         "openai.organization.id:",
@@ -220,6 +221,7 @@ async def test_acompletion(
         "env:",
         "service:",
         "openai.request.model:curie",
+        "model:curie",
         "openai.request.endpoint:/v1/completions",
         "openai.request.method:POST",
         "openai.organization.id:",
@@ -321,6 +323,7 @@ def test_global_tags(openai_vcr, ddtrace_config_openai, openai, mock_metrics, mo
             "env:staging",
             "version:1234",
             "openai.request.model:ada",
+            "model:ada",
             "openai.request.endpoint:/v1/completions",
             "openai.request.method:POST",
             "openai.organization.name:datadog-4",
@@ -1285,6 +1288,7 @@ def test_completion_stream(openai, openai_vcr, mock_metrics, mock_tracer):
         "env:",
         "service:",
         "openai.request.model:ada",
+        "model:ada",
         "openai.request.endpoint:/v1/completions",
         "openai.request.method:POST",
         "openai.organization.id:",
@@ -1325,6 +1329,7 @@ async def test_completion_async_stream(openai, openai_vcr, mock_metrics, mock_tr
         "env:",
         "service:",
         "openai.request.model:ada",
+        "model:ada",
         "openai.request.endpoint:/v1/completions",
         "openai.request.method:POST",
         "openai.organization.id:",
@@ -1372,6 +1377,7 @@ def test_chat_completion_stream(openai, openai_vcr, mock_metrics, snapshot_trace
         "env:",
         "service:",
         "openai.request.model:gpt-3.5-turbo",
+        "model:gpt-3.5-turbo",
         "openai.request.endpoint:/v1/chat/completions",
         "openai.request.method:POST",
         "openai.organization.id:",
@@ -1422,6 +1428,7 @@ async def test_chat_completion_async_stream(openai, openai_vcr, mock_metrics, sn
         "env:",
         "service:",
         "openai.request.model:gpt-3.5-turbo",
+        "model:gpt-3.5-turbo",
         "openai.request.endpoint:/v1/chat/completions",
         "openai.request.method:POST",
         "openai.organization.id:",

diff --git a/tests/contrib/openai/test_openai_v1.py b/tests/contrib/openai/test_openai_v1.py
@@ -168,6 +168,7 @@ def test_completion(
         "env:",
         "service:",
         "openai.request.model:ada",
+        "model:ada",
         "openai.request.endpoint:/v1/completions",
         "openai.request.method:POST",
         "openai.organization.id:",
@@ -238,6 +239,7 @@ async def test_acompletion(
         "env:",
         "service:",
         "openai.request.model:curie",
+        "model:curie",
         "openai.request.endpoint:/v1/completions",
         "openai.request.method:POST",
         "openai.organization.id:",
@@ -345,6 +347,7 @@ def test_global_tags(openai_vcr, ddtrace_config_openai, openai, mock_metrics, mo
             "env:staging",
             "version:1234",
             "openai.request.model:ada",
+            "model:ada",
             "openai.request.endpoint:/v1/completions",
             "openai.request.method:POST",
             "openai.organization.name:datadog-4",
@@ -952,6 +955,7 @@ def test_completion_stream(openai, openai_vcr, mock_metrics, mock_tracer):
         "env:",
         "service:",
         "openai.request.model:ada",
+        "model:ada",
         "openai.request.endpoint:/v1/completions",
         "openai.request.method:POST",
         "openai.organization.id:",
@@ -991,6 +995,7 @@ async def test_completion_async_stream(openai, openai_vcr, mock_metrics, mock_tr
         "env:",
         "service:",
         "openai.request.model:ada",
+        "model:ada",
         "openai.request.endpoint:/v1/completions",
         "openai.request.method:POST",
         "openai.organization.id:",
@@ -1033,6 +1038,7 @@ def test_completion_stream_context_manager(openai, openai_vcr, mock_metrics, moc
         "env:",
         "service:",
         "openai.request.model:ada",
+        "model:ada",
         "openai.request.endpoint:/v1/completions",
         "openai.request.method:POST",
         "openai.organization.id:",
@@ -1079,6 +1085,7 @@ def test_chat_completion_stream(openai, openai_vcr, mock_metrics, snapshot_trace
         "env:",
         "service:",
         "openai.request.model:gpt-3.5-turbo",
+        "model:gpt-3.5-turbo",
         "openai.request.endpoint:/v1/chat/completions",
         "openai.request.method:POST",
         "openai.organization.id:",
@@ -1128,6 +1135,7 @@ async def test_chat_completion_async_stream(openai, openai_vcr, mock_metrics, sn
         "env:",
         "service:",
         "openai.request.model:gpt-3.5-turbo",
+        "model:gpt-3.5-turbo",
         "openai.request.endpoint:/v1/chat/completions",
         "openai.request.method:POST",
         "openai.organization.id:",
@@ -1184,6 +1192,7 @@ async def test_chat_completion_async_stream_context_manager(openai, openai_vcr,
         "env:",
         "service:",
         "openai.request.model:gpt-3.5-turbo",
+        "model:gpt-3.5-turbo",
         "openai.request.endpoint:/v1/chat/completions",
         "openai.request.method:POST",
         "openai.organization.id:",