Skip to content

GenAI Utils Structure#3672

Merged
aabmass merged 18 commits intoopen-telemetry:mainfrom
splunk:genai-instrumentation-sdk-base
Aug 15, 2025
Merged

GenAI Utils Structure#3672
aabmass merged 18 commits intoopen-telemetry:mainfrom
splunk:genai-instrumentation-sdk-base

Conversation

@keith-decker
Copy link
Copy Markdown
Contributor

@keith-decker keith-decker commented Aug 4, 2025 •
edited
Loading

Description

This PR creates the Structure for the GenAI Utils package. The GenAI Utils package will include boilerplate and helpers to standardize instrumentation for Generative AI. Once implementation is complete, this package will provide APIs and decorators to minimize the work needed to instrument genai libraries, while providing standardization for generating both types of otel, "spans and metrics" and "spans, metrics and events"

Here's a link to the design document for the upcoming implementation: https://docs.google.com/document/d/1w9TbtKjuRX_wymS8DRSwPA03_VhrGlyx65hHAdNik1E/edit?tab=t.qneb4vabc1wc#heading=h.kh4j6stirken

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

N/A - No tests in this structure PR

  • Test A

Does This PR Require a Core Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

@keith-decker keith-decker requested a review from a team as a code owner August 4, 2025 15:35
@keith-decker keith-decker marked this pull request as draft August 4, 2025 15:35
keith-decker
keith-decker commented Aug 4, 2025
View reviewed changes
Comment thread scripts/generate_instrumentation_bootstrap.py Outdated
@keith-decker keith-decker marked this pull request as ready for review August 4, 2025 16:07
@keith-decker
Copy link
Copy Markdown
Contributor Author

keith-decker commented Aug 4, 2025

@pmcollins - Mind taking a look?

@keith-decker keith-decker changed the title GenAI SDK Structure GenAI Utils Structure Aug 4, 2025
@zhirafovod
Copy link
Copy Markdown

zhirafovod commented Aug 5, 2025

LGTM. @aabmass could you review it?

keith-decker
keith-decker commented Aug 5, 2025
View reviewed changes
Comment thread scripts/generate_instrumentation_bootstrap.py Outdated
91pavan
91pavan reviewed Aug 6, 2025
View reviewed changes
Comment thread instrumentation-genai/opentelemetry-genai-utils/pyproject.toml Outdated
pmcollins
pmcollins reviewed Aug 6, 2025
View reviewed changes
Comment thread instrumentation-genai/opentelemetry-genai-utils/pyproject.toml Outdated
pmcollins
pmcollins reviewed Aug 7, 2025
View reviewed changes
Comment thread instrumentation-genai/opentelemetry-genai-utils/src/opentelemetry/genai/utils/package.py Outdated
pmcollins
pmcollins reviewed Aug 7, 2025
View reviewed changes
Comment thread opentelemetry-instrumentation/src/opentelemetry/instrumentation/bootstrap_gen.py Outdated
pmcollins
pmcollins approved these changes Aug 8, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@pmcollins pmcollins left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Added a comment -- other than that LGTM.

Comment thread util/opentelemetry-genai-utils/src/opentelemetry/genai/utils/package.py
aabmass
aabmass reviewed Aug 13, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@aabmass aabmass left a comment

Choose a reason for hiding this comment

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

The http util that lives in this same directory is a little different

  • named opentelemetry-util-http
  • python package is opentelemetry.util.http

WDYT of copying that pattern here? Asking because we can't easily change the package name on PyPI once published

aabmass
aabmass requested changes Aug 13, 2025
View reviewed changes
Comment thread util/opentelemetry-genai-utils/README.rst Outdated
@aabmass
Copy link
Copy Markdown
Member

aabmass commented Aug 13, 2025

Can you also add this package to the Pyright config like we did in #3646?

I noticed we didn't add the tox boilerplate either, but we missed it for the other boilerplate PRs too. Please make sure it gets added in the future PRs, since that makes the tests run

@keith-decker
Copy link
Copy Markdown
Contributor Author

keith-decker commented Aug 14, 2025

The http util that lives in this same directory is a little different

  • named opentelemetry-util-http
  • python package is opentelemetry.util.http

WDYT of copying that pattern here? Asking because we can't easily change the package name on PyPI once published

I think that's fine, the name has been updated

@keith-decker
Copy link
Copy Markdown
Contributor Author

keith-decker commented Aug 14, 2025

Can you also add this package to the Pyright config like we did in #3646?

I noticed we didn't add the tox boilerplate either, but we missed it for the other boilerplate PRs too. Please make sure it gets added in the future PRs, since that makes the tests run

Tox Boilerplate has been added with a basic test for version check to make tox pass.

@keith-decker
Copy link
Copy Markdown
Contributor Author

keith-decker commented Aug 14, 2025

@aabmass The failing checks refer to a module "asyncclick". These checks showed up after merging main back into this branch.

Is this something I should investigate in this PR?

aabmass
aabmass approved these changes Aug 14, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@aabmass aabmass left a comment

Choose a reason for hiding this comment

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

Ty! One nit and I'll merge

Comment thread util/opentelemetry-util-genai/README.rst Outdated
@aabmass
Copy link
Copy Markdown
Member

aabmass commented Aug 14, 2025

@aabmass The failing checks refer to a module "asyncclick". These checks showed up after merging main back into this branch.

Seems like an issue in main sorry

@aabmass
Copy link
Copy Markdown
Member

aabmass commented Aug 15, 2025

Thanks for your patience. I reserved the package name on PyPI as well

@aabmass aabmass merged commit bbcdf8b into open-telemetry:main Aug 15, 2025
632 checks passed
sightseeker added a commit to sightseeker/opentelemetry-python-contrib that referenced this pull request Mar 11, 2026
@sightseeker
GenAI Utils Structure (open-telemetry#3672)
7967a16 
* GenAI SDK Structure

* generate bootstrap entry

* Rename GenAI SDK to GenAI Utils

* remove duplicate dependency

* update uv lock

* generate tox doc

* remove sdk dependency, remove bootstrap entry

* ran tox generate and uv sync

* move package out of instrumentation folder

* remove package file

* rename package to align with other util package

* add tox boilerplate

* tox boilerplate

* Fix pytest version

* Corrected RST Link
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pmcollins pmcollins pmcollins approved these changes

@aabmass aabmass aabmass approved these changes

+1 more reviewer

@91pavan 91pavan 91pavan approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@codefromthecrypt codefromthecrypt

@nirga nirga

@lzchen lzchen

@karthikscale3 karthikscale3

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

9 participants

@keith-decker @zhirafovod @aabmass @pmcollins @91pavan @codefromthecrypt @nirga @lzchen @karthikscale3