Add integration for aiohttp (#13)

Add integration for aiohttp

Author: Cooh12

.github/workflows/ci.yaml

@@ -86,13 +86,15 @@ jobs:
         run: echo "PYTHONPATH=$PWD" >> $GITHUB_ENV
 
       - name: Run tests
-        run: pdm run pytest tests --cov=asgi_monitor --junitxml=junitxml.xml --cov-report "xml:coverage.xml"; exit ${PIPESTATUS[0]}
+        run: pdm run pytest tests --cov=asgi_monitor --junitxml=junitxml.xml --cov-report term --cov-report "xml:coverage.xml"; exit ${PIPESTATUS[0]}
 
       - name: Test coverage comment
         uses: MishaKav/pytest-coverage-comment@main
+        if: github.event_name == 'push' && (github.ref == 'refs/heads/develop' || github.ref == 'refs/heads/master') || github.event_name == 'pull_request' && github.base_ref == 'master'
         with:
           pytest-xml-coverage-path: ./coverage.xml
           junitxml-path: ./junitxml.xml
           junitxml-title: ${{ matrix.python-version }}
           unique-id-for-comment: ${{ matrix.python-version }}
           report-only-changed-files: true
+          create-new-comment: true

CONTRIBUTING.md

@@ -0,0 +1,69 @@
+# Development
+
+After cloning the project, you'll need to set up the development environment. Here are the guidelines on how to do this.
+
+The development workflow should look like this:
+- Add feature/fix bug
+- Run tests
+- Add tests
+- Run tests
+- Lint
+- Add docs
+- Open PR
+
+## Create venv with [PDM](https://pdm-project.org/en/latest/)
+
+```bash
+pdm venv create 3.10
+```
+
+## Activate venv
+
+```bash
+source .venv/bin/activate
+```
+
+## Install dependencies with [just](https://github.com/casey/just)
+
+```bash
+just install
+```
+or
+```bash
+pdm install -G:all
+pip install -r docs/requirements.txt
+pre-commit install
+```
+
+## Running tests
+
+```bash
+just test
+```
+or
+```bash
+pytest tests --cov=asgi_monitor --cov-append --cov-report term-missing -v
+```
+
+## Running lint
+
+```bash
+just lint
+```
+or
+```bash
+pre-commit run --all-files
+```
+
+## Build documentation
+
+```bash
+just doc
+```
+or
+```bash
+sphinx-build -M html docs docs-build
+echo "Open file://`pwd`/docs-build/html/index.html"
+```
+
+## We look forward to your contribution!

README.md

@@ -22,7 +22,7 @@
  - [Prometheus](https://prometheus.io) metrics
  - [OpenTelemetry](https://opentelemetry.io) traces
  - [Structlog](https://www.structlog.org/) logging with native **logging** module support
- - Integrations with [Litestar](https://litestar.dev), [FastAPI](https://fastapi.tiangolo.com) and [Starlette](https://www.starlette.io)
+ - Integrations with [Litestar](https://litestar.dev), [FastAPI](https://fastapi.tiangolo.com), [Starlette](https://www.starlette.io) and [Aiohttp](https://docs.aiohttp.org/en/stable/web.html)
  - Logging support for [Uvicorn](https://www.uvicorn.org) and [Gunicorn](https://gunicorn.org) with custom **UvicornWorker**
 
 > [!IMPORTANT]

docs/integrations/index.rst

@@ -1,6 +1,7 @@
 .. _FastAPI: https://fastapi.tiangolo.com
 .. _Starlette: https://www.starlette.io
 .. _Litestar: https://litestar.dev
+.. _Aiohttp: https://docs.aiohttp.org/en/stable/web.html
 .. _real_world: https://github.com/draincoder/asgi-monitor/tree/master/examples/real_world
 
 .. _integrations:
@@ -13,6 +14,7 @@ Integration with the following frameworks is **now** implemented:
 * FastAPI_
 * Starlette_
 * Litestar_
+* Aiohttp_
 
 But other integrations are planned in the near future, and you can also implement your own through **PR**.
 
@@ -36,8 +38,7 @@ These frameworks have the **same** integration api, so here I will show you how
    import uvicorn
 
 
-
-   def create_app() -> None:
+   def create_app() -> FastAPI:
        configure_logging(level=logging.INFO, json_format=True, include_trace=False)
 
        resource = Resource.create(
@@ -141,3 +142,64 @@ If you want to use **StructlogPlugin** from ``litestar.plugins.structlog`` toget
    :caption: Import processor for extract trace meta
 
    from asgi_monitor.logging.trace_processor import extract_opentelemetry_trace_meta
+
+
+Aiohttp
+====================
+
+Despite the fact that **Aiohttp** does **not support** the **ASGI**-interface, but it is still a popular asynchronous framework and we are happy to support it.
+
+.. code-block:: python
+   :caption: Configuring monitoring for the Aiohttp
+
+   import logging
+
+   from aiohttp.web import Application, run_app
+   from asgi_monitor.integrations.aiohttp import MetricsConfig, TracingConfig, setup_metrics, setup_tracing
+   from asgi_monitor.logging import configure_logging
+   from asgi_monitor.logging.aiohttp import TraceAccessLogger
+   from opentelemetry import trace
+   from opentelemetry.sdk.resources import Resource
+   from opentelemetry.sdk.trace import TracerProvider
+
+   logger = logging.getLogger(__name__)
+
+
+   def create_app() -> Application:
+       configure_logging(level=logging.INFO, json_format=True, include_trace=True)
+
+       resource = Resource.create(
+           attributes={
+               "service.name": "aiohttp",
+           },
+       )
+       tracer_provider = TracerProvider(resource=resource)
+       trace.set_tracer_provider(tracer_provider)
+
+       trace_config = TracingConfig(tracer_provider=tracer_provider)
+       metrics_config = MetricsConfig(app_name="aiohttp")
+
+       app = Application()
+
+       setup_tracing(app=app, config=trace_config)
+       setup_metrics(app=app, config=metrics_config)  # Must be configured last
+
+       return app
+
+
+   if __name__ == "__main__":
+      run_app(create_app(), host="127.0.0.1", port=8000, access_log_class=TraceAccessLogger, access_log=logger)
+
+
+.. important::
+
+   ``TraceAccessLogger`` add trace meta info in aiohttp request log.
+
+
+**Aiohttp** tracing is not **based** on an ``opentelemetry-asgi``, so the ``TracingConfig`` looks like this:
+
+1. ``scope_span_details_extractor`` (**Callable[[Request], tuple[str, dict[str, Any]]]**) - Callback which should return a string and a tuple, representing the desired default span name and a dictionary with any additional span attributes to set.
+
+2. ``meter_provider`` (**MeterProvider | None**) - Optional meter provider to use.
+
+3. ``tracer_provider`` (**TracerProvider | None**) - Optional tracer provider to use.

docs/monitoring/tracing.rst

@@ -29,9 +29,9 @@ Configuration
 
 ``BaseTracingConfig`` is a configuration class for the OpenTelemetry middleware, and it accepts the following arguments as input:
 
-1. ``exclude_urls_env_key`` (**str**) - Key to use when checking whether a list of excluded urls is passed via ENV. Each integration module uses its own ``TracingConfig``, where the default value of the **metrics_prefix** corresponds to the name of the integration.
+1. ``exclude_urls_env_key`` (**str**) - Key to use when checking whether a list of excluded urls is passed via ENV. Each integration module uses its own ``TracingConfig``.
 
-2. ``scope_span_details_extractor`` (**Callable[[Any], tuple[str, dict[str, Any]]]**) - Callback which should return a string and a tuple, representing the desired default span name and a dictionary with any additional span attributes to set. Each integration module uses its own ``TracingConfig``, where the default value of the **metrics_prefix** corresponds to the name of the integration.
+2. ``scope_span_details_extractor`` (**Callable[[Any], tuple[str, dict[str, Any]]]**) - Callback which should return a string and a tuple, representing the desired default span name and a dictionary with any additional span attributes to set. Each integration module uses its own ``TracingConfig``.
 
 3. ``server_request_hook_handler`` (**Callable[[Span, dict], None] | None**) - Optional callback which is called with the server span and ASGI scope object for every incoming request.
 

examples/aiohttp_app.py

@@ -0,0 +1,49 @@
+import asyncio
+import logging
+from datetime import datetime, timezone
+
+from aiohttp.web import Application, Request, Response, run_app
+from opentelemetry import trace
+from opentelemetry.sdk.resources import Resource
+from opentelemetry.sdk.trace import TracerProvider
+
+from asgi_monitor.integrations.aiohttp import MetricsConfig, TracingConfig, setup_metrics, setup_tracing
+from asgi_monitor.logging import configure_logging
+from asgi_monitor.logging.aiohttp import TraceAccessLogger
+
+logger = logging.getLogger(__name__)
+
+
+async def index(requests: Request) -> Response:
+    logger.info("Start sleeping at %s", datetime.now(tz=timezone.utc))
+    await asyncio.sleep(1)
+    logger.info("Stopped sleeping at %s", datetime.now(tz=timezone.utc))
+    return Response(text="OK")
+
+
+def create_app() -> Application:
+    configure_logging(json_format=False, include_trace=True)
+
+    app = Application()
+    app.router.add_get("/", index)
+
+    resource = Resource.create(
+        attributes={
+            "service.name": "aiohttp",
+        },
+    )
+    tracer_provider = TracerProvider(resource=resource)
+    trace.set_tracer_provider(tracer_provider)
+
+    trace_config = TracingConfig(tracer_provider=tracer_provider)
+    metrics_config = MetricsConfig(app_name="aiohttp")
+
+    setup_tracing(app=app, config=trace_config)
+    setup_metrics(app=app, config=metrics_config)
+
+    return app
+
+
+if __name__ == "__main__":
+    app = create_app()
+    run_app(app=app, host="127.0.0.1", port=8000, access_log_class=TraceAccessLogger, access_log=logger)