Skip to content

starlette: add args to instrument_app docstring #4014

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
deepakdinesh1123 wants to merge 3 commits into
base: main
Choose a base branch
from
+16 −1
Open

starlette: add args to instrument_app docstring #4014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
998bbae
fix: add args to instrument_app docstring in starlette
deepakdinesh1123 Dec 7, 2025
d882751
Merge branch 'main' into starlette-fix-docstring
xrmx Dec 22, 2025
349d7f5
Update docs-requirements.txt
xrmx Dec 22, 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
1 change: 1 addition & 0 deletions docs-requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ pyramid>=1.7
redis>=2.6
remoulade>=0.50
sqlalchemy>=1.0
starlette~=0.50
Copy link
Contributor

@xrmx xrmx Dec 22, 2025

Choose a reason for hiding this comment

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

Looks like this is not enough to please tox -e docs

tornado>=5.1.1
tortoise-orm>=0.17.0

Expand Down
16 changes: 15 additions & 1 deletion ...lemetry-instrumentation-starlette/src/opentelemetry/instrumentation/starlette/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,21 @@ def instrument_app(
meter_provider: MeterProvider | None = None,
tracer_provider: TracerProvider | None = None,
):
"""Instrument an uninstrumented Starlette application."""
"""Instrument an uninstrumented Starlette application.

Args:
app: The starlette ASGI application callable to forward requests to.
server_request_hook: Optional callback which is called with the server span and ASGI
scope object for every incoming request.
client_request_hook: Optional callback which is called with the internal span, and ASGI
scope and event which are sent as dictionaries for when the method receive is called.
client_response_hook: Optional callback which is called with the internal span, and ASGI
scope and event which are sent as dictionaries for when the method send is called.
meter_provider: The optional meter provider to use. If omitted
the current globally configured one is used.
tracer_provider: The optional tracer provider to use. If omitted
the current globally configured one is used.
"""
tracer = get_tracer(
__name__,
__version__,
Expand Down
Loading