Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(llmobs): fix token extraction for chat completion streams [backport 2.20] #12091

Merged
merged 2 commits into from
Jan 27, 2025

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Jan 27, 2025

Backport 75179ef from #12070 to 2.20.

Fixes token chunk extraction to account for the choices field in a chunk being an empty list

Before

Error generating LLMObs span event for span <Span(id=16151817411339450163,trace_id=137677390470467884790869841527646927357,parent_id=None,name=openai.request)>, likely due to malformed span
Traceback (most recent call last):
  File "/XXXXX/ddtrace/contrib/internal/openai/utils.py", line 118, in __aiter__
    await self._extract_token_chunk(chunk)
  File "/XXXXX/ddtrace/contrib/internal/openai/utils.py", line 157, in _extract_token_chunk
    choice = getattr(chunk, "choices", [None])[0]
IndexError: list index out of range

After

Traced succesfully
image

Checklist

  • 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
  • The change includes or references documentation updates if necessary
  • Backport labels are set (if applicable)

Reviewer Checklist

  • 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 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

Fixes token chunk extraction to account for the `choices` field in a
chunk being an empty list

#### Before
```
Error generating LLMObs span event for span <Span(id=16151817411339450163,trace_id=137677390470467884790869841527646927357,parent_id=None,name=openai.request)>, likely due to malformed span
Traceback (most recent call last):
  File "/XXXXX/ddtrace/contrib/internal/openai/utils.py", line 118, in __aiter__
    await self._extract_token_chunk(chunk)
  File "/XXXXX/ddtrace/contrib/internal/openai/utils.py", line 157, in _extract_token_chunk
    choice = getattr(chunk, "choices", [None])[0]
IndexError: list index out of range
```

#### After
Traced succesfully
<img width="904" alt="image"
src="https://github.com/user-attachments/assets/43c68edd-03f7-4105-a3d3-213eeb5fb0ab"
/>

## 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]>
(cherry picked from commit 75179ef)
@github-actions github-actions bot requested review from a team as code owners January 27, 2025 05:33
@github-actions github-actions bot requested review from gnufede and avara1986 January 27, 2025 05:33
@datadog-dd-trace-py-rkomorn
Copy link

datadog-dd-trace-py-rkomorn bot commented Jan 27, 2025

Datadog Report

Branch report: backport-12070-to-2.20
Commit report: 7b3769b
Test service: dd-trace-py

✅ 0 Failed, 130 Passed, 1378 Skipped, 4m 34.45s Total duration (35m 10.66s time saved)

@pr-commenter
Copy link

pr-commenter bot commented Jan 27, 2025

Benchmarks

Benchmark execution time: 2025-01-27 06:17:57

Comparing candidate commit 616dec0 in PR branch backport-12070-to-2.20 with baseline commit fe4d74a in branch 2.20.

Found 3 performance improvements and 0 performance regressions! Performance is the same for 391 metrics, 2 unstable metrics.

scenario:iast_aspects-ospathbasename_aspect

  • 🟩 execution_time [-365.796ns; -304.094ns] or [-9.814%; -8.158%]

scenario:iast_aspects-ospathjoin_aspect

  • 🟩 execution_time [-460.034ns; -393.517ns] or [-8.221%; -7.032%]

scenario:iast_aspects-title_aspect

  • 🟩 execution_time [-265.349ns; -226.184ns] or [-8.641%; -7.366%]

@lievan lievan enabled auto-merge (squash) January 27, 2025 15:56
@Yun-Kim Yun-Kim closed this Jan 27, 2025
auto-merge was automatically disabled January 27, 2025 16:29

Pull request was closed

@Yun-Kim Yun-Kim reopened this Jan 27, 2025
@Yun-Kim Yun-Kim added changelog/no-changelog A changelog entry is not required for this PR. and removed changelog/no-changelog A changelog entry is not required for this PR. labels Jan 27, 2025
Copy link
Contributor Author

CODEOWNERS have been resolved as:

releasenotes/notes/fix-token-extraction-0133808742374ef4.yaml           @DataDog/apm-python
ddtrace/contrib/internal/openai/utils.py                                @DataDog/ml-observability

@Kyle-Verhoog Kyle-Verhoog enabled auto-merge (squash) January 27, 2025 19:51
@Kyle-Verhoog Kyle-Verhoog merged commit 07baf4c into 2.20 Jan 27, 2025
509 checks passed
@Kyle-Verhoog Kyle-Verhoog deleted the backport-12070-to-2.20 branch January 27, 2025 20:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants