Aiohttp server wrapper (#1131)

Co-authored-by: Alex Hall <[email protected]>

Author: adtyavrdhn

docs/integrations/http-clients/aiohttp.md

@@ -8,14 +8,13 @@ integration: otel
 
 The [`logfire.instrument_aiohttp_client()`][logfire.Logfire.instrument_aiohttp_client] method will create a span for every request made by your AIOHTTP clients.
 
-!!! question "What about AIOHTTP Server?"
-    The AIOHTTP server instrumentation is not supported yet. You can track the progress [here][aiohttp-server].
+For AIOHTTP server instrumentation, see [here](../web-frameworks/aiohttp.md).
 
 ## Installation
 
-Install `logfire` with the `aiohttp` extra:
+Install `logfire` with the `aiohttp-client` extra:
 
-{{ install_logfire(extras=['aiohttp']) }}
+{{ install_logfire(extras=['aiohttp-client']) }}
 
 ## Usage
 
@@ -59,5 +58,4 @@ logfire.instrument_aiohttp_client(url_filter=mask_url)
 ```
 
 [aiohttp]: https://docs.aiohttp.org/en/stable/
-[aiohttp-server]: https://github.com/open-telemetry/opentelemetry-python-contrib/issues/501
 [opentelemetry-aiohttp]: https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/aiohttp_client/aiohttp_client.html

docs/integrations/web-frameworks/aiohttp.md

@@ -0,0 +1,54 @@
+---
+integration: otel
+---
+
+# AIOHTTP Server
+
+[AIOHTTP][aiohttp] is an asynchronous HTTP client/server framework for asyncio and Python.
+
+The [`logfire.instrument_aiohttp_server()`][logfire.Logfire.instrument_aiohttp_server] method will create a span for every request made to your AIOHTTP server.
+
+For AIOHTTP client instrumentation, see [here](../http-clients/aiohttp.md).
+
+## Installation
+
+Install `logfire` with the `aiohttp-server` extra:
+
+{{ install_logfire(extras=['aiohttp-server']) }}
+
+## Usage
+
+Here's a minimal server example:
+
+```py title="server.py"
+import logfire
+from aiohttp import web
+
+
+logfire.configure()
+logfire.instrument_aiohttp_server()
+
+
+async def hello(request):
+    return web.Response(text="Hello, World!")
+
+
+async def user_handler(request):
+    user_id = request.match_info['user_id']
+    return web.json_response({"user_id": user_id, "message": "User profile"})
+
+
+app = web.Application()
+app.router.add_get('/', hello)
+app.router.add_get('/users/{user_id}', user_handler)
+
+
+if __name__ == "__main__":
+    web.run_app(app, host='localhost', port=8080)
+```
+
+You can run this server with `python server.py` and then make requests to `http://localhost:8080/` or `http://localhost:8080/users/123` to see the spans created for each request.
+
+The keyword arguments of [`logfire.instrument_aiohttp_server()`][logfire.Logfire.instrument_aiohttp_server] are passed to the `AioHttpServerInstrumentor().instrument()` method of the [OpenTelemetry AIOHTTP server instrumentation package](https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/aiohttp_server/aiohttp_server.html).
+
+[aiohttp]: https://docs.aiohttp.org/en/stable/

docs/integrations/web-frameworks/index.md

@@ -10,6 +10,7 @@ If you're using one of the following libraries, check out the integration docs:
 - [Starlette](../web-frameworks/starlette.md)
 - [Django](../web-frameworks/django.md)
 - [Flask](../web-frameworks/flask.md)
+- [AIOHTTP](../web-frameworks/aiohttp.md)
 
 Otherwise, check if your server uses [WSGI](../web-frameworks/wsgi.md) or [ASGI](../web-frameworks/asgi.md) and check the corresponding integration.
 

docs/plugins/main.py

@@ -156,6 +156,7 @@ def integrations_metadata(markdown: str, page: Page) -> str:
     'starlette': 'https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/starlette/starlette.html',
     'asgi': 'https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/asgi/asgi.html',
     'wsgi': 'https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/wsgi/wsgi.html',
+    'aiohttp': 'https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/aiohttp_server/aiohttp_server.html',
 }
 
 

logfire-api/logfire_api/__init__.py

