Skip to content

feat(openai)!: change span resource names to be consistent between openai v3 and v4#5638

Merged
sabrenner merged 2 commits into
masterfrom
sabrenner/change-openai-resource-names
May 2, 2025
Merged

feat(openai)!: change span resource names to be consistent between openai v3 and v4#5638
sabrenner merged 2 commits into
masterfrom
sabrenner/change-openai-resource-names

Conversation

@sabrenner

@sabrenner sabrenner commented Apr 30, 2025

Copy link
Copy Markdown
Collaborator

What does this PR do?

Reverts OpenAI resource names for openai>=4.0.0 to follow standards of resource naming between the Node.js tracer and Python tracer. For example:

chat.completions.createcreateChatCompletion
completions.createcreateCompletion

etc.

Motivation

Consistency for resource names not only between versions of OpenAI SDK for our integration, but also between languages for the Datadog tracers.

MLOB-1055

Plugin Checklist

@github-actions

github-actions Bot commented Apr 30, 2025

Copy link
Copy Markdown
Contributor

Overall package size

Self size: 9.3 MB
Deduped: 102.55 MB
No deduping: 103.07 MB

Dependency sizes | name | version | self size | total size | |------|---------|-----------|------------| | @datadog/libdatadog | 0.5.1 | 29.73 MB | 29.73 MB | | @datadog/native-appsec | 8.5.2 | 19.33 MB | 19.34 MB | | @datadog/native-iast-taint-tracking | 3.3.1 | 13.99 MB | 13.99 MB | | @datadog/pprof | 5.7.1 | 9.51 MB | 9.88 MB | | @opentelemetry/core | 1.30.1 | 908.66 kB | 7.16 MB | | protobufjs | 7.4.0 | 2.77 MB | 5.42 MB | | @datadog/wasm-js-rewriter | 4.0.1 | 2.85 MB | 3.58 MB | | @datadog/native-metrics | 3.1.1 | 1.02 MB | 1.43 MB | | @opentelemetry/api | 1.8.0 | 1.21 MB | 1.21 MB | | import-in-the-middle | 1.13.1 | 117.64 kB | 839.26 kB | | source-map | 0.7.4 | 226 kB | 226 kB | | opentracing | 0.14.7 | 194.81 kB | 194.81 kB | | lru-cache | 7.18.3 | 133.92 kB | 133.92 kB | | pprof-format | 2.1.0 | 111.69 kB | 111.69 kB | | @datadog/sketches-js | 2.1.1 | 109.9 kB | 109.9 kB | | lodash.sortby | 4.7.0 | 75.76 kB | 75.76 kB | | ignore | 5.3.2 | 53.63 kB | 53.63 kB | | istanbul-lib-coverage | 3.2.0 | 29.34 kB | 29.34 kB | | rfdc | 1.4.1 | 27.15 kB | 27.15 kB | | @isaacs/ttlcache | 1.4.1 | 25.2 kB | 25.2 kB | | dc-polyfill | 0.1.8 | 25.08 kB | 25.08 kB | | tlhunter-sorted-set | 0.1.0 | 24.94 kB | 24.94 kB | | shell-quote | 1.8.2 | 23.54 kB | 23.54 kB | | limiter | 1.1.5 | 23.17 kB | 23.17 kB | | retry | 0.13.1 | 18.85 kB | 18.85 kB | | semifies | 1.0.0 | 15.84 kB | 15.84 kB | | jest-docblock | 29.7.0 | 8.99 kB | 12.76 kB | | crypto-randomuuid | 1.0.0 | 11.18 kB | 11.18 kB | | ttl-set | 1.0.0 | 4.61 kB | 9.69 kB | | mutexify | 1.4.0 | 5.71 kB | 8.74 kB | | path-to-regexp | 0.1.12 | 6.6 kB | 6.6 kB | | koalas | 1.0.2 | 6.47 kB | 6.47 kB | | module-details-from-path | 1.0.3 | 4.47 kB | 4.47 kB |

🤖 This report was automatically generated by heaviest-objects-in-the-universe

@codecov

codecov Bot commented Apr 30, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 97.95918% with 1 line in your changes missing coverage. Please review.

Project coverage is 78.99%. Comparing base (54c7c51) to head (22612d5).
Report is 232 commits behind head on master.

Files with missing lines Patch % Lines
packages/datadog-plugin-openai/src/tracing.js 97.95% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5638      +/-   ##
==========================================
- Coverage   79.03%   78.99%   -0.05%     
==========================================
  Files         512      508       -4     
  Lines       23390    23326      -64     
==========================================
- Hits        18487    18426      -61     
+ Misses       4903     4900       -3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@datadog-datadog-prod-us1

datadog-datadog-prod-us1 Bot commented Apr 30, 2025

Copy link
Copy Markdown

Datadog Report

Branch report: sabrenner/change-openai-resource-names
Commit report: ed0baad
Test service: dd-trace-js-integration-tests

✅ 0 Failed, 928 Passed, 0 Skipped, 20m 56.23s Total Time

@pr-commenter

pr-commenter Bot commented Apr 30, 2025

Copy link
Copy Markdown

Benchmarks

Benchmark execution time: 2025-05-01 18:55:18

Comparing candidate commit 22612d5 in PR branch sabrenner/change-openai-resource-names with baseline commit 54c7c51 in branch master.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 1271 metrics, 52 unstable metrics.

@sabrenner
sabrenner marked this pull request as ready for review May 1, 2025 13:52
@sabrenner
sabrenner requested a review from a team as a code owner May 1, 2025 13:52
Yun-Kim
Yun-Kim previously approved these changes May 1, 2025

@rochdev rochdev left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Would probably be a bit nicer to read to have some sort of helper like expectResource(traces[0][0], 'createTranslation', 'audio.translations.create') instead of repeating the condition everywhere, but that's still fine and I do like verbose tests.

@sabrenner
sabrenner merged commit 075c8e4 into master May 2, 2025
@sabrenner
sabrenner deleted the sabrenner/change-openai-resource-names branch May 2, 2025 14:04
@sabrenner

Copy link
Copy Markdown
Collaborator Author

@rochdev yeah these tests are due for a refactor in general to make them a bit more modularized to each of the like 26 different functions we trace 😜 i actually think the orchestrion rewrite will help with this

ghost pushed a commit that referenced this pull request Jun 26, 2025
…nai v3 and v4 (#5638)

* resource names breaking change

* try with checking against DD_MAJOR
@ghost ghost mentioned this pull request Jun 26, 2025
szegedi pushed a commit that referenced this pull request Jul 1, 2025
…nai v3 and v4 (#5638)

* resource names breaking change

* try with checking against DD_MAJOR
@sabrenner sabrenner added this to the 6.0.0 milestone Oct 21, 2025
@pabloerhard pabloerhard changed the title feat(openai): change span resource names to be consistent between openai v3 and v4 feat(openai)!: change span resource names to be consistent between openai v3 and v4 Jul 2, 2026
@dd-octo-sts dd-octo-sts Bot mentioned this pull request Jul 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants