Skip to content

[tracing] Update OpenTelemetry dependencies and fixing doc to make tracing work #57908

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

Merged
merged 2 commits into from
Oct 21, 2025
+8 −8
Merged

[tracing] Update OpenTelemetry dependencies and fixing doc to make tracing work #57908

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c0e6cd
[tracing] Update OpenTelemetry dependencies and improve error messagi…
wph95 Oct 20, 2025
4d587a6
Update python/ray/util/tracing/tracing_helper.py
wph95 Oct 20, 2025
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: 3 additions & 3 deletions doc/source/ray-observability/user-guides/ray-tracing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ First, install OpenTelemetry:

.. code-block:: shell

pip install opentelemetry-api==1.1.0
pip install opentelemetry-sdk==1.1.0
pip install opentelemetry-exporter-otlp==1.1.0
pip install opentelemetry-api==1.34.1
pip install opentelemetry-sdk==1.34.1
pip install opentelemetry-exporter-otlp==1.34.1
Comment on lines +18 to +20
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Oct 20, 2025

Choose a reason for hiding this comment

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

medium

For conciseness and to ensure atomic installation of compatible versions, it's better to combine these pip install commands into a single line.

Suggested change
pip install opentelemetry-api==1.34.1
pip install opentelemetry-sdk==1.34.1
pip install opentelemetry-exporter-otlp==1.34.1
pip install opentelemetry-api==1.34.1 opentelemetry-sdk==1.34.1 opentelemetry-exporter-otlp==1.34.1


Tracing startup hook
--------------------
Expand Down
10 changes: 5 additions & 5 deletions python/ray/util/tracing/tracing_helper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,12 @@ def _try_import(self, module):
try:
return importlib.import_module(module)
except ImportError:
if os.getenv("RAY_TRACING_ENABLED", "False").lower() in ["true", "1"]:
if _is_tracing_enabled():
Copy link

@cursor cursor bot Oct 20, 2025

Choose a reason for hiding this comment

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

Bug: Tracing Configuration Error Handling Regression

The ImportError for missing OpenTelemetry dependencies now relies on _is_tracing_enabled(), which checks an internal global flag instead of the RAY_TRACING_ENABLED environment variable. This means setting the environment variable no longer triggers the helpful error, leading to silent failures and making dependency issues harder to diagnose. The _is_tracing_enabled() docstring is also inaccurate.

Fix in Cursor Fix in Web

Copy link
Contributor Author

@wph95 wph95 Oct 20, 2025

Choose a reason for hiding this comment

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

Double-checked:
RAY_TRACING_ENABLED is only used at tracing_helper.py line 78.
It’s safe to remove it.

raise ImportError(
"Install opentelemetry with "
"'pip install opentelemetry-api==1.0.0rc1' "
"and 'pip install opentelemetry-sdk==1.0.0rc1' to enable "
"tracing. See more at docs.ray.io/tracing.html"
"Install OpenTelemetry with "
"'pip install opentelemetry-api==1.34.1 opentelemetry-sdk==1.34.1' "
"to enable tracing. See the Ray documentation for details: "
"https://docs.ray.io/en/latest/ray-observability/user-guides/ray-tracing.html#installation"
)


Expand Down