Skip to content

Improves aiohttp_client instrumentation example #3306

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

Merged
merged 2 commits into from
Feb 28, 2025
Merged

Improves aiohttp_client instrumentation example #3306

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93ba819
Improves aiohttp_client code snippet
andremm Feb 27, 2025
1e04f19
Merge branch 'main' into aiohttp-client-snippet
xrmx Feb 28, 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
22 changes: 15 additions & 7 deletions ...strumentation-aiohttp-client/src/opentelemetry/instrumentation/aiohttp_client/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,24 +22,29 @@

.. code:: python

import asyncio
import aiohttp
from opentelemetry.instrumentation.aiohttp_client import create_trace_config
import yarl

def strip_query_params(url: yarl.URL) -> str:
return str(url.with_query(None))

async with aiohttp.ClientSession(trace_configs=[create_trace_config(
async def get(url):
async with aiohttp.ClientSession(trace_configs=[create_trace_config(
# Remove all query params from the URL attribute on the span.
url_filter=strip_query_params,
)]) as session:
async with session.get(url) as response:
await response.text()
)]) as session:
async with session.get(url) as response:
await response.text()

asyncio.run(get("https://example.com"))

Instrumenting all client sessions:

.. code:: python

import asyncio
import aiohttp
from opentelemetry.instrumentation.aiohttp_client import (
AioHttpClientInstrumentor
Expand All @@ -49,9 +54,12 @@ def strip_query_params(url: yarl.URL) -> str:
AioHttpClientInstrumentor().instrument()

# Create a session and make an HTTP get request
async with aiohttp.ClientSession() as session:
async with session.get(url) as response:
await response.text()
async def get(url):
async with aiohttp.ClientSession() as session:
async with session.get(url) as response:
await response.text()

asyncio.run(get("https://example.com"))

Configuration
-------------
Expand Down