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.

Sign up for GitHub

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

Jump to bottom

opentelemetry-sdk: clarify Resource.create usage #4372

Merged
merged 4 commits into from
Dec 23, 2024
Merged

opentelemetry-sdk: clarify Resource.create usage #4372

merged 4 commits into from
Dec 23, 2024

Conversation

xrmx
Copy link
Contributor

@xrmx xrmx commented Dec 23, 2024

Description

After #3181 ResourceDetector instances cannot call Resource.create otherwise when using auto-instrumentation you'll go into an infinite loop trying to load resource detectors.

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?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A

Does This PR Require a Contrib Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

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

@xrmx
opentelemetry-sdk: clarify Resource.create usage
f8b865c 
After open-telemetry#3181 ResourceDetector instances cannot call Resource.create
otherwise when using auto-instrumentation you'll go into an infinite loop
trying to load resource detectors.
@xrmx xrmx requested a review from a team as a code owner December 23, 2024 15:43
@xrmx xrmx added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Dec 23, 2024
@xrmx xrmx mentioned this pull request Dec 23, 2024
Merged
aabmass
aabmass approved these changes Dec 23, 2024
View reviewed changes
Copy link
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.

Also consider maybe mentioning it ResourceDetector's docstring for implementors

opentelemetry-python/opentelemetry-sdk/src/opentelemetry/sdk/resources/__init__.py

Line 316 in f8b865c

class ResourceDetector(abc.ABC):

opentelemetry-sdk/src/opentelemetry/sdk/resources/__init__.py Outdated Show resolved Hide resolved
opentelemetry-sdk/src/opentelemetry/sdk/resources/__init__.py Outdated Show resolved Hide resolved
opentelemetry-sdk/src/opentelemetry/sdk/resources/__init__.py Outdated Show resolved Hide resolved
@aabmass aabmass merged commit 92f221c into open-telemetry:main Dec 23, 2024
380 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tammy-baylis-swi tammy-baylis-swi tammy-baylis-swi approved these changes

@aabmass aabmass aabmass approved these changes

Assignees
No one assigned
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@xrmx @aabmass @tammy-baylis-swi