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

opentelemetry-sdk: clarify Resource.create usage #4372

Merged
merged 4 commits into from
Dec 23, 2024
Merged

opentelemetry-sdk: clarify Resource.create usage #4372

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f8b865c
opentelemetry-sdk: clarify Resource.create usage
xrmx Dec 23, 2024
2c75e8e
Update opentelemetry-sdk/src/opentelemetry/sdk/resources/__init__.py
xrmx Dec 23, 2024
ba82816
Update opentelemetry-sdk/src/opentelemetry/sdk/resources/__init__.py
xrmx Dec 23, 2024
56cc06b
More precise instructions
xrmx Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion opentelemetry-sdk/src/opentelemetry/sdk/resources/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@
these attributes can be included in the Resource.*

Resource objects are created with `Resource.create`, which accepts attributes
(key-values). Resources should NOT be created via constructor, and working with
(key-values). Resources should NOT be created via constructor except by `ResourceDetector`
instances which can't use `Resource.create` to avoid infinite loops. Working with
`Resource` objects should only be done via the Resource API methods. Resource
attributes can also be passed at process invocation in the
:envvar:`OTEL_RESOURCE_ATTRIBUTES` environment variable. You should register
Expand Down Expand Up @@ -175,6 +176,8 @@ def create(
) -> "Resource":
"""Creates a new `Resource` from attributes.

`ResourceDetector` instances should not call this method.

Args:
attributes: Optional zero or more key-value pairs.
schema_url: Optional URL pointing to the schema
Expand Down Expand Up @@ -316,6 +319,7 @@ def __init__(self, raise_on_error: bool = False) -> None:

@abc.abstractmethod
def detect(self) -> "Resource":
"""Don't call `Resource.create` here to avoid an infinite loop, instead instantiate `Resource` directly"""
raise NotImplementedError()


Expand Down
Loading