From fde1ef84c7694d4682194c8cb4e22f9dd9974158 Mon Sep 17 00:00:00 2001 From: Andre Murbach Maidl Date: Thu, 6 Mar 2025 13:41:58 -0300 Subject: [PATCH] Add instrumentation example to aiohttp-server (#3311) --- .../aiohttp_server/__init__.py | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/instrumentation/opentelemetry-instrumentation-aiohttp-server/src/opentelemetry/instrumentation/aiohttp_server/__init__.py b/instrumentation/opentelemetry-instrumentation-aiohttp-server/src/opentelemetry/instrumentation/aiohttp_server/__init__.py index 6db7719c7..d445123dc 100644 --- a/instrumentation/opentelemetry-instrumentation-aiohttp-server/src/opentelemetry/instrumentation/aiohttp_server/__init__.py +++ b/instrumentation/opentelemetry-instrumentation-aiohttp-server/src/opentelemetry/instrumentation/aiohttp_server/__init__.py @@ -12,6 +12,31 @@ # See the License for the specific language governing permissions and # limitations under the License. +""" +The opentelemetry-instrumentation-aiohttp-server package allows tracing HTTP +requests made by the aiohttp server library. + +Usage +----- + +.. code:: python + + from aiohttp import web + from opentelemetry.instrumentation.aiohttp_server import ( + AioHttpServerInstrumentor + ) + + AioHttpServerInstrumentor().instrument() + + async def hello(request): + return web.Response(text="Hello, world") + + app = web.Application() + app.add_routes([web.get('/', hello)]) + + web.run_app(app) +""" + import urllib from timeit import default_timer from typing import Dict, List, Tuple, Union