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): encode llm objects in utf-8 before sending #11961

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

jjxct
Copy link

@jjxct jjxct commented Jan 15, 2025

This PR resolves an issue in the Python SDK where non-ascii/utf8 characters being annotated on spans resulted in span payloads being dropped due to encoding errors.

In #11330 we previously added the ensure_ascii=False option to our safe_json() helper's use of json.dumps(...) in order to keep non-ascii characters from being encoded multiple times into nonsense (as we were calling safe_json() multiple nested times while building the span event from the span tags. However this resulted in issues where non-latin1 characters (which is a subset of utf-8 and apparently the encoding scheme HTTP library relies on, which we in turn rely on to submit payloads) broke the encoding at payload submission time.

To fix this, we remove the ensure_ascii=False option at the final write time.

Also note that after #11543 we mostly centralized all of the times a span event is encoded, which is at write time and when encoding the span's input/output value fields (which can be a json dictionary format). Since we need to provide valid json formatting for the IO fields (which leads to a prettier UI display), we still need to call json.dumps(ensure_ascii=False) to avoid the same problem as fixed by #11330, i.e. keep the non-ascii characters unencoded until at the very end (i.e. write time)

This PR also adds minor test fixtures mocking out the LLMObs back end intake to make assertions on the payloads we should be submitting to LLMObs, since previous tests were all relying on the span events prior to encoding/submission and weren't able to cover this scenario.

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

@jjxct jjxct requested a review from a team as a code owner January 15, 2025 17:54
Copy link
Contributor

github-actions bot commented Jan 15, 2025

CODEOWNERS have been resolved as:

releasenotes/notes/fix-llmobs-json-encoding-ascii-f8da77867a910de1.yaml  @DataDog/apm-python
ddtrace/llmobs/_llmobs.py                                               @DataDog/ml-observability
ddtrace/llmobs/_utils.py                                                @DataDog/ml-observability
ddtrace/llmobs/_writer.py                                               @DataDog/ml-observability
tests/llmobs/conftest.py                                                @DataDog/ml-observability
tests/llmobs/test_llmobs.py                                             @DataDog/ml-observability

@jjxct jjxct changed the title encode llm objects in utf-8 before sending chore(llmobs): encode llm objects in utf-8 before sending Jan 15, 2025
@pr-commenter
Copy link

pr-commenter bot commented Jan 15, 2025

Benchmarks

Benchmark execution time: 2025-01-17 05:07:22

Comparing candidate commit 88d3e48 in PR branch jonathan.chavez/encoding-llm with baseline commit 21d50d4 in branch main.

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

@Kyle-Verhoog Kyle-Verhoog changed the title chore(llmobs): encode llm objects in utf-8 before sending fix(llmobs): encode llm objects in utf-8 before sending Jan 15, 2025
@Yun-Kim Yun-Kim requested a review from a team as a code owner January 17, 2025 01:13
@Yun-Kim Yun-Kim requested review from juanjux and Yun-Kim January 17, 2025 01:13
@Yun-Kim Yun-Kim force-pushed the jonathan.chavez/encoding-llm branch from f48a064 to 3fab554 Compare January 17, 2025 01:30
---
fixes:
- |
LLM Observability: This fix resolves an issue where annotating a span with non utf-8 input/output values resulted in encoding errors.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
LLM Observability: This fix resolves an issue where annotating a span with non utf-8 input/output values resulted in encoding errors.
LLM Observability: This fix resolves an issue where annotating a span with non latin-1 (but valid utf-8) input/output values resulted in encoding errors.

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.

3 participants