@@ -148,6 +148,8 @@ def instrument_openai_agents(self, *args, **kwargs) -> None: ...
 
             def instrument_aiohttp_client(self, *args, **kwargs) -> None: ...
 
+            def instrument_aiohttp_server(self, *args, **kwargs) -> None: ...
+
             def instrument_system_metrics(self, *args, **kwargs) -> None: ...
 
             def instrument_mcp(self, *args, **kwargs) -> None: ...
@@ -189,6 +191,7 @@ def shutdown(self, *args, **kwargs) -> None: ...
         instrument_flask = DEFAULT_LOGFIRE_INSTANCE.instrument_flask
         instrument_starlette = DEFAULT_LOGFIRE_INSTANCE.instrument_starlette
         instrument_aiohttp_client = DEFAULT_LOGFIRE_INSTANCE.instrument_aiohttp_client
+        instrument_aiohttp_server = DEFAULT_LOGFIRE_INSTANCE.instrument_aiohttp_server
         instrument_sqlalchemy = DEFAULT_LOGFIRE_INSTANCE.instrument_sqlalchemy
         instrument_sqlite3 = DEFAULT_LOGFIRE_INSTANCE.instrument_sqlite3
         instrument_aws_lambda = DEFAULT_LOGFIRE_INSTANCE.instrument_aws_lambda

logfire-api/logfire_api/__init__.pyi

@@ -13,7 +13,7 @@ from .version import VERSION as VERSION
 from logfire.sampling import SamplingOptions as SamplingOptions
 from typing import Any
 
-__all__ = ['Logfire', 'LogfireSpan', 'LevelName', 'AdvancedOptions', 'ConsoleOptions', 'CodeSource', 'PydanticPlugin', 'configure', 'span', 'instrument', 'log', 'trace', 'debug', 'notice', 'info', 'warn', 'warning', 'error', 'exception', 'fatal', 'force_flush', 'log_slow_async_callbacks', 'install_auto_tracing', 'instrument_asgi', 'instrument_wsgi', 'instrument_pydantic', 'instrument_pydantic_ai', 'instrument_fastapi', 'instrument_openai', 'instrument_openai_agents', 'instrument_anthropic', 'instrument_asyncpg', 'instrument_httpx', 'instrument_celery', 'instrument_requests', 'instrument_psycopg', 'instrument_django', 'instrument_flask', 'instrument_starlette', 'instrument_aiohttp_client', 'instrument_sqlalchemy', 'instrument_sqlite3', 'instrument_aws_lambda', 'instrument_redis', 'instrument_pymongo', 'instrument_mysql', 'instrument_system_metrics', 'instrument_mcp', 'AutoTraceModule', 'with_tags', 'with_settings', 'suppress_scopes', 'shutdown', 'no_auto_trace', 'ScrubMatch', 'ScrubbingOptions', 'VERSION', 'add_non_user_code_prefix', 'suppress_instrumentation', 'StructlogProcessor', 'LogfireLoggingHandler', 'loguru_handler', 'SamplingOptions', 'MetricsOptions', 'logfire_info']
+__all__ = ['Logfire', 'LogfireSpan', 'LevelName', 'AdvancedOptions', 'ConsoleOptions', 'CodeSource', 'PydanticPlugin', 'configure', 'span', 'instrument', 'log', 'trace', 'debug', 'notice', 'info', 'warn', 'warning', 'error', 'exception', 'fatal', 'force_flush', 'log_slow_async_callbacks', 'install_auto_tracing', 'instrument_asgi', 'instrument_wsgi', 'instrument_pydantic', 'instrument_pydantic_ai', 'instrument_fastapi', 'instrument_openai', 'instrument_openai_agents', 'instrument_anthropic', 'instrument_asyncpg', 'instrument_httpx', 'instrument_celery', 'instrument_requests', 'instrument_psycopg', 'instrument_django', 'instrument_flask', 'instrument_starlette', 'instrument_aiohttp_client', 'instrument_aiohttp_server','instrument_sqlalchemy', 'instrument_sqlite3', 'instrument_aws_lambda', 'instrument_redis', 'instrument_pymongo', 'instrument_mysql', 'instrument_system_metrics', 'instrument_mcp', 'AutoTraceModule', 'with_tags', 'with_settings', 'suppress_scopes', 'shutdown', 'no_auto_trace', 'ScrubMatch', 'ScrubbingOptions', 'VERSION', 'add_non_user_code_prefix', 'suppress_instrumentation', 'StructlogProcessor', 'LogfireLoggingHandler', 'loguru_handler', 'SamplingOptions', 'MetricsOptions', 'logfire_info']
 
 DEFAULT_LOGFIRE_INSTANCE = Logfire()
 span = DEFAULT_LOGFIRE_INSTANCE.span
@@ -38,6 +38,7 @@ instrument_django = DEFAULT_LOGFIRE_INSTANCE.instrument_django
 instrument_flask = DEFAULT_LOGFIRE_INSTANCE.instrument_flask
 instrument_starlette = DEFAULT_LOGFIRE_INSTANCE.instrument_starlette
 instrument_aiohttp_client = DEFAULT_LOGFIRE_INSTANCE.instrument_aiohttp_client
+instrument_aiohttp_server = DEFAULT_LOGFIRE_INSTANCE.instrument_aiohttp_server
 instrument_sqlalchemy = DEFAULT_LOGFIRE_INSTANCE.instrument_sqlalchemy
 instrument_sqlite3 = DEFAULT_LOGFIRE_INSTANCE.instrument_sqlite3
 instrument_aws_lambda = DEFAULT_LOGFIRE_INSTANCE.instrument_aws_lambda

logfire-api/logfire_api/_internal/integrations/aiohttp_server.pyi

@@ -0,0 +1,8 @@
+from logfire import Logfire as Logfire
+from typing import Any
+
+def instrument_aiohttp_server(logfire_instance: Logfire, **kwargs: Any):
+    """Instrument the `aiohttp` module so that spans are automatically created for each server request.
+
+    See the `Logfire.instrument_aiohttp_server` method for details.
+    """

logfire-api/logfire_api/_internal/main.pyi

@@ -727,6 +727,13 @@ class Logfire:
         [OpenTelemetry aiohttp client Instrumentation](https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/aiohttp_client/aiohttp_client.html)
         library, specifically `AioHttpClientInstrumentor().instrument()`, to which it passes `**kwargs`.
         """
+    def instrument_aiohttp_server(self, **kwargs: Any) -> None:
+        """Instrument the `aiohttp` module so that spans are automatically created for each server request.
+
+        Uses the
+        [OpenTelemetry aiohttp server Instrumentation](https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/aiohttp_server/aiohttp_server.html)
+        library, specifically `AioHttpServerInstrumentor().instrument()`, to which it passes `**kwargs`.
+        """
     def instrument_sqlalchemy(self, engine: AsyncEngine | Engine | None = None, enable_commenter: bool = False, commenter_options: SQLAlchemyCommenterOptions | None = None, **kwargs: Any) -> None:
         """Instrument the `sqlalchemy` module so that spans are automatically created for each query.
 

logfire/__init__.py

@@ -42,6 +42,7 @@
 instrument_flask = DEFAULT_LOGFIRE_INSTANCE.instrument_flask
 instrument_starlette = DEFAULT_LOGFIRE_INSTANCE.instrument_starlette
 instrument_aiohttp_client = DEFAULT_LOGFIRE_INSTANCE.instrument_aiohttp_client
+instrument_aiohttp_server = DEFAULT_LOGFIRE_INSTANCE.instrument_aiohttp_server
 instrument_sqlalchemy = DEFAULT_LOGFIRE_INSTANCE.instrument_sqlalchemy
 instrument_sqlite3 = DEFAULT_LOGFIRE_INSTANCE.instrument_sqlite3
 instrument_aws_lambda = DEFAULT_LOGFIRE_INSTANCE.instrument_aws_lambda
@@ -132,6 +133,7 @@ def loguru_handler() -> Any:
     'instrument_flask',
     'instrument_starlette',
     'instrument_aiohttp_client',
+    'instrument_aiohttp_server',
     'instrument_sqlalchemy',
     'instrument_sqlite3',
     'instrument_aws_lambda',

logfire/_internal/integrations/aiohttp_client.py

@@ -6,7 +6,7 @@
     raise RuntimeError(
         '`logfire.instrument_aiohttp_client()` requires the `opentelemetry-instrumentation-aiohttp-client` package.\n'
         'You can install this with:\n'
-        "    pip install 'logfire[aiohttp]'"
+        "    pip install 'logfire[aiohttp-client]'"
     )
 from logfire import Logfire