opentelemetry-instrument 0.53b0 ModuleNotFoundError 'tortoise'

[gambitran]

Describe your environment

OS: Ubuntu
Python version: 3.13.2

Installed dependencies via uv.

[project]
name = "fastapi-template"
version = "0.1.0"
description = "Template for FastAPI project"
readme = "README.md"
requires-python = ">=3.13"
dependencies = [
    "fastapi[standard]>=0.115.12",
    "opentelemetry-distro>=0.53b0",
    "opentelemetry-exporter-otlp>=1.32.0",
]

What happened?

When running python application with opentelemetry-instrument command, it spits out error with ModuleNotFoundError: No module named 'tortoise'. Seems to be related to library instrumentation stemmed from pydantic (from fastapi).

Steps to Reproduce

uv add "fastapi[standard]" opentelemetry-distro opentelemetry-exporter-otlp  

uv run opentelemetry-bootstrap -a requirements | uv pip install --requirement -  

uv run opentelemetry-instrument uvicorn app.main:app --host 0.0.0.0 --port 8080

Expected Result

No error

Actual Result

Importing of tortoiseorm failed, skipping it
Traceback (most recent call last):
  File "/home/gambitran/projects/fastapi-template/.venv/lib/python3.13/site-packages/opentelemetry/instrumentation/auto_instrumentation/_load.py", line 74, in _load_instrumentors
    distro.load_instrumentor(
    ~~~~~~~~~~~~~~~~~~~~~~~~^
        entry_point, raise_exception_on_conflict=True
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    )
    ^
  File "/home/gambitran/projects/fastapi-template/.venv/lib/python3.13/site-packages/opentelemetry/instrumentation/distro.py", line 61, in load_instrumentor
    instrumentor: BaseInstrumentor = entry_point.load()
                                     ~~~~~~~~~~~~~~~~^^
  File "/home/gambitran/projects/fastapi-template/.venv/lib/python3.13/site-packages/importlib_metadata/__init__.py", line 189, in load
    module = import_module(match.group('module'))
  File "/home/gambitran/.local/share/uv/python/cpython-3.13.2-linux-x86_64-gnu/lib/python3.13/importlib/__init__.py", line 88, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "<frozen importlib._bootstrap>", line 1387, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1360, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1331, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 935, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 1026, in exec_module
  File "<frozen importlib._bootstrap>", line 488, in _call_with_frames_removed
  File "/home/gambitran/projects/fastapi-template/.venv/lib/python3.13/site-packages/opentelemetry/instrumentation/tortoiseorm/__init__.py", line 77, in <module>
    import tortoise.contrib.pydantic.base
ModuleNotFoundError: No module named 'tortoise'

Additional context

Error not present with opentelemetry-distro==0.52.b1 / opentelemetry-exporter-otlp==1.31.1

Would you like to implement a fix?

None

[xrmx]

@rjduffner I think this may be a regression from your changes. Care to take a look at it? We have quite a bunch of instrumentations that assume that the code they instrument is always available.

@gambitran workaround is to remove opentelemetry-instrumentation-tortoiseorm

[emdneto]

@rjduffner I think this may be a regression from your changes. Care to take a look at it? We have quite a bunch of instrumentations that assume that the code they instrument is always available.

@gambitran workaround is to remove opentelemetry-instrumentation-tortoiseorm

@xrmx Maybe we can just catch it specifically also instead of in the except ImportError? The exception isn't preventing other instrumentation to load (so, fastapi instrumentation is working)

diff --git a/opentelemetry-instrumentation/src/opentelemetry/instrumentation/auto_instrumentation/_load.py b/opentelemetry-instrumentation/src/opentelemetry/instrumentation/auto_instrumentation/_load.py
index 5084879f..21f5b369 100644
--- a/opentelemetry-instrumentation/src/opentelemetry/instrumentation/auto_instrumentation/_load.py
+++ b/opentelemetry-instrumentation/src/opentelemetry/instrumentation/auto_instrumentation/_load.py
@@ -82,6 +82,15 @@ def _load_instrumentors(distro):
                 exc.conflict,
             )
             continue
+        except ModuleNotFoundError:
+            # ModuleNotFoundError is raised when the library is not installed
+            # and the instrumentation is not required to be loaded.
+            _logger.debug(
+                "Skipping instrumentation %s: %s",
+                entry_point.name,
+                ModuleNotFoundError,
+            )
+            continue

[rjduffner]

@xrmx I can look first thing Monday pacific time.

[rjduffner]

So stepping through the install steps that @gambitran provided. I get.

> opentelemetry-bootstrap
opentelemetry-instrumentation-asyncio==0.53b0
opentelemetry-instrumentation-dbapi==0.53b0
opentelemetry-instrumentation-logging==0.53b0
opentelemetry-instrumentation-sqlite3==0.53b0
opentelemetry-instrumentation-threading==0.53b0
opentelemetry-instrumentation-urllib==0.53b0
opentelemetry-instrumentation-wsgi==0.53b0
opentelemetry-instrumentation-click==0.53b0
opentelemetry-instrumentation-fastapi==0.53b0
opentelemetry-instrumentation-grpc==0.53b0
opentelemetry-instrumentation-httpx==0.53b0
opentelemetry-instrumentation-jinja2==0.53b0
opentelemetry-instrumentation-requests==0.53b0
opentelemetry-instrumentation-starlette==0.53b0
opentelemetry-instrumentation-tortoiseorm==0.53b0
opentelemetry-instrumentation-urllib3==0.53b0
> pip list
Package                                  Version
---------------------------------------- ---------
annotated-types                          0.7.0
anyio                                    4.9.0
certifi                                  2025.1.31
charset-normalizer                       3.4.1
click                                    8.1.8
Deprecated                               1.2.18
dnspython                                2.7.0
email_validator                          2.2.0
fastapi                                  0.115.12
fastapi-cli                              0.0.7
googleapis-common-protos                 1.69.2
grpcio                                   1.71.0
h11                                      0.14.0
httpcore                                 1.0.8
httptools                                0.6.4
httpx                                    0.28.1
idna                                     3.10
importlib_metadata                       8.6.1
Jinja2                                   3.1.6
markdown-it-py                           3.0.0
MarkupSafe                               3.0.2
mdurl                                    0.1.2
opentelemetry-api                        1.32.0
opentelemetry-distro                     0.53b0
opentelemetry-exporter-otlp              1.32.0
opentelemetry-exporter-otlp-proto-common 1.32.0
opentelemetry-exporter-otlp-proto-grpc   1.32.0
opentelemetry-exporter-otlp-proto-http   1.32.0
opentelemetry-instrumentation            0.53b0
opentelemetry-proto                      1.32.0
opentelemetry-sdk                        1.32.0
opentelemetry-semantic-conventions       0.53b0
packaging                                24.2
pip                                      24.3.1
protobuf                                 5.29.4
pydantic                                 2.11.3
pydantic_core                            2.33.1
Pygments                                 2.19.1
python-dotenv                            1.1.0
python-multipart                         0.0.20
PyYAML                                   6.0.2
requests                                 2.32.3
rich                                     14.0.0
rich-toolkit                             0.14.1
shellingham                              1.5.4
sniffio                                  1.3.1
starlette                                0.46.2
typer                                    0.15.2
typing_extensions                        4.13.2
typing-inspection                        0.4.0
urllib3                                  2.4.0
uvicorn                                  0.34.1
uvloop                                   0.21.0
watchfiles                               1.0.5
websockets                               15.0.1
wrapt                                    1.17.2
zipp                                     3.21.0

The behavior is the same in the old version (0.52b1).

> opentelemetry-bootstrap
opentelemetry-instrumentation-asyncio==0.52b1
opentelemetry-instrumentation-dbapi==0.52b1
opentelemetry-instrumentation-logging==0.52b1
opentelemetry-instrumentation-sqlite3==0.52b1
opentelemetry-instrumentation-threading==0.52b1
opentelemetry-instrumentation-urllib==0.52b1
opentelemetry-instrumentation-wsgi==0.52b1
opentelemetry-instrumentation-click==0.52b1
opentelemetry-instrumentation-fastapi==0.52b1
opentelemetry-instrumentation-grpc==0.52b1
opentelemetry-instrumentation-httpx==0.52b1
opentelemetry-instrumentation-jinja2==0.52b1
opentelemetry-instrumentation-requests==0.52b1
opentelemetry-instrumentation-starlette==0.52b1
opentelemetry-instrumentation-tortoiseorm==0.52b1
opentelemetry-instrumentation-urllib3==0.52b1
> pip list
Package                                  Version
---------------------------------------- ---------
annotated-types                          0.7.0
anyio                                    4.9.0
certifi                                  2025.1.31
charset-normalizer                       3.4.1
click                                    8.1.8
Deprecated                               1.2.18
dnspython                                2.7.0
email_validator                          2.2.0
fastapi                                  0.115.12
fastapi-cli                              0.0.7
googleapis-common-protos                 1.69.2
grpcio                                   1.71.0
h11                                      0.14.0
httpcore                                 1.0.8
httptools                                0.6.4
httpx                                    0.28.1
idna                                     3.10
importlib_metadata                       8.6.1
Jinja2                                   3.1.6
markdown-it-py                           3.0.0
MarkupSafe                               3.0.2
mdurl                                    0.1.2
opentelemetry-api                        1.31.1
opentelemetry-distro                     0.52b1
opentelemetry-exporter-otlp              1.31.1
opentelemetry-exporter-otlp-proto-common 1.31.1
opentelemetry-exporter-otlp-proto-grpc   1.31.1
opentelemetry-exporter-otlp-proto-http   1.31.1
opentelemetry-instrumentation            0.52b1
opentelemetry-proto                      1.31.1
opentelemetry-sdk                        1.31.1
opentelemetry-semantic-conventions       0.52b1
packaging                                24.2
pip                                      24.3.1
protobuf                                 5.29.4
pydantic                                 2.11.3
pydantic_core                            2.33.1
Pygments                                 2.19.1
python-dotenv                            1.1.0
python-multipart                         0.0.20
PyYAML                                   6.0.2
requests                                 2.32.3
rich                                     14.0.0
rich-toolkit                             0.14.1
shellingham                              1.5.4
sniffio                                  1.3.1
starlette                                0.46.2
typer                                    0.15.2
typing_extensions                        4.13.2
typing-inspection                        0.4.0
urllib3                                  2.4.0
uvicorn                                  0.34.1
uvloop                                   0.21.0
watchfiles                               1.0.5
websockets                               15.0.1
wrapt                                    1.17.2
zipp                                     3.21.0

Looking at the bootstrap generation it looks like any installation of pydantic will also force the tortoise instrumentation to be installed

https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/opentelemetry-instrumentation/src/opentelemetry/instrumentation/bootstrap_gen.py#L207-L210

It seems to be that the bug is right here https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/instrumentation/opentelemetry-instrumentation-tortoiseorm/pyproject.toml#L37 in that the tortiseorm instrumentation implictly wraps some pydantic methods but only through the tortoise orm import.

So this will probably be the main bug as my assumption here was that opentelemetry would not try to instrument package that wasn't installed. But pydantic is that exception.

So why did this change behavior after my PR.

So it looks like to me that before my pr, the fact that we were using the dist lookup and not the package lookup was causing the instrument to fail (and not be instrumented) because there would be a conflict. Specifically, tortoiseorm wasn't installed. (The implicit "and" in dependencies list here https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/instrumentation/opentelemetry-instrumentation-tortoiseorm/pyproject.toml#L35-L38)

After my changes, the instrumentation logic only looks at https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/instrumentation/opentelemetry-instrumentation-tortoiseorm/src/opentelemetry/instrumentation/tortoiseorm/package.py#L16 which doesn't do the implicit and.

To me the regression is that this is now bubbling up instead of just not instrumenting. It looks like i did try to guard against this with the ImportError check @emdneto references but I did not go far enough and left the ModuleNotFoundError to bubble up. This is my fault. In all though, I think @emdneto's idea of catching the ModuleNotFoundError would work here.

Although a better fix might be to unwind this strange relationship between pydantic and tortoise-orm.

[xrmx]

So why did this change behavior after my PR.

So it looks like to me that before my pr, the fact that we were using the dist lookup and not the package lookup was causing the instrument to fail (and not be instrumented) because there would be a conflict. Specifically, tortoiseorm wasn't installed. (The implicit "and" in dependencies list here https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/instrumentation/opentelemetry-instrumentation-tortoiseorm/pyproject.toml#L35-L38)

After my changes, the instrumentation logic only looks at https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/instrumentation/opentelemetry-instrumentation-tortoiseorm/src/opentelemetry/instrumentation/tortoiseorm/package.py#L16 which doesn't do the implicit and.

To me the regression is that this is now bubbling up instead of just not instrumenting. It looks like i did try to guard against this with the ImportError check @emdneto references but I did not go far enough and left the ModuleNotFoundError to bubble up. This is my fault. In all though, I think @emdneto's idea of catching the ModuleNotFoundError would work here.

Sounds good to me. Maybe we can even add a basic autoinstrumentation testing pip install opentelemetry-contrib-instrumentations ... ; touch app.py; opentelemetry-instrument python app.py && test $? -eq 0

Although a better fix might be to unwind this strange relationship between pydantic and tortoise-orm.

I know 😓 #2409 and in particular #2409 (comment)

[rjduffner]

@xrmx Ohh cool! I am glad its filed and you are working on it. I'll try to get the first draft of the PR up here in the next couple days. Unless @emdneto is ready with their fix.

Otherwise ill incorporate their snippet above.

[rjduffner]

After looking at this a bit more, I remembered that ModuleNotFoundError is a kind of ImportError and thus the ImportError that already exists will catch the ModuleNotFoundError and skip the instrumentation loading.

If you look at the traceback above, you can actually see that is exactly what is happening. The instrumentation throws the ModuleNotFoundError and the ImportError except block is catching it and "skipping it".

Importing of tortoiseorm failed, skipping it

The code as it existed with the ImportError though uses logger.exception which prints the traceback with the log by default. (https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/opentelemetry-instrumentation/src/opentelemetry/instrumentation/auto_instrumentation/_load.py#L92-L95)

So I am beginning to think this issue is not really an issue (the instrumentation is getting skipped) but more a case of unexpected log spam that will eventually get fixed when #2409 is merged.

So I would say there are a couple options here.

1. Switch logger.exception to logger.error so that the traceback is not printed with the log
2. Switch it to logger.debug and don't print the traceback to match the behavior of the dependency conflict error above
3. Do nothing and keep this issue open until bootstrap: no need to install tortoiseorm instrumentation if pydantic is found #2409 goes and then we should be good.

@xrmx and @emdneto what do you think?

@gambitran, can you confirm that aside from the traceback in logs during startup, everything works as expected?

Thanks,
RJ

[emdneto]

@rjduffner you're right. We are catching it in the except ImportError block. The instrumentation is working fine, although the exception is logged. I opened a PR catching the ModuleNotFoundError and logging.debug the exception message. lmk wdyt

[rjduffner]

@emdneto, PR looks good to me. I left a comment for clarifying the changelog entry but overall 👍. Thank you!