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

chore(llmobs): backport token metric key name changes to 2.10 #9808

Merged
merged 2 commits into from
Jul 13, 2024

Conversation

lievan
Copy link
Contributor

@lievan lievan commented Jul 12, 2024

Manual backport for #9657 to 2.10

Backport allows us to remove logic in the backend which parses both (prompt/completion_tokens) and (input/output_tokens) keys

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

Makes the following updates to metric key names submitted to LLM
Observability for openai & bedrock integrations

`prompt_tokens` -> `input_tokens`
`completion_tokens` -> `output_tokens`

The backend already has the changes in place to accept these updated key
names so a hard cutover is OK.

A release note is not needed since metric key names used by our
integrations (openai, langchain, bedrock) when submitting data to LLM
Obs backend is an internal contract between the integration and backend.

When users set metric key names for manually created spans, our
documentation already instructs them to use input/output terminology

- [x] Change(s) are motivated and described in the PR description
- [x] Testing strategy is described if automated tests are not included
in the PR
- [x] Risks are described (performance impact, potential for breakage,
maintainability)
- [x] Change is maintainable (easy to change, telemetry, documentation)
- [x] [Library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
are followed or label `changelog/no-changelog` is set
- [x] Documentation is included (in-code, generated user docs, [public
corp docs](https://github.com/DataDog/documentation/))
- [x] Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))
- [x] If this PR changes the public interface, I've notified
`@DataDog/apm-tees`.

- [x] Title is accurate
- [x] All changes are related to the pull request's stated goal
- [x] Description motivates each change
- [x] Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- [x] Testing strategy adequately addresses listed risks
- [x] Change is maintainable (easy to change, telemetry, documentation)
- [x] Release note makes sense to a user of the library
- [x] Author has acknowledged and discussed the performance implications
of this PR as reported in the benchmarks PR comment
- [x] 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 <evan.li@datadoqhq.com>
Co-authored-by: kyle <kyle@verhoog.ca>
@lievan lievan added the changelog/no-changelog A changelog entry is not required for this PR. label Jul 12, 2024
@lievan lievan marked this pull request as ready for review July 12, 2024 13:24
@lievan lievan requested review from a team as code owners July 12, 2024 13:24
@lievan lievan requested a review from emmettbutler July 12, 2024 13:24
@datadog-dd-trace-py-rkomorn
Copy link

datadog-dd-trace-py-rkomorn bot commented Jul 12, 2024

Datadog Report

Branch report: evan.li/backport-9657-2.10
Commit report: e3a2197
Test service: dd-trace-py

✅ 0 Failed, 1469 Passed, 38933 Skipped, 37m 23.44s Total duration (1h 41m 30.78s time saved)

@pr-commenter
Copy link

pr-commenter bot commented Jul 12, 2024

Benchmarks

Benchmark execution time: 2024-07-12 20:48:48

Comparing candidate commit e3a2197 in PR branch evan.li/backport-9657-2.10 with baseline commit 1b4b2b9 in branch 2.10.

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

@Yun-Kim
Copy link
Contributor

Yun-Kim commented Jul 12, 2024

@erikayasuda @emmettbutler why is apm-core-python a required reviewer for this PR? 😕

@erikayasuda
Copy link
Contributor

@erikayasuda @emmettbutler why is apm-core-python a required reviewer for this PR? 😕

It's this 😞 https://github.com/DataDog/dd-trace-py/blob/main/.github/CODEOWNERS#L97
This doesn't include tests/contrib/botocore/test_bedrock_llmobs.py 😞

@erikayasuda
Copy link
Contributor

@Yun-Kim @lievan Just created this: #9819
Should unblock you guys in the future. I can approve this PR in case you want this merged sooner.

Copy link
Contributor

@erikayasuda erikayasuda left a comment

Choose a reason for hiding this comment

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

Adding core approval because of issue with CODEOWNERS. This should not be required going forward 👍

@Yun-Kim Yun-Kim merged commit 3713b28 into 2.10 Jul 13, 2024
121 of 147 checks passed
@Yun-Kim Yun-Kim deleted the evan.li/backport-9657-2.10 branch July 13, 2024 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog A changelog entry is not required for this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants