fix: replace deprecated OpenTelemetry SpanAttributes/ResourceAttributes imports#32604
fix: replace deprecated OpenTelemetry SpanAttributes/ResourceAttributes imports#32604stakeswky wants to merge 3 commits intolanggenius:mainfrom
Conversation
…es imports Replace deprecated and class-based imports with the new individual attribute constants from the OpenTelemetry semantic conventions library. - ResourceAttributes.* → individual imports from semconv.attributes/ semconv._incubating.attributes/ - SpanAttributes.HTTP_TARGET → URL_PATH (stable) - SpanAttributes.HTTP_METHOD → HTTP_REQUEST_METHOD (stable) - DEPLOYMENT_ENVIRONMENT → DEPLOYMENT_ENVIRONMENT_NAME (renamed) Closes langgenius#32600
Summary of ChangesHello @stakeswky, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request modernizes the OpenTelemetry integration by migrating from deprecated class-based attribute imports to the recommended individual attribute constants. This change ensures compatibility with the latest OpenTelemetry semantic conventions, improving maintainability and adherence to current best practices for observability data. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request effectively replaces deprecated OpenTelemetry ResourceAttributes and SpanAttributes with their modern, individual constant counterparts from the semantic conventions library. The changes are well-contained and correctly applied across the modified files. I have one minor suggestion regarding import style to enhance code consistency.
| from opentelemetry.semconv._incubating.attributes.deployment_attributes import ( | ||
| DEPLOYMENT_ENVIRONMENT_NAME, | ||
| ) |
There was a problem hiding this comment.
For consistency with other single-name imports in this file (e.g., PROCESS_PID on line 34), it's conventional to write this import on a single line without parentheses. This improves readability and maintains a consistent style.
from opentelemetry.semconv._incubating.attributes.deployment_attributes import DEPLOYMENT_ENVIRONMENT_NAMEReferences
- According to PEP 8, code should be written in a consistent style. While using parentheses for a single import is not a syntax error, it's inconsistent with how other single imports are handled in this file and with common Python conventions, which favor a single line for short, single-name imports. (link)
There was a problem hiding this comment.
Good catch — flattened to a single-line import in the latest commit to match the style of the surrounding imports.
The semconv package lacks type stubs, causing reportMissingTypeStubs errors in pyright strict mode. Adding it to allowedUntypedLibraries is consistent with how other opentelemetry subpackages are handled.
Summary
Replace deprecated
ResourceAttributesandSpanAttributesclass-based imports with the new individual attribute constants from the OpenTelemetry semantic conventions library.Changes
api/extensions/ext_otel.pyResourceAttributes.SERVICE_NAME→SERVICE_NAMEfromsemconv.attributes.service_attributesResourceAttributes.DEPLOYMENT_ENVIRONMENT→DEPLOYMENT_ENVIRONMENT_NAMEfromsemconv._incubating.attributes.deployment_attributesResourceAttributes.HOST_*→ individual imports fromsemconv._incubating.attributes.host_attributesResourceAttributes.OS_*→ individual imports fromsemconv._incubating.attributes.os_attributesResourceAttributes.PROCESS_PID→PROCESS_PIDfromsemconv._incubating.attributes.process_attributesapi/extensions/otel/instrumentation.pySpanAttributes.HTTP_TARGET→URL_PATH(stable)SpanAttributes.HTTP_METHOD→HTTP_REQUEST_METHOD(stable)Stable attributes use
opentelemetry.semconv.attributes.*, incubating ones useopentelemetry.semconv._incubating.attributes.*.Closes #32600