Skip to content

fix(cli): suggest logfire extras instead of raw otel package names #1789

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

Open
tysoncung wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(cli): suggest logfire extras instead of raw otel package names #1789

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
59 changes: 54 additions & 5 deletions logfire/_internal/cli/run.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,32 @@

STANDARD_LIBRARY_PACKAGES = {'urllib', 'sqlite3'}

# Map of OpenTelemetry instrumentation packages to logfire optional dependency group names.
# When a package has a corresponding logfire extra, we recommend `logfire[extra]` instead
# of the raw `opentelemetry-instrumentation-*` package.
OTEL_PACKAGE_TO_LOGFIRE_EXTRA: dict[str, str] = {
'opentelemetry-instrumentation-aiohttp-client': 'aiohttp-client',
'opentelemetry-instrumentation-aiohttp-server': 'aiohttp-server',
'opentelemetry-instrumentation-asyncpg': 'asyncpg',
'opentelemetry-instrumentation-aws-lambda': 'aws-lambda',
Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot Mar 21, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

P2: New extra mapping duplicates instrumentation source and already contains unreachable entries, creating dead paths and drift risk.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At logfire/_internal/cli/run.py, line 33:

<comment>New extra mapping duplicates instrumentation source and already contains unreachable entries, creating dead paths and drift risk.</comment>

<file context>
@@ -23,6 +23,32 @@
+    'opentelemetry-instrumentation-aiohttp-client': 'aiohttp-client',
+    'opentelemetry-instrumentation-aiohttp-server': 'aiohttp-server',
+    'opentelemetry-instrumentation-asyncpg': 'asyncpg',
+    'opentelemetry-instrumentation-aws-lambda': 'aws-lambda',
+    'opentelemetry-instrumentation-celery': 'celery',
+    'opentelemetry-instrumentation-django': 'django',
</file context>
Fix with Cubic

'opentelemetry-instrumentation-celery': 'celery',
'opentelemetry-instrumentation-django': 'django',
'opentelemetry-instrumentation-fastapi': 'fastapi',
'opentelemetry-instrumentation-flask': 'flask',
'opentelemetry-instrumentation-google-genai': 'google-genai',
'opentelemetry-instrumentation-httpx': 'httpx',
'opentelemetry-instrumentation-mysql': 'mysql',
'opentelemetry-instrumentation-psycopg': 'psycopg',
'opentelemetry-instrumentation-psycopg2': 'psycopg2',
'opentelemetry-instrumentation-pymongo': 'pymongo',
'opentelemetry-instrumentation-redis': 'redis',
'opentelemetry-instrumentation-requests': 'requests',
'opentelemetry-instrumentation-sqlalchemy': 'sqlalchemy',
'opentelemetry-instrumentation-sqlite3': 'sqlite3',
'opentelemetry-instrumentation-starlette': 'starlette',
'opentelemetry-instrumentation-system-metrics': 'system-metrics',
}
Comment on lines +29 to +50
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot Mar 21, 2026

Choose a reason for hiding this comment

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

🚩 Dead entries in OTEL_PACKAGE_TO_LOGFIRE_EXTRA that can never be reached

Three entries in OTEL_PACKAGE_TO_LOGFIRE_EXTRA map to packages that are NOT in OTEL_INSTRUMENTATION_MAP: opentelemetry-instrumentation-aws-lambda, opentelemetry-instrumentation-google-genai, and opentelemetry-instrumentation-system-metrics. Since recommendations are only generated from packages in OTEL_INSTRUMENTATION_MAP (via find_recommended_instrumentations_to_install at logfire/_internal/cli/run.py:221), these entries will never be looked up. They are harmless but could be confusing—either they should be added to OTEL_INSTRUMENTATION_MAP (with corresponding logfire.instrument_* methods) or removed from OTEL_PACKAGE_TO_LOGFIRE_EXTRA to keep the maps consistent.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.


# Map of instrumentation packages to the packages they instrument
OTEL_INSTRUMENTATION_MAP = {
'opentelemetry-instrumentation-aio_pika': 'aio_pika',
Expand Down Expand Up @@ -237,7 +263,11 @@ def get_recommendation_texts(recommendations: set[tuple[str, str]]) -> tuple[Tex
sorted_recommendations = sorted(recommendations)
recommended_text = Text()
for pkg_name, instrumented_pkg in sorted_recommendations:
recommended_text.append(f'☐ {instrumented_pkg} (need to install {pkg_name})\n', style='grey50')
extra = OTEL_PACKAGE_TO_LOGFIRE_EXTRA.get(pkg_name)
if extra:
recommended_text.append(f'☐ {instrumented_pkg} (need to install logfire[{extra}])\n', style='grey50')
else:
recommended_text.append(f'☐ {instrumented_pkg} (need to install {pkg_name})\n', style='grey50')
recommended_text.append('\n')

install_text = Text()
Expand Down Expand Up @@ -308,18 +338,37 @@ def installed_packages() -> set[str]:


def _full_install_command(recommendations: list[tuple[str, str]]) -> str:
"""Generate a command to install all recommended packages at once."""
"""Generate a command to install all recommended packages at once.

When a recommended package has a corresponding logfire optional dependency group,
we suggest installing via ``logfire[extra1,extra2,...]`` instead of the raw
OpenTelemetry instrumentation package names. Packages without a logfire extra
are listed separately.
"""
if not recommendations:
return '' # pragma: no cover

package_names = [pkg_name for pkg_name, _ in recommendations]
logfire_extras: list[str] = []
standalone_packages: list[str] = []

for pkg_name, _ in recommendations:
extra = OTEL_PACKAGE_TO_LOGFIRE_EXTRA.get(pkg_name)
if extra:
logfire_extras.append(extra)
else:
standalone_packages.append(pkg_name)

parts: list[str] = []
if logfire_extras:
parts.append(f'logfire[{",".join(sorted(logfire_extras))}]')
Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot Mar 21, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

P2: Install command generation emits unquoted logfire[...] extras, which can break when pasted into shells that treat brackets as glob patterns (e.g., zsh).

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At logfire/_internal/cli/run.py, line 363:

<comment>Install command generation emits unquoted `logfire[...]` extras, which can break when pasted into shells that treat brackets as glob patterns (e.g., zsh).</comment>

<file context>
@@ -308,18 +338,37 @@ def installed_packages() -> set[str]:
+
+    parts: list[str] = []
+    if logfire_extras:
+        parts.append(f'logfire[{",".join(sorted(logfire_extras))}]')
+    parts.extend(sorted(standalone_packages))
 
</file context>
Fix with Cubic

parts.extend(sorted(standalone_packages))

# TODO(Marcelo): We should customize this. If the user uses poetry, they'd use `poetry add`.
# Something like `--install-format` with options like `requirements`, `poetry`, `uv`, `pip`.
if is_uv_installed():
return f'uv add {" ".join(package_names)}'
return f'uv add {" ".join(parts)}'
else:
return f'pip install {" ".join(package_names)}' # pragma: no cover
return f'pip install {" ".join(parts)}' # pragma: no cover


def collect_instrumentation_context(exclude: set[str]) -> InstrumentationContext:
Expand Down
Loading