feat(aiohttp): add instrumentation of client requests#1761

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
sentrivana merged 6 commits into from
Jun 28, 2023
Merged

feat(aiohttp): add instrumentation of client requests #1761

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
56dd6fc
feat(aiohttp): add instrumentation of client requests
Nov 28, 2022
ec10c10
fix: fix mypy errors and switch comment-style type hints
Feb 28, 2023
cfbfd26
fix: review 1 changes
Jun 22, 2023
7c0945d
fix: url data and tests
Jun 22, 2023
5e3021b
fix: fix existing tests which failed because client is now instrument…
Jun 22, 2023
ac5a45c
fix: review 2 changes
Jun 23, 2023
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
79 changes: 78 additions & 1 deletion sentry_sdk/integrations/aiohttp.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@

from sentry_sdk.api import continue_trace
from sentry_sdk._compat import reraise
from sentry_sdk.consts import OP
from sentry_sdk.consts import OP, SPANDATA
from sentry_sdk.hub import Hub
from sentry_sdk.integrations import Integration, DidNotEnable
from sentry_sdk.integrations.logging import ignore_logger
Expand All@@ -13,20 +13,25 @@
request_body_within_bounds,
)
from sentry_sdk.tracing import SOURCE_FOR_STYLE, TRANSACTION_SOURCE_ROUTE
from sentry_sdk.tracing_utils import should_propagate_trace
from sentry_sdk.utils import (
capture_internal_exceptions,
event_from_exception,
logger,
parse_url,
parse_version,
transaction_from_function,
HAS_REAL_CONTEXTVARS,
CONTEXTVARS_ERROR_MESSAGE,
SENSITIVE_DATA_SUBSTITUTE,
AnnotatedValue,
)

try:
import asyncio

from aiohttp import __version__ as AIOHTTP_VERSION
from aiohttp import ClientSession, TraceConfig
from aiohttp.web import Application, HTTPException, UrlDispatcher
except ImportError:
raise DidNotEnable("AIOHTTP not installed")
Expand All@@ -36,6 +41,8 @@
if TYPE_CHECKING:
from aiohttp.web_request import Request
from aiohttp.abc import AbstractMatchInfo
from aiohttp import TraceRequestStartParams, TraceRequestEndParams
from types import SimpleNamespace
from typing import Any
from typing import Dict
from typing import Optional
Expand DownExpand Up@@ -164,6 +171,76 @@ async def sentry_urldispatcher_resolve(self, request):

UrlDispatcher.resolve = sentry_urldispatcher_resolve

old_client_session_init = ClientSession.__init__

def init(*args, **kwargs):
# type: (Any, Any) -> ClientSession
hub = Hub.current
if hub.get_integration(AioHttpIntegration) is None:
return old_client_session_init(*args, **kwargs)

client_trace_configs = list(kwargs.get("trace_configs", ()))
trace_config = create_trace_config()
client_trace_configs.append(trace_config)

kwargs["trace_configs"] = client_trace_configs
return old_client_session_init(*args, **kwargs)

ClientSession.__init__ = init


def create_trace_config():
# type: () -> TraceConfig
async def on_request_start(session, trace_config_ctx, params):
# type: (ClientSession, SimpleNamespace, TraceRequestStartParams) -> None
hub = Hub.current
if hub.get_integration(AioHttpIntegration) is None:
return

method = params.method.upper()

parsed_url = None
with capture_internal_exceptions():
parsed_url = parse_url(str(params.url), sanitize=False)

span = hub.start_span(
op=OP.HTTP_CLIENT,
description="%s %s"
% (method, parsed_url.url if parsed_url else SENSITIVE_DATA_SUBSTITUTE),
)
span.set_data(SPANDATA.HTTP_METHOD, method)
span.set_data("url", parsed_url.url)
span.set_data(SPANDATA.HTTP_QUERY, parsed_url.query)
span.set_data(SPANDATA.HTTP_FRAGMENT, parsed_url.fragment)

if should_propagate_trace(hub, str(params.url)):
for key, value in hub.iter_trace_propagation_headers(span):
logger.debug(
"[Tracing] Adding `{key}` header {value} to outgoing request to {url}.".format(
key=key, value=value, url=params.url
)
)
params.headers[key] = value

trace_config_ctx.span = span

async def on_request_end(session, trace_config_ctx, params):
# type: (ClientSession, SimpleNamespace, TraceRequestEndParams) -> None
if trace_config_ctx.span is None:
return

span = trace_config_ctx.span
span.set_http_status(int(params.response.status))
span.set_data("reason", params.response.reason)
span.finish()

trace_config = TraceConfig()

trace_config.on_request_start.append(on_request_start)
trace_config.on_request_end.append(on_request_end)

return trace_config


def _make_request_processor(weak_request):
# type: (Callable[[], Request]) -> EventProcessor
Expand Down
96 changes: 87 additions & 9 deletions tests/integrations/aiohttp/test_aiohttp.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
from aiohttp.client import ServerDisconnectedError
from aiohttp.web_request import Request

from sentry_sdk import capture_message
from sentry_sdk import capture_message, start_transaction
from sentry_sdk.integrations.aiohttp import AioHttpIntegration

try:
Expand DownExpand Up@@ -54,6 +54,8 @@ async def hello(request):
"Accept-Encoding": "gzip, deflate",
"Host": host,
"User-Agent": request["headers"]["User-Agent"],
"baggage": mock.ANY,
"sentry-trace": mock.ANY,
}


Expand DownExpand Up@@ -372,11 +374,13 @@ async def hello(request):

events = capture_events()

trace_id = "582b43a4192642f0b136d5159a501701"
sentry_trace_header = "{}-{}-{}".format(trace_id, "6e8f22c393e68f19", 1)

# The aiohttp_client is instrumented so will generate the sentry-trace header and add request.
# Get the sentry-trace header from the request so we can later compare with transaction events.
client = await aiohttp_client(app)
resp = await client.get("/", headers={"sentry-trace": sentry_trace_header})
resp = await client.get("/")
sentry_trace_header = resp.request_info.headers.get("sentry-trace")
trace_id = sentry_trace_header.split("-")[0]

assert resp.status == 500

msg_event, error_event, transaction_event = events
Expand DownExpand Up@@ -410,11 +414,13 @@ async def hello(request):

events = capture_events()

trace_id = "582b43a4192642f0b136d5159a501701"
sentry_trace_header = "{}-{}-{}".format(trace_id, "6e8f22c393e68f19", 1)

# The aiohttp_client is instrumented so will generate the sentry-trace header and add request.
# Get the sentry-trace header from the request so we can later compare with transaction events.
client = await aiohttp_client(app)
resp = await client.get("/", headers={"sentry-trace": sentry_trace_header})
resp = await client.get("/")
sentry_trace_header = resp.request_info.headers.get("sentry-trace")
trace_id = sentry_trace_header.split("-")[0]

assert resp.status == 500

msg_event, error_event = events
Expand All@@ -427,3 +433,75 @@ async def hello(request):

assert msg_event["contexts"]["trace"]["trace_id"] == trace_id
assert error_event["contexts"]["trace"]["trace_id"] == trace_id


@pytest.mark.asyncio
async def test_crumb_capture(
sentry_init, aiohttp_raw_server, aiohttp_client, loop, capture_events
):
def before_breadcrumb(crumb, hint):
crumb["data"]["extra"] = "foo"
return crumb

sentry_init(
integrations=[AioHttpIntegration()], before_breadcrumb=before_breadcrumb
)

async def handler(request):
return web.Response(text="OK")

raw_server = await aiohttp_raw_server(handler)

with start_transaction():
events = capture_events()

client = await aiohttp_client(raw_server)
resp = await client.get("/")
assert resp.status == 200
capture_message("Testing!")

(event,) = events

crumb = event["breadcrumbs"]["values"][0]
assert crumb["type"] == "http"
assert crumb["category"] == "httplib"
assert crumb["data"] == {
"url": "http://127.0.0.1:{}/".format(raw_server.port),
"http.fragment": "",
"http.method": "GET",
"http.query": "",
"http.response.status_code": 200,
"reason": "OK",
"extra": "foo",
}


@pytest.mark.asyncio
async def test_outgoing_trace_headers(sentry_init, aiohttp_raw_server, aiohttp_client):
sentry_init(
integrations=[AioHttpIntegration()],
traces_sample_rate=1.0,
)

async def handler(request):
return web.Response(text="OK")

raw_server = await aiohttp_raw_server(handler)

with start_transaction(
name="/interactions/other-dogs/new-dog",
op="greeting.sniff",
# make trace_id difference between transactions
trace_id="0123456789012345678901234567890",
) as transaction:
client = await aiohttp_client(raw_server)
resp = await client.get("/")
request_span = transaction._span_recorder.spans[-1]

assert resp.request_info.headers[
"sentry-trace"
] == "{trace_id}-{parent_span_id}-{sampled}".format(
trace_id=transaction.trace_id,
parent_span_id=request_span.span_id,
sampled=1,
)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(aiohttp): add instrumentation of client requests#1761

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

sentrivana
merged 6 commits into

from

Jun 28, 2023
 Merged


feat(aiohttp): add instrumentation of client requests
#1761
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
56dd6fc

feat(aiohttp): add instrumentation of client requests

Nov 28, 2022
ec10c10

fix: fix mypy errors and switch comment-style type hints

Feb 28, 2023
cfbfd26

fix: review 1 changes

Jun 22, 2023
7c0945d

fix: url data and tests

Jun 22, 2023
5e3021b

fix: fix existing tests which failed because client is now instrument…

Jun 22, 2023
ac5a45c

fix: review 2 changes

Jun 23, 2023

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


79 changes: 78 additions & 1 deletion
sentry_sdk/integrations/aiohttp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@

from sentry_sdk.api import continue_trace
from sentry_sdk._compat import reraise
from sentry_sdk.consts import OP
from sentry_sdk.consts import OP, SPANDATA
from sentry_sdk.hub import Hub
from sentry_sdk.integrations import Integration, DidNotEnable
from sentry_sdk.integrations.logging import ignore_logger
Expand All@@ -13,20 +13,25 @@
 request_body_within_bounds,
)
from sentry_sdk.tracing import SOURCE_FOR_STYLE, TRANSACTION_SOURCE_ROUTE
from sentry_sdk.tracing_utils import should_propagate_trace
from sentry_sdk.utils import (
 capture_internal_exceptions,
 event_from_exception,
 logger,
 parse_url,
 parse_version,
 transaction_from_function,
 HAS_REAL_CONTEXTVARS,
 CONTEXTVARS_ERROR_MESSAGE,
 SENSITIVE_DATA_SUBSTITUTE,
 AnnotatedValue,
)

try:
 import asyncio

 from aiohttp import __version__ as AIOHTTP_VERSION
 from aiohttp import ClientSession, TraceConfig
 from aiohttp.web import Application, HTTPException, UrlDispatcher
except ImportError:
 raise DidNotEnable("AIOHTTP not installed")
Expand All@@ -36,6 +41,8 @@
if TYPE_CHECKING:
 from aiohttp.web_request import Request
 from aiohttp.abc import AbstractMatchInfo
 from aiohttp import TraceRequestStartParams, TraceRequestEndParams
 from types import SimpleNamespace
 from typing import Any
 from typing import Dict
 from typing import Optional
Expand DownExpand Up@@ -164,6 +171,76 @@ async def sentry_urldispatcher_resolve(self, request):

 UrlDispatcher.resolve = sentry_urldispatcher_resolve

 old_client_session_init = ClientSession.__init__

 def init(*args, **kwargs):
 # type: (Any, Any) -> ClientSession
 hub = Hub.current
 if hub.get_integration(AioHttpIntegration) is None:
 return old_client_session_init(*args, **kwargs)

 client_trace_configs = list(kwargs.get("trace_configs", ()))
 trace_config = create_trace_config()
 client_trace_configs.append(trace_config)

 kwargs["trace_configs"] = client_trace_configs
 return old_client_session_init(*args, **kwargs)

 ClientSession.__init__ = init


def create_trace_config():
 # type: () -> TraceConfig
 async def on_request_start(session, trace_config_ctx, params):
 # type: (ClientSession, SimpleNamespace, TraceRequestStartParams) -> None
 hub = Hub.current
 if hub.get_integration(AioHttpIntegration) is None:
 return

 method = params.method.upper()

 parsed_url = None
 with capture_internal_exceptions():
 parsed_url = parse_url(str(params.url), sanitize=False)

 span = hub.start_span(
 op=OP.HTTP_CLIENT,
 description="%s %s"
 % (method, parsed_url.url if parsed_url else SENSITIVE_DATA_SUBSTITUTE),
 )
 span.set_data(SPANDATA.HTTP_METHOD, method)
 span.set_data("url", parsed_url.url)
 span.set_data(SPANDATA.HTTP_QUERY, parsed_url.query)
 span.set_data(SPANDATA.HTTP_FRAGMENT, parsed_url.fragment)

 if should_propagate_trace(hub, str(params.url)):
 for key, value in hub.iter_trace_propagation_headers(span):
 logger.debug(
 "[Tracing] Adding `{key}` header {value} to outgoing request to {url}.".format(
 key=key, value=value, url=params.url
 )
 )
 params.headers[key] = value

 trace_config_ctx.span = span

 async def on_request_end(session, trace_config_ctx, params):
 # type: (ClientSession, SimpleNamespace, TraceRequestEndParams) -> None
 if trace_config_ctx.span is None:
 return

 span = trace_config_ctx.span
 span.set_http_status(int(params.response.status))
 span.set_data("reason", params.response.reason)
 span.finish()

 trace_config = TraceConfig()

 trace_config.on_request_start.append(on_request_start)
 trace_config.on_request_end.append(on_request_end)

 return trace_config


def _make_request_processor(weak_request):
 # type: (Callable[[], Request]) -> EventProcessor
Expand Down

96 changes: 87 additions & 9 deletions
tests/integrations/aiohttp/test_aiohttp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
from aiohttp.client import ServerDisconnectedError
from aiohttp.web_request import Request

from sentry_sdk import capture_message
from sentry_sdk import capture_message, start_transaction
from sentry_sdk.integrations.aiohttp import AioHttpIntegration

try:
Expand DownExpand Up@@ -54,6 +54,8 @@ async def hello(request):
 "Accept-Encoding": "gzip, deflate",
 "Host": host,
 "User-Agent": request["headers"]["User-Agent"],
 "baggage": mock.ANY,
 "sentry-trace": mock.ANY,
 }


Expand DownExpand Up@@ -372,11 +374,13 @@ async def hello(request):

 events = capture_events()

 trace_id = "582b43a4192642f0b136d5159a501701"
 sentry_trace_header = "{}-{}-{}".format(trace_id, "6e8f22c393e68f19", 1)

 # The aiohttp_client is instrumented so will generate the sentry-trace header and add request.
 # Get the sentry-trace header from the request so we can later compare with transaction events.
 client = await aiohttp_client(app)
 resp = await client.get("/", headers={"sentry-trace": sentry_trace_header})
 resp = await client.get("/")
 sentry_trace_header = resp.request_info.headers.get("sentry-trace")
 trace_id = sentry_trace_header.split("-")[0]

 assert resp.status == 500

 msg_event, error_event, transaction_event = events
Expand DownExpand Up@@ -410,11 +414,13 @@ async def hello(request):

 events = capture_events()

 trace_id = "582b43a4192642f0b136d5159a501701"
 sentry_trace_header = "{}-{}-{}".format(trace_id, "6e8f22c393e68f19", 1)

 # The aiohttp_client is instrumented so will generate the sentry-trace header and add request.
 # Get the sentry-trace header from the request so we can later compare with transaction events.
 client = await aiohttp_client(app)
 resp = await client.get("/", headers={"sentry-trace": sentry_trace_header})
 resp = await client.get("/")
 sentry_trace_header = resp.request_info.headers.get("sentry-trace")
 trace_id = sentry_trace_header.split("-")[0]

 assert resp.status == 500

 msg_event, error_event = events
Expand All@@ -427,3 +433,75 @@ async def hello(request):

 assert msg_event["contexts"]["trace"]["trace_id"] == trace_id
 assert error_event["contexts"]["trace"]["trace_id"] == trace_id


@pytest.mark.asyncio
async def test_crumb_capture(
 sentry_init, aiohttp_raw_server, aiohttp_client, loop, capture_events
):
 def before_breadcrumb(crumb, hint):
 crumb["data"]["extra"] = "foo"
 return crumb

 sentry_init(
 integrations=[AioHttpIntegration()], before_breadcrumb=before_breadcrumb
 )

 async def handler(request):
 return web.Response(text="OK")

 raw_server = await aiohttp_raw_server(handler)

 with start_transaction():
 events = capture_events()

 client = await aiohttp_client(raw_server)
 resp = await client.get("/")
 assert resp.status == 200
 capture_message("Testing!")

 (event,) = events

 crumb = event["breadcrumbs"]["values"][0]
 assert crumb["type"] == "http"
 assert crumb["category"] == "httplib"
 assert crumb["data"] == {
 "url": "http://127.0.0.1:{}/".format(raw_server.port),
 "http.fragment": "",
 "http.method": "GET",
 "http.query": "",
 "http.response.status_code": 200,
 "reason": "OK",
 "extra": "foo",
 }


@pytest.mark.asyncio
async def test_outgoing_trace_headers(sentry_init, aiohttp_raw_server, aiohttp_client):
 sentry_init(
 integrations=[AioHttpIntegration()],
 traces_sample_rate=1.0,
 )

 async def handler(request):
 return web.Response(text="OK")

 raw_server = await aiohttp_raw_server(handler)

 with start_transaction(
 name="/interactions/other-dogs/new-dog",
 op="greeting.sniff",
 # make trace_id difference between transactions
 trace_id="0123456789012345678901234567890",
 ) as transaction:
 client = await aiohttp_client(raw_server)
 resp = await client.get("/")
 request_span = transaction._span_recorder.spans[-1]

 assert resp.request_info.headers[
 "sentry-trace"
 ] == "{trace_id}-{parent_span_id}-{sampled}".format(
 trace_id=transaction.trace_id,
 parent_span_id=request_span.span_id,
 sampled=1,
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(aiohttp): add instrumentation of client requests#1761

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

sentrivana
merged 6 commits into

from

Jun 28, 2023
 Merged


feat(aiohttp): add instrumentation of client requests
#1761
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
56dd6fc

feat(aiohttp): add instrumentation of client requests

Nov 28, 2022
ec10c10

fix: fix mypy errors and switch comment-style type hints

Feb 28, 2023
cfbfd26

fix: review 1 changes

Jun 22, 2023
7c0945d

fix: url data and tests

Jun 22, 2023
5e3021b

fix: fix existing tests which failed because client is now instrument…

Jun 22, 2023
ac5a45c

fix: review 2 changes

Jun 23, 2023

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


79 changes: 78 additions & 1 deletion
sentry_sdk/integrations/aiohttp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@

from sentry_sdk.api import continue_trace
from sentry_sdk._compat import reraise
from sentry_sdk.consts import OP
from sentry_sdk.consts import OP, SPANDATA
from sentry_sdk.hub import Hub
from sentry_sdk.integrations import Integration, DidNotEnable
from sentry_sdk.integrations.logging import ignore_logger
Expand All@@ -13,20 +13,25 @@
 request_body_within_bounds,
)
from sentry_sdk.tracing import SOURCE_FOR_STYLE, TRANSACTION_SOURCE_ROUTE
from sentry_sdk.tracing_utils import should_propagate_trace
from sentry_sdk.utils import (
 capture_internal_exceptions,
 event_from_exception,
 logger,
 parse_url,
 parse_version,
 transaction_from_function,
 HAS_REAL_CONTEXTVARS,
 CONTEXTVARS_ERROR_MESSAGE,
 SENSITIVE_DATA_SUBSTITUTE,
 AnnotatedValue,
)

try:
 import asyncio

 from aiohttp import __version__ as AIOHTTP_VERSION
 from aiohttp import ClientSession, TraceConfig
 from aiohttp.web import Application, HTTPException, UrlDispatcher
except ImportError:
 raise DidNotEnable("AIOHTTP not installed")
Expand All@@ -36,6 +41,8 @@
if TYPE_CHECKING:
 from aiohttp.web_request import Request
 from aiohttp.abc import AbstractMatchInfo
 from aiohttp import TraceRequestStartParams, TraceRequestEndParams
 from types import SimpleNamespace
 from typing import Any
 from typing import Dict
 from typing import Optional
Expand DownExpand Up@@ -164,6 +171,76 @@ async def sentry_urldispatcher_resolve(self, request):

 UrlDispatcher.resolve = sentry_urldispatcher_resolve

 old_client_session_init = ClientSession.__init__

 def init(*args, **kwargs):
 # type: (Any, Any) -> ClientSession
 hub = Hub.current
 if hub.get_integration(AioHttpIntegration) is None:
 return old_client_session_init(*args, **kwargs)

 client_trace_configs = list(kwargs.get("trace_configs", ()))
 trace_config = create_trace_config()
 client_trace_configs.append(trace_config)

 kwargs["trace_configs"] = client_trace_configs
 return old_client_session_init(*args, **kwargs)

 ClientSession.__init__ = init


def create_trace_config():
 # type: () -> TraceConfig
 async def on_request_start(session, trace_config_ctx, params):
 # type: (ClientSession, SimpleNamespace, TraceRequestStartParams) -> None
 hub = Hub.current
 if hub.get_integration(AioHttpIntegration) is None:
 return

 method = params.method.upper()

 parsed_url = None
 with capture_internal_exceptions():
 parsed_url = parse_url(str(params.url), sanitize=False)

 span = hub.start_span(
 op=OP.HTTP_CLIENT,
 description="%s %s"
 % (method, parsed_url.url if parsed_url else SENSITIVE_DATA_SUBSTITUTE),
 )
 span.set_data(SPANDATA.HTTP_METHOD, method)
 span.set_data("url", parsed_url.url)
 span.set_data(SPANDATA.HTTP_QUERY, parsed_url.query)
 span.set_data(SPANDATA.HTTP_FRAGMENT, parsed_url.fragment)

 if should_propagate_trace(hub, str(params.url)):
 for key, value in hub.iter_trace_propagation_headers(span):
 logger.debug(
 "[Tracing] Adding `{key}` header {value} to outgoing request to {url}.".format(
 key=key, value=value, url=params.url
 )
 )
 params.headers[key] = value

 trace_config_ctx.span = span

 async def on_request_end(session, trace_config_ctx, params):
 # type: (ClientSession, SimpleNamespace, TraceRequestEndParams) -> None
 if trace_config_ctx.span is None:
 return

 span = trace_config_ctx.span
 span.set_http_status(int(params.response.status))
 span.set_data("reason", params.response.reason)
 span.finish()

 trace_config = TraceConfig()

 trace_config.on_request_start.append(on_request_start)
 trace_config.on_request_end.append(on_request_end)

 return trace_config


def _make_request_processor(weak_request):
 # type: (Callable[[], Request]) -> EventProcessor
Expand Down

96 changes: 87 additions & 9 deletions
tests/integrations/aiohttp/test_aiohttp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
from aiohttp.client import ServerDisconnectedError
from aiohttp.web_request import Request

from sentry_sdk import capture_message
from sentry_sdk import capture_message, start_transaction
from sentry_sdk.integrations.aiohttp import AioHttpIntegration

try:
Expand DownExpand Up@@ -54,6 +54,8 @@ async def hello(request):
 "Accept-Encoding": "gzip, deflate",
 "Host": host,
 "User-Agent": request["headers"]["User-Agent"],
 "baggage": mock.ANY,
 "sentry-trace": mock.ANY,
 }


Expand DownExpand Up@@ -372,11 +374,13 @@ async def hello(request):

 events = capture_events()

 trace_id = "582b43a4192642f0b136d5159a501701"
 sentry_trace_header = "{}-{}-{}".format(trace_id, "6e8f22c393e68f19", 1)

 # The aiohttp_client is instrumented so will generate the sentry-trace header and add request.
 # Get the sentry-trace header from the request so we can later compare with transaction events.
 client = await aiohttp_client(app)
 resp = await client.get("/", headers={"sentry-trace": sentry_trace_header})
 resp = await client.get("/")
 sentry_trace_header = resp.request_info.headers.get("sentry-trace")
 trace_id = sentry_trace_header.split("-")[0]

 assert resp.status == 500

 msg_event, error_event, transaction_event = events
Expand DownExpand Up@@ -410,11 +414,13 @@ async def hello(request):

 events = capture_events()

 trace_id = "582b43a4192642f0b136d5159a501701"
 sentry_trace_header = "{}-{}-{}".format(trace_id, "6e8f22c393e68f19", 1)

 # The aiohttp_client is instrumented so will generate the sentry-trace header and add request.
 # Get the sentry-trace header from the request so we can later compare with transaction events.
 client = await aiohttp_client(app)
 resp = await client.get("/", headers={"sentry-trace": sentry_trace_header})
 resp = await client.get("/")
 sentry_trace_header = resp.request_info.headers.get("sentry-trace")
 trace_id = sentry_trace_header.split("-")[0]

 assert resp.status == 500

 msg_event, error_event = events
Expand All@@ -427,3 +433,75 @@ async def hello(request):

 assert msg_event["contexts"]["trace"]["trace_id"] == trace_id
 assert error_event["contexts"]["trace"]["trace_id"] == trace_id


@pytest.mark.asyncio
async def test_crumb_capture(
 sentry_init, aiohttp_raw_server, aiohttp_client, loop, capture_events
):
 def before_breadcrumb(crumb, hint):
 crumb["data"]["extra"] = "foo"
 return crumb

 sentry_init(
 integrations=[AioHttpIntegration()], before_breadcrumb=before_breadcrumb
 )

 async def handler(request):
 return web.Response(text="OK")

 raw_server = await aiohttp_raw_server(handler)

 with start_transaction():
 events = capture_events()

 client = await aiohttp_client(raw_server)
 resp = await client.get("/")
 assert resp.status == 200
 capture_message("Testing!")

 (event,) = events

 crumb = event["breadcrumbs"]["values"][0]
 assert crumb["type"] == "http"
 assert crumb["category"] == "httplib"
 assert crumb["data"] == {
 "url": "http://127.0.0.1:{}/".format(raw_server.port),
 "http.fragment": "",
 "http.method": "GET",
 "http.query": "",
 "http.response.status_code": 200,
 "reason": "OK",
 "extra": "foo",
 }


@pytest.mark.asyncio
async def test_outgoing_trace_headers(sentry_init, aiohttp_raw_server, aiohttp_client):
 sentry_init(
 integrations=[AioHttpIntegration()],
 traces_sample_rate=1.0,
 )

 async def handler(request):
 return web.Response(text="OK")

 raw_server = await aiohttp_raw_server(handler)

 with start_transaction(
 name="/interactions/other-dogs/new-dog",
 op="greeting.sniff",
 # make trace_id difference between transactions
 trace_id="0123456789012345678901234567890",
 ) as transaction:
 client = await aiohttp_client(raw_server)
 resp = await client.get("/")
 request_span = transaction._span_recorder.spans[-1]

 assert resp.request_info.headers[
 "sentry-trace"
 ] == "{trace_id}-{parent_span_id}-{sampled}".format(
 trace_id=transaction.trace_id,
 parent_span_id=request_span.span_id,
 sampled=1,
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(aiohttp): add instrumentation of client requests#1761

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

sentrivana
merged 6 commits into

from

Jun 28, 2023
 Merged


feat(aiohttp): add instrumentation of client requests
#1761
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
56dd6fc

feat(aiohttp): add instrumentation of client requests

Nov 28, 2022
ec10c10

fix: fix mypy errors and switch comment-style type hints

Feb 28, 2023
cfbfd26

fix: review 1 changes

Jun 22, 2023
7c0945d

fix: url data and tests

Jun 22, 2023
5e3021b

fix: fix existing tests which failed because client is now instrument…

Jun 22, 2023
ac5a45c

fix: review 2 changes

Jun 23, 2023

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


79 changes: 78 additions & 1 deletion
sentry_sdk/integrations/aiohttp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@

from sentry_sdk.api import continue_trace
from sentry_sdk._compat import reraise
from sentry_sdk.consts import OP
from sentry_sdk.consts import OP, SPANDATA
from sentry_sdk.hub import Hub
from sentry_sdk.integrations import Integration, DidNotEnable
from sentry_sdk.integrations.logging import ignore_logger
Expand All@@ -13,20 +13,25 @@
 request_body_within_bounds,
)
from sentry_sdk.tracing import SOURCE_FOR_STYLE, TRANSACTION_SOURCE_ROUTE
from sentry_sdk.tracing_utils import should_propagate_trace
from sentry_sdk.utils import (
 capture_internal_exceptions,
 event_from_exception,
 logger,
 parse_url,
 parse_version,
 transaction_from_function,
 HAS_REAL_CONTEXTVARS,
 CONTEXTVARS_ERROR_MESSAGE,
 SENSITIVE_DATA_SUBSTITUTE,
 AnnotatedValue,
)

try:
 import asyncio

 from aiohttp import __version__ as AIOHTTP_VERSION
 from aiohttp import ClientSession, TraceConfig
 from aiohttp.web import Application, HTTPException, UrlDispatcher
except ImportError:
 raise DidNotEnable("AIOHTTP not installed")
Expand All@@ -36,6 +41,8 @@
if TYPE_CHECKING:
 from aiohttp.web_request import Request
 from aiohttp.abc import AbstractMatchInfo
 from aiohttp import TraceRequestStartParams, TraceRequestEndParams
 from types import SimpleNamespace
 from typing import Any
 from typing import Dict
 from typing import Optional
Expand DownExpand Up@@ -164,6 +171,76 @@ async def sentry_urldispatcher_resolve(self, request):

 UrlDispatcher.resolve = sentry_urldispatcher_resolve

 old_client_session_init = ClientSession.__init__

 def init(*args, **kwargs):
 # type: (Any, Any) -> ClientSession
 hub = Hub.current
 if hub.get_integration(AioHttpIntegration) is None:
 return old_client_session_init(*args, **kwargs)

 client_trace_configs = list(kwargs.get("trace_configs", ()))
 trace_config = create_trace_config()
 client_trace_configs.append(trace_config)

 kwargs["trace_configs"] = client_trace_configs
 return old_client_session_init(*args, **kwargs)

 ClientSession.__init__ = init


def create_trace_config():
 # type: () -> TraceConfig
 async def on_request_start(session, trace_config_ctx, params):
 # type: (ClientSession, SimpleNamespace, TraceRequestStartParams) -> None
 hub = Hub.current
 if hub.get_integration(AioHttpIntegration) is None:
 return

 method = params.method.upper()

 parsed_url = None
 with capture_internal_exceptions():
 parsed_url = parse_url(str(params.url), sanitize=False)

 span = hub.start_span(
 op=OP.HTTP_CLIENT,
 description="%s %s"
 % (method, parsed_url.url if parsed_url else SENSITIVE_DATA_SUBSTITUTE),
 )
 span.set_data(SPANDATA.HTTP_METHOD, method)
 span.set_data("url", parsed_url.url)
 span.set_data(SPANDATA.HTTP_QUERY, parsed_url.query)
 span.set_data(SPANDATA.HTTP_FRAGMENT, parsed_url.fragment)

 if should_propagate_trace(hub, str(params.url)):
 for key, value in hub.iter_trace_propagation_headers(span):
 logger.debug(
 "[Tracing] Adding `{key}` header {value} to outgoing request to {url}.".format(
 key=key, value=value, url=params.url
 )
 )
 params.headers[key] = value

 trace_config_ctx.span = span

 async def on_request_end(session, trace_config_ctx, params):
 # type: (ClientSession, SimpleNamespace, TraceRequestEndParams) -> None
 if trace_config_ctx.span is None:
 return

 span = trace_config_ctx.span
 span.set_http_status(int(params.response.status))
 span.set_data("reason", params.response.reason)
 span.finish()

 trace_config = TraceConfig()

 trace_config.on_request_start.append(on_request_start)
 trace_config.on_request_end.append(on_request_end)

 return trace_config


def _make_request_processor(weak_request):
 # type: (Callable[[], Request]) -> EventProcessor
Expand Down

96 changes: 87 additions & 9 deletions
tests/integrations/aiohttp/test_aiohttp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
from aiohttp.client import ServerDisconnectedError
from aiohttp.web_request import Request

from sentry_sdk import capture_message
from sentry_sdk import capture_message, start_transaction
from sentry_sdk.integrations.aiohttp import AioHttpIntegration

try:
Expand DownExpand Up@@ -54,6 +54,8 @@ async def hello(request):
 "Accept-Encoding": "gzip, deflate",
 "Host": host,
 "User-Agent": request["headers"]["User-Agent"],
 "baggage": mock.ANY,
 "sentry-trace": mock.ANY,
 }


Expand DownExpand Up@@ -372,11 +374,13 @@ async def hello(request):

 events = capture_events()

 trace_id = "582b43a4192642f0b136d5159a501701"
 sentry_trace_header = "{}-{}-{}".format(trace_id, "6e8f22c393e68f19", 1)

 # The aiohttp_client is instrumented so will generate the sentry-trace header and add request.
 # Get the sentry-trace header from the request so we can later compare with transaction events.
 client = await aiohttp_client(app)
 resp = await client.get("/", headers={"sentry-trace": sentry_trace_header})
 resp = await client.get("/")
 sentry_trace_header = resp.request_info.headers.get("sentry-trace")
 trace_id = sentry_trace_header.split("-")[0]

 assert resp.status == 500

 msg_event, error_event, transaction_event = events
Expand DownExpand Up@@ -410,11 +414,13 @@ async def hello(request):

 events = capture_events()

 trace_id = "582b43a4192642f0b136d5159a501701"
 sentry_trace_header = "{}-{}-{}".format(trace_id, "6e8f22c393e68f19", 1)

 # The aiohttp_client is instrumented so will generate the sentry-trace header and add request.
 # Get the sentry-trace header from the request so we can later compare with transaction events.
 client = await aiohttp_client(app)
 resp = await client.get("/", headers={"sentry-trace": sentry_trace_header})
 resp = await client.get("/")
 sentry_trace_header = resp.request_info.headers.get("sentry-trace")
 trace_id = sentry_trace_header.split("-")[0]

 assert resp.status == 500

 msg_event, error_event = events
Expand All@@ -427,3 +433,75 @@ async def hello(request):

 assert msg_event["contexts"]["trace"]["trace_id"] == trace_id
 assert error_event["contexts"]["trace"]["trace_id"] == trace_id


@pytest.mark.asyncio
async def test_crumb_capture(
 sentry_init, aiohttp_raw_server, aiohttp_client, loop, capture_events
):
 def before_breadcrumb(crumb, hint):
 crumb["data"]["extra"] = "foo"
 return crumb

 sentry_init(
 integrations=[AioHttpIntegration()], before_breadcrumb=before_breadcrumb
 )

 async def handler(request):
 return web.Response(text="OK")

 raw_server = await aiohttp_raw_server(handler)

 with start_transaction():
 events = capture_events()

 client = await aiohttp_client(raw_server)
 resp = await client.get("/")
 assert resp.status == 200
 capture_message("Testing!")

 (event,) = events

 crumb = event["breadcrumbs"]["values"][0]
 assert crumb["type"] == "http"
 assert crumb["category"] == "httplib"
 assert crumb["data"] == {
 "url": "http://127.0.0.1:{}/".format(raw_server.port),
 "http.fragment": "",
 "http.method": "GET",
 "http.query": "",
 "http.response.status_code": 200,
 "reason": "OK",
 "extra": "foo",
 }


@pytest.mark.asyncio
async def test_outgoing_trace_headers(sentry_init, aiohttp_raw_server, aiohttp_client):
 sentry_init(
 integrations=[AioHttpIntegration()],
 traces_sample_rate=1.0,
 )

 async def handler(request):
 return web.Response(text="OK")

 raw_server = await aiohttp_raw_server(handler)

 with start_transaction(
 name="/interactions/other-dogs/new-dog",
 op="greeting.sniff",
 # make trace_id difference between transactions
 trace_id="0123456789012345678901234567890",
 ) as transaction:
 client = await aiohttp_client(raw_server)
 resp = await client.get("/")
 request_span = transaction._span_recorder.spans[-1]

 assert resp.request_info.headers[
 "sentry-trace"
 ] == "{trace_id}-{parent_span_id}-{sampled}".format(
 trace_id=transaction.trace_id,
 parent_span_id=request_span.span_id,
 sampled=1,
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(aiohttp): add instrumentation of client requests#1761

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

sentrivana
merged 6 commits into

from

Jun 28, 2023
 Merged


feat(aiohttp): add instrumentation of client requests
#1761
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
56dd6fc

feat(aiohttp): add instrumentation of client requests

Nov 28, 2022
ec10c10

fix: fix mypy errors and switch comment-style type hints

Feb 28, 2023
cfbfd26

fix: review 1 changes

Jun 22, 2023
7c0945d

fix: url data and tests

Jun 22, 2023
5e3021b

fix: fix existing tests which failed because client is now instrument…

Jun 22, 2023
ac5a45c

fix: review 2 changes

Jun 23, 2023

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


79 changes: 78 additions & 1 deletion
sentry_sdk/integrations/aiohttp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@

from sentry_sdk.api import continue_trace
from sentry_sdk._compat import reraise
from sentry_sdk.consts import OP
from sentry_sdk.consts import OP, SPANDATA
from sentry_sdk.hub import Hub
from sentry_sdk.integrations import Integration, DidNotEnable
from sentry_sdk.integrations.logging import ignore_logger
Expand All@@ -13,20 +13,25 @@
 request_body_within_bounds,
)
from sentry_sdk.tracing import SOURCE_FOR_STYLE, TRANSACTION_SOURCE_ROUTE
from sentry_sdk.tracing_utils import should_propagate_trace
from sentry_sdk.utils import (
 capture_internal_exceptions,
 event_from_exception,
 logger,
 parse_url,
 parse_version,
 transaction_from_function,
 HAS_REAL_CONTEXTVARS,
 CONTEXTVARS_ERROR_MESSAGE,
 SENSITIVE_DATA_SUBSTITUTE,
 AnnotatedValue,
)

try:
 import asyncio

 from aiohttp import __version__ as AIOHTTP_VERSION
 from aiohttp import ClientSession, TraceConfig
 from aiohttp.web import Application, HTTPException, UrlDispatcher
except ImportError:
 raise DidNotEnable("AIOHTTP not installed")
Expand All@@ -36,6 +41,8 @@
if TYPE_CHECKING:
 from aiohttp.web_request import Request
 from aiohttp.abc import AbstractMatchInfo
 from aiohttp import TraceRequestStartParams, TraceRequestEndParams
 from types import SimpleNamespace
 from typing import Any
 from typing import Dict
 from typing import Optional
Expand DownExpand Up@@ -164,6 +171,76 @@ async def sentry_urldispatcher_resolve(self, request):

 UrlDispatcher.resolve = sentry_urldispatcher_resolve

 old_client_session_init = ClientSession.__init__

 def init(*args, **kwargs):
 # type: (Any, Any) -> ClientSession
 hub = Hub.current
 if hub.get_integration(AioHttpIntegration) is None:
 return old_client_session_init(*args, **kwargs)

 client_trace_configs = list(kwargs.get("trace_configs", ()))
 trace_config = create_trace_config()
 client_trace_configs.append(trace_config)

 kwargs["trace_configs"] = client_trace_configs
 return old_client_session_init(*args, **kwargs)

 ClientSession.__init__ = init


def create_trace_config():
 # type: () -> TraceConfig
 async def on_request_start(session, trace_config_ctx, params):
 # type: (ClientSession, SimpleNamespace, TraceRequestStartParams) -> None
 hub = Hub.current
 if hub.get_integration(AioHttpIntegration) is None:
 return

 method = params.method.upper()

 parsed_url = None
 with capture_internal_exceptions():
 parsed_url = parse_url(str(params.url), sanitize=False)

 span = hub.start_span(
 op=OP.HTTP_CLIENT,
 description="%s %s"
 % (method, parsed_url.url if parsed_url else SENSITIVE_DATA_SUBSTITUTE),
 )
 span.set_data(SPANDATA.HTTP_METHOD, method)
 span.set_data("url", parsed_url.url)
 span.set_data(SPANDATA.HTTP_QUERY, parsed_url.query)
 span.set_data(SPANDATA.HTTP_FRAGMENT, parsed_url.fragment)

 if should_propagate_trace(hub, str(params.url)):
 for key, value in hub.iter_trace_propagation_headers(span):
 logger.debug(
 "[Tracing] Adding `{key}` header {value} to outgoing request to {url}.".format(
 key=key, value=value, url=params.url
 )
 )
 params.headers[key] = value

 trace_config_ctx.span = span

 async def on_request_end(session, trace_config_ctx, params):
 # type: (ClientSession, SimpleNamespace, TraceRequestEndParams) -> None
 if trace_config_ctx.span is None:
 return

 span = trace_config_ctx.span
 span.set_http_status(int(params.response.status))
 span.set_data("reason", params.response.reason)
 span.finish()

 trace_config = TraceConfig()

 trace_config.on_request_start.append(on_request_start)
 trace_config.on_request_end.append(on_request_end)

 return trace_config


def _make_request_processor(weak_request):
 # type: (Callable[[], Request]) -> EventProcessor
Expand Down

96 changes: 87 additions & 9 deletions
tests/integrations/aiohttp/test_aiohttp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
from aiohttp.client import ServerDisconnectedError
from aiohttp.web_request import Request

from sentry_sdk import capture_message
from sentry_sdk import capture_message, start_transaction
from sentry_sdk.integrations.aiohttp import AioHttpIntegration

try:
Expand DownExpand Up@@ -54,6 +54,8 @@ async def hello(request):
 "Accept-Encoding": "gzip, deflate",
 "Host": host,
 "User-Agent": request["headers"]["User-Agent"],
 "baggage": mock.ANY,
 "sentry-trace": mock.ANY,
 }


Expand DownExpand Up@@ -372,11 +374,13 @@ async def hello(request):

 events = capture_events()

 trace_id = "582b43a4192642f0b136d5159a501701"
 sentry_trace_header = "{}-{}-{}".format(trace_id, "6e8f22c393e68f19", 1)

 # The aiohttp_client is instrumented so will generate the sentry-trace header and add request.
 # Get the sentry-trace header from the request so we can later compare with transaction events.
 client = await aiohttp_client(app)
 resp = await client.get("/", headers={"sentry-trace": sentry_trace_header})
 resp = await client.get("/")
 sentry_trace_header = resp.request_info.headers.get("sentry-trace")
 trace_id = sentry_trace_header.split("-")[0]

 assert resp.status == 500

 msg_event, error_event, transaction_event = events
Expand DownExpand Up@@ -410,11 +414,13 @@ async def hello(request):

 events = capture_events()

 trace_id = "582b43a4192642f0b136d5159a501701"
 sentry_trace_header = "{}-{}-{}".format(trace_id, "6e8f22c393e68f19", 1)

 # The aiohttp_client is instrumented so will generate the sentry-trace header and add request.
 # Get the sentry-trace header from the request so we can later compare with transaction events.
 client = await aiohttp_client(app)
 resp = await client.get("/", headers={"sentry-trace": sentry_trace_header})
 resp = await client.get("/")
 sentry_trace_header = resp.request_info.headers.get("sentry-trace")
 trace_id = sentry_trace_header.split("-")[0]

 assert resp.status == 500

 msg_event, error_event = events
Expand All@@ -427,3 +433,75 @@ async def hello(request):

 assert msg_event["contexts"]["trace"]["trace_id"] == trace_id
 assert error_event["contexts"]["trace"]["trace_id"] == trace_id


@pytest.mark.asyncio
async def test_crumb_capture(
 sentry_init, aiohttp_raw_server, aiohttp_client, loop, capture_events
):
 def before_breadcrumb(crumb, hint):
 crumb["data"]["extra"] = "foo"
 return crumb

 sentry_init(
 integrations=[AioHttpIntegration()], before_breadcrumb=before_breadcrumb
 )

 async def handler(request):
 return web.Response(text="OK")

 raw_server = await aiohttp_raw_server(handler)

 with start_transaction():
 events = capture_events()

 client = await aiohttp_client(raw_server)
 resp = await client.get("/")
 assert resp.status == 200
 capture_message("Testing!")

 (event,) = events

 crumb = event["breadcrumbs"]["values"][0]
 assert crumb["type"] == "http"
 assert crumb["category"] == "httplib"
 assert crumb["data"] == {
 "url": "http://127.0.0.1:{}/".format(raw_server.port),
 "http.fragment": "",
 "http.method": "GET",
 "http.query": "",
 "http.response.status_code": 200,
 "reason": "OK",
 "extra": "foo",
 }


@pytest.mark.asyncio
async def test_outgoing_trace_headers(sentry_init, aiohttp_raw_server, aiohttp_client):
 sentry_init(
 integrations=[AioHttpIntegration()],
 traces_sample_rate=1.0,
 )

 async def handler(request):
 return web.Response(text="OK")

 raw_server = await aiohttp_raw_server(handler)

 with start_transaction(
 name="/interactions/other-dogs/new-dog",
 op="greeting.sniff",
 # make trace_id difference between transactions
 trace_id="0123456789012345678901234567890",
 ) as transaction:
 client = await aiohttp_client(raw_server)
 resp = await client.get("/")
 request_span = transaction._span_recorder.spans[-1]

 assert resp.request_info.headers[
 "sentry-trace"
 ] == "{trace_id}-{parent_span_id}-{sampled}".format(
 trace_id=transaction.trace_id,
 parent_span_id=request_span.span_id,
 sampled=1,
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(aiohttp): add instrumentation of client requests#1761

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

sentrivana
merged 6 commits into

from

Jun 28, 2023
 Merged


feat(aiohttp): add instrumentation of client requests
#1761
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
56dd6fc

feat(aiohttp): add instrumentation of client requests

Nov 28, 2022
ec10c10

fix: fix mypy errors and switch comment-style type hints

Feb 28, 2023
cfbfd26

fix: review 1 changes

Jun 22, 2023
7c0945d

fix: url data and tests

Jun 22, 2023
5e3021b

fix: fix existing tests which failed because client is now instrument…

Jun 22, 2023
ac5a45c

fix: review 2 changes

Jun 23, 2023

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


79 changes: 78 additions & 1 deletion
sentry_sdk/integrations/aiohttp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@

from sentry_sdk.api import continue_trace
from sentry_sdk._compat import reraise
from sentry_sdk.consts import OP
from sentry_sdk.consts import OP, SPANDATA
from sentry_sdk.hub import Hub
from sentry_sdk.integrations import Integration, DidNotEnable
from sentry_sdk.integrations.logging import ignore_logger
Expand All@@ -13,20 +13,25 @@
 request_body_within_bounds,
)
from sentry_sdk.tracing import SOURCE_FOR_STYLE, TRANSACTION_SOURCE_ROUTE
from sentry_sdk.tracing_utils import should_propagate_trace
from sentry_sdk.utils import (
 capture_internal_exceptions,
 event_from_exception,
 logger,
 parse_url,
 parse_version,
 transaction_from_function,
 HAS_REAL_CONTEXTVARS,
 CONTEXTVARS_ERROR_MESSAGE,
 SENSITIVE_DATA_SUBSTITUTE,
 AnnotatedValue,
)

try:
 import asyncio

 from aiohttp import __version__ as AIOHTTP_VERSION
 from aiohttp import ClientSession, TraceConfig
 from aiohttp.web import Application, HTTPException, UrlDispatcher
except ImportError:
 raise DidNotEnable("AIOHTTP not installed")
Expand All@@ -36,6 +41,8 @@
if TYPE_CHECKING:
 from aiohttp.web_request import Request
 from aiohttp.abc import AbstractMatchInfo
 from aiohttp import TraceRequestStartParams, TraceRequestEndParams
 from types import SimpleNamespace
 from typing import Any
 from typing import Dict
 from typing import Optional
Expand DownExpand Up@@ -164,6 +171,76 @@ async def sentry_urldispatcher_resolve(self, request):

 UrlDispatcher.resolve = sentry_urldispatcher_resolve

 old_client_session_init = ClientSession.__init__

 def init(*args, **kwargs):
 # type: (Any, Any) -> ClientSession
 hub = Hub.current
 if hub.get_integration(AioHttpIntegration) is None:
 return old_client_session_init(*args, **kwargs)

 client_trace_configs = list(kwargs.get("trace_configs", ()))
 trace_config = create_trace_config()
 client_trace_configs.append(trace_config)

 kwargs["trace_configs"] = client_trace_configs
 return old_client_session_init(*args, **kwargs)

 ClientSession.__init__ = init


def create_trace_config():
 # type: () -> TraceConfig
 async def on_request_start(session, trace_config_ctx, params):
 # type: (ClientSession, SimpleNamespace, TraceRequestStartParams) -> None
 hub = Hub.current
 if hub.get_integration(AioHttpIntegration) is None:
 return

 method = params.method.upper()

 parsed_url = None
 with capture_internal_exceptions():
 parsed_url = parse_url(str(params.url), sanitize=False)

 span = hub.start_span(
 op=OP.HTTP_CLIENT,
 description="%s %s"
 % (method, parsed_url.url if parsed_url else SENSITIVE_DATA_SUBSTITUTE),
 )
 span.set_data(SPANDATA.HTTP_METHOD, method)
 span.set_data("url", parsed_url.url)
 span.set_data(SPANDATA.HTTP_QUERY, parsed_url.query)
 span.set_data(SPANDATA.HTTP_FRAGMENT, parsed_url.fragment)

 if should_propagate_trace(hub, str(params.url)):
 for key, value in hub.iter_trace_propagation_headers(span):
 logger.debug(
 "[Tracing] Adding `{key}` header {value} to outgoing request to {url}.".format(
 key=key, value=value, url=params.url
 )
 )
 params.headers[key] = value

 trace_config_ctx.span = span

 async def on_request_end(session, trace_config_ctx, params):
 # type: (ClientSession, SimpleNamespace, TraceRequestEndParams) -> None
 if trace_config_ctx.span is None:
 return

 span = trace_config_ctx.span
 span.set_http_status(int(params.response.status))
 span.set_data("reason", params.response.reason)
 span.finish()

 trace_config = TraceConfig()

 trace_config.on_request_start.append(on_request_start)
 trace_config.on_request_end.append(on_request_end)

 return trace_config


def _make_request_processor(weak_request):
 # type: (Callable[[], Request]) -> EventProcessor
Expand Down

96 changes: 87 additions & 9 deletions
tests/integrations/aiohttp/test_aiohttp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
from aiohttp.client import ServerDisconnectedError
from aiohttp.web_request import Request

from sentry_sdk import capture_message
from sentry_sdk import capture_message, start_transaction
from sentry_sdk.integrations.aiohttp import AioHttpIntegration

try:
Expand DownExpand Up@@ -54,6 +54,8 @@ async def hello(request):
 "Accept-Encoding": "gzip, deflate",
 "Host": host,
 "User-Agent": request["headers"]["User-Agent"],
 "baggage": mock.ANY,
 "sentry-trace": mock.ANY,
 }


Expand DownExpand Up@@ -372,11 +374,13 @@ async def hello(request):

 events = capture_events()

 trace_id = "582b43a4192642f0b136d5159a501701"
 sentry_trace_header = "{}-{}-{}".format(trace_id, "6e8f22c393e68f19", 1)

 # The aiohttp_client is instrumented so will generate the sentry-trace header and add request.
 # Get the sentry-trace header from the request so we can later compare with transaction events.
 client = await aiohttp_client(app)
 resp = await client.get("/", headers={"sentry-trace": sentry_trace_header})
 resp = await client.get("/")
 sentry_trace_header = resp.request_info.headers.get("sentry-trace")
 trace_id = sentry_trace_header.split("-")[0]

 assert resp.status == 500

 msg_event, error_event, transaction_event = events
Expand DownExpand Up@@ -410,11 +414,13 @@ async def hello(request):

 events = capture_events()

 trace_id = "582b43a4192642f0b136d5159a501701"
 sentry_trace_header = "{}-{}-{}".format(trace_id, "6e8f22c393e68f19", 1)

 # The aiohttp_client is instrumented so will generate the sentry-trace header and add request.
 # Get the sentry-trace header from the request so we can later compare with transaction events.
 client = await aiohttp_client(app)
 resp = await client.get("/", headers={"sentry-trace": sentry_trace_header})
 resp = await client.get("/")
 sentry_trace_header = resp.request_info.headers.get("sentry-trace")
 trace_id = sentry_trace_header.split("-")[0]

 assert resp.status == 500

 msg_event, error_event = events
Expand All@@ -427,3 +433,75 @@ async def hello(request):

 assert msg_event["contexts"]["trace"]["trace_id"] == trace_id
 assert error_event["contexts"]["trace"]["trace_id"] == trace_id


@pytest.mark.asyncio
async def test_crumb_capture(
 sentry_init, aiohttp_raw_server, aiohttp_client, loop, capture_events
):
 def before_breadcrumb(crumb, hint):
 crumb["data"]["extra"] = "foo"
 return crumb

 sentry_init(
 integrations=[AioHttpIntegration()], before_breadcrumb=before_breadcrumb
 )

 async def handler(request):
 return web.Response(text="OK")

 raw_server = await aiohttp_raw_server(handler)

 with start_transaction():
 events = capture_events()

 client = await aiohttp_client(raw_server)
 resp = await client.get("/")
 assert resp.status == 200
 capture_message("Testing!")

 (event,) = events

 crumb = event["breadcrumbs"]["values"][0]
 assert crumb["type"] == "http"
 assert crumb["category"] == "httplib"
 assert crumb["data"] == {
 "url": "http://127.0.0.1:{}/".format(raw_server.port),
 "http.fragment": "",
 "http.method": "GET",
 "http.query": "",
 "http.response.status_code": 200,
 "reason": "OK",
 "extra": "foo",
 }


@pytest.mark.asyncio
async def test_outgoing_trace_headers(sentry_init, aiohttp_raw_server, aiohttp_client):
 sentry_init(
 integrations=[AioHttpIntegration()],
 traces_sample_rate=1.0,
 )

 async def handler(request):
 return web.Response(text="OK")

 raw_server = await aiohttp_raw_server(handler)

 with start_transaction(
 name="/interactions/other-dogs/new-dog",
 op="greeting.sniff",
 # make trace_id difference between transactions
 trace_id="0123456789012345678901234567890",
 ) as transaction:
 client = await aiohttp_client(raw_server)
 resp = await client.get("/")
 request_span = transaction._span_recorder.spans[-1]

 assert resp.request_info.headers[
 "sentry-trace"
 ] == "{trace_id}-{parent_span_id}-{sampled}".format(
 trace_id=transaction.trace_id,
 parent_span_id=request_span.span_id,
 sampled=1,
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(aiohttp): add instrumentation of client requests#1761

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

sentrivana
merged 6 commits into

from

Jun 28, 2023
 Merged


feat(aiohttp): add instrumentation of client requests
#1761
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
56dd6fc

feat(aiohttp): add instrumentation of client requests

Nov 28, 2022
ec10c10

fix: fix mypy errors and switch comment-style type hints

Feb 28, 2023
cfbfd26

fix: review 1 changes

Jun 22, 2023
7c0945d

fix: url data and tests

Jun 22, 2023
5e3021b

fix: fix existing tests which failed because client is now instrument…

Jun 22, 2023
ac5a45c

fix: review 2 changes

Jun 23, 2023

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


79 changes: 78 additions & 1 deletion
sentry_sdk/integrations/aiohttp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@

from sentry_sdk.api import continue_trace
from sentry_sdk._compat import reraise
from sentry_sdk.consts import OP
from sentry_sdk.consts import OP, SPANDATA
from sentry_sdk.hub import Hub
from sentry_sdk.integrations import Integration, DidNotEnable
from sentry_sdk.integrations.logging import ignore_logger
Expand All@@ -13,20 +13,25 @@
 request_body_within_bounds,
)
from sentry_sdk.tracing import SOURCE_FOR_STYLE, TRANSACTION_SOURCE_ROUTE
from sentry_sdk.tracing_utils import should_propagate_trace
from sentry_sdk.utils import (
 capture_internal_exceptions,
 event_from_exception,
 logger,
 parse_url,
 parse_version,
 transaction_from_function,
 HAS_REAL_CONTEXTVARS,
 CONTEXTVARS_ERROR_MESSAGE,
 SENSITIVE_DATA_SUBSTITUTE,
 AnnotatedValue,
)

try:
 import asyncio

 from aiohttp import __version__ as AIOHTTP_VERSION
 from aiohttp import ClientSession, TraceConfig
 from aiohttp.web import Application, HTTPException, UrlDispatcher
except ImportError:
 raise DidNotEnable("AIOHTTP not installed")
Expand All@@ -36,6 +41,8 @@
if TYPE_CHECKING:
 from aiohttp.web_request import Request
 from aiohttp.abc import AbstractMatchInfo
 from aiohttp import TraceRequestStartParams, TraceRequestEndParams
 from types import SimpleNamespace
 from typing import Any
 from typing import Dict
 from typing import Optional
Expand DownExpand Up@@ -164,6 +171,76 @@ async def sentry_urldispatcher_resolve(self, request):

 UrlDispatcher.resolve = sentry_urldispatcher_resolve

 old_client_session_init = ClientSession.__init__

 def init(*args, **kwargs):
 # type: (Any, Any) -> ClientSession
 hub = Hub.current
 if hub.get_integration(AioHttpIntegration) is None:
 return old_client_session_init(*args, **kwargs)

 client_trace_configs = list(kwargs.get("trace_configs", ()))
 trace_config = create_trace_config()
 client_trace_configs.append(trace_config)

 kwargs["trace_configs"] = client_trace_configs
 return old_client_session_init(*args, **kwargs)

 ClientSession.__init__ = init


def create_trace_config():
 # type: () -> TraceConfig
 async def on_request_start(session, trace_config_ctx, params):
 # type: (ClientSession, SimpleNamespace, TraceRequestStartParams) -> None
 hub = Hub.current
 if hub.get_integration(AioHttpIntegration) is None:
 return

 method = params.method.upper()

 parsed_url = None
 with capture_internal_exceptions():
 parsed_url = parse_url(str(params.url), sanitize=False)

 span = hub.start_span(
 op=OP.HTTP_CLIENT,
 description="%s %s"
 % (method, parsed_url.url if parsed_url else SENSITIVE_DATA_SUBSTITUTE),
 )
 span.set_data(SPANDATA.HTTP_METHOD, method)
 span.set_data("url", parsed_url.url)
 span.set_data(SPANDATA.HTTP_QUERY, parsed_url.query)
 span.set_data(SPANDATA.HTTP_FRAGMENT, parsed_url.fragment)

 if should_propagate_trace(hub, str(params.url)):
 for key, value in hub.iter_trace_propagation_headers(span):
 logger.debug(
 "[Tracing] Adding `{key}` header {value} to outgoing request to {url}.".format(
 key=key, value=value, url=params.url
 )
 )
 params.headers[key] = value

 trace_config_ctx.span = span

 async def on_request_end(session, trace_config_ctx, params):
 # type: (ClientSession, SimpleNamespace, TraceRequestEndParams) -> None
 if trace_config_ctx.span is None:
 return

 span = trace_config_ctx.span
 span.set_http_status(int(params.response.status))
 span.set_data("reason", params.response.reason)
 span.finish()

 trace_config = TraceConfig()

 trace_config.on_request_start.append(on_request_start)
 trace_config.on_request_end.append(on_request_end)

 return trace_config


def _make_request_processor(weak_request):
 # type: (Callable[[], Request]) -> EventProcessor
Expand Down

96 changes: 87 additions & 9 deletions
tests/integrations/aiohttp/test_aiohttp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
from aiohttp.client import ServerDisconnectedError
from aiohttp.web_request import Request

from sentry_sdk import capture_message
from sentry_sdk import capture_message, start_transaction
from sentry_sdk.integrations.aiohttp import AioHttpIntegration

try:
Expand DownExpand Up@@ -54,6 +54,8 @@ async def hello(request):
 "Accept-Encoding": "gzip, deflate",
 "Host": host,
 "User-Agent": request["headers"]["User-Agent"],
 "baggage": mock.ANY,
 "sentry-trace": mock.ANY,
 }


Expand DownExpand Up@@ -372,11 +374,13 @@ async def hello(request):

 events = capture_events()

 trace_id = "582b43a4192642f0b136d5159a501701"
 sentry_trace_header = "{}-{}-{}".format(trace_id, "6e8f22c393e68f19", 1)

 # The aiohttp_client is instrumented so will generate the sentry-trace header and add request.
 # Get the sentry-trace header from the request so we can later compare with transaction events.
 client = await aiohttp_client(app)
 resp = await client.get("/", headers={"sentry-trace": sentry_trace_header})
 resp = await client.get("/")
 sentry_trace_header = resp.request_info.headers.get("sentry-trace")
 trace_id = sentry_trace_header.split("-")[0]

 assert resp.status == 500

 msg_event, error_event, transaction_event = events
Expand DownExpand Up@@ -410,11 +414,13 @@ async def hello(request):

 events = capture_events()

 trace_id = "582b43a4192642f0b136d5159a501701"
 sentry_trace_header = "{}-{}-{}".format(trace_id, "6e8f22c393e68f19", 1)

 # The aiohttp_client is instrumented so will generate the sentry-trace header and add request.
 # Get the sentry-trace header from the request so we can later compare with transaction events.
 client = await aiohttp_client(app)
 resp = await client.get("/", headers={"sentry-trace": sentry_trace_header})
 resp = await client.get("/")
 sentry_trace_header = resp.request_info.headers.get("sentry-trace")
 trace_id = sentry_trace_header.split("-")[0]

 assert resp.status == 500

 msg_event, error_event = events
Expand All@@ -427,3 +433,75 @@ async def hello(request):

 assert msg_event["contexts"]["trace"]["trace_id"] == trace_id
 assert error_event["contexts"]["trace"]["trace_id"] == trace_id


@pytest.mark.asyncio
async def test_crumb_capture(
 sentry_init, aiohttp_raw_server, aiohttp_client, loop, capture_events
):
 def before_breadcrumb(crumb, hint):
 crumb["data"]["extra"] = "foo"
 return crumb

 sentry_init(
 integrations=[AioHttpIntegration()], before_breadcrumb=before_breadcrumb
 )

 async def handler(request):
 return web.Response(text="OK")

 raw_server = await aiohttp_raw_server(handler)

 with start_transaction():
 events = capture_events()

 client = await aiohttp_client(raw_server)
 resp = await client.get("/")
 assert resp.status == 200
 capture_message("Testing!")

 (event,) = events

 crumb = event["breadcrumbs"]["values"][0]
 assert crumb["type"] == "http"
 assert crumb["category"] == "httplib"
 assert crumb["data"] == {
 "url": "http://127.0.0.1:{}/".format(raw_server.port),
 "http.fragment": "",
 "http.method": "GET",
 "http.query": "",
 "http.response.status_code": 200,
 "reason": "OK",
 "extra": "foo",
 }


@pytest.mark.asyncio
async def test_outgoing_trace_headers(sentry_init, aiohttp_raw_server, aiohttp_client):
 sentry_init(
 integrations=[AioHttpIntegration()],
 traces_sample_rate=1.0,
 )

 async def handler(request):
 return web.Response(text="OK")

 raw_server = await aiohttp_raw_server(handler)

 with start_transaction(
 name="/interactions/other-dogs/new-dog",
 op="greeting.sniff",
 # make trace_id difference between transactions
 trace_id="0123456789012345678901234567890",
 ) as transaction:
 client = await aiohttp_client(raw_server)
 resp = await client.get("/")
 request_span = transaction._span_recorder.spans[-1]

 assert resp.request_info.headers[
 "sentry-trace"
 ] == "{trace_id}-{parent_span_id}-{sampled}".format(
 trace_id=transaction.trace_id,
 parent_span_id=request_span.span_id,
 sampled=1,
 )

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(aiohttp): add instrumentation of client requests#1761

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

sentrivana
merged 6 commits into

from

Jun 28, 2023
 Merged


feat(aiohttp): add instrumentation of client requests
#1761
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
56dd6fc

feat(aiohttp): add instrumentation of client requests

Nov 28, 2022
ec10c10

fix: fix mypy errors and switch comment-style type hints

Feb 28, 2023
cfbfd26

fix: review 1 changes

Jun 22, 2023
7c0945d

fix: url data and tests

Jun 22, 2023
5e3021b

fix: fix existing tests which failed because client is now instrument…

Jun 22, 2023
ac5a45c

fix: review 2 changes

Jun 23, 2023

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


79 changes: 78 additions & 1 deletion
sentry_sdk/integrations/aiohttp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@

from sentry_sdk.api import continue_trace
from sentry_sdk._compat import reraise
from sentry_sdk.consts import OP
from sentry_sdk.consts import OP, SPANDATA
from sentry_sdk.hub import Hub
from sentry_sdk.integrations import Integration, DidNotEnable
from sentry_sdk.integrations.logging import ignore_logger
Expand All@@ -13,20 +13,25 @@
 request_body_within_bounds,
)
from sentry_sdk.tracing import SOURCE_FOR_STYLE, TRANSACTION_SOURCE_ROUTE
from sentry_sdk.tracing_utils import should_propagate_trace
from sentry_sdk.utils import (
 capture_internal_exceptions,
 event_from_exception,
 logger,
 parse_url,
 parse_version,
 transaction_from_function,
 HAS_REAL_CONTEXTVARS,
 CONTEXTVARS_ERROR_MESSAGE,
 SENSITIVE_DATA_SUBSTITUTE,
 AnnotatedValue,
)

try:
 import asyncio

 from aiohttp import __version__ as AIOHTTP_VERSION
 from aiohttp import ClientSession, TraceConfig
 from aiohttp.web import Application, HTTPException, UrlDispatcher
except ImportError:
 raise DidNotEnable("AIOHTTP not installed")
Expand All@@ -36,6 +41,8 @@
if TYPE_CHECKING:
 from aiohttp.web_request import Request
 from aiohttp.abc import AbstractMatchInfo
 from aiohttp import TraceRequestStartParams, TraceRequestEndParams
 from types import SimpleNamespace
 from typing import Any
 from typing import Dict
 from typing import Optional
Expand DownExpand Up@@ -164,6 +171,76 @@ async def sentry_urldispatcher_resolve(self, request):

 UrlDispatcher.resolve = sentry_urldispatcher_resolve

 old_client_session_init = ClientSession.__init__

 def init(*args, **kwargs):
 # type: (Any, Any) -> ClientSession
 hub = Hub.current
 if hub.get_integration(AioHttpIntegration) is None:
 return old_client_session_init(*args, **kwargs)

 client_trace_configs = list(kwargs.get("trace_configs", ()))
 trace_config = create_trace_config()
 client_trace_configs.append(trace_config)

 kwargs["trace_configs"] = client_trace_configs
 return old_client_session_init(*args, **kwargs)

 ClientSession.__init__ = init


def create_trace_config():
 # type: () -> TraceConfig
 async def on_request_start(session, trace_config_ctx, params):
 # type: (ClientSession, SimpleNamespace, TraceRequestStartParams) -> None
 hub = Hub.current
 if hub.get_integration(AioHttpIntegration) is None:
 return

 method = params.method.upper()

 parsed_url = None
 with capture_internal_exceptions():
 parsed_url = parse_url(str(params.url), sanitize=False)

 span = hub.start_span(
 op=OP.HTTP_CLIENT,
 description="%s %s"
 % (method, parsed_url.url if parsed_url else SENSITIVE_DATA_SUBSTITUTE),
 )
 span.set_data(SPANDATA.HTTP_METHOD, method)
 span.set_data("url", parsed_url.url)
 span.set_data(SPANDATA.HTTP_QUERY, parsed_url.query)
 span.set_data(SPANDATA.HTTP_FRAGMENT, parsed_url.fragment)

 if should_propagate_trace(hub, str(params.url)):
 for key, value in hub.iter_trace_propagation_headers(span):
 logger.debug(
 "[Tracing] Adding `{key}` header {value} to outgoing request to {url}.".format(
 key=key, value=value, url=params.url
 )
 )
 params.headers[key] = value

 trace_config_ctx.span = span

 async def on_request_end(session, trace_config_ctx, params):
 # type: (ClientSession, SimpleNamespace, TraceRequestEndParams) -> None
 if trace_config_ctx.span is None:
 return

 span = trace_config_ctx.span
 span.set_http_status(int(params.response.status))
 span.set_data("reason", params.response.reason)
 span.finish()

 trace_config = TraceConfig()

 trace_config.on_request_start.append(on_request_start)
 trace_config.on_request_end.append(on_request_end)

 return trace_config


def _make_request_processor(weak_request):
 # type: (Callable[[], Request]) -> EventProcessor
Expand Down

96 changes: 87 additions & 9 deletions
tests/integrations/aiohttp/test_aiohttp.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
from aiohttp.client import ServerDisconnectedError
from aiohttp.web_request import Request

from sentry_sdk import capture_message
from sentry_sdk import capture_message, start_transaction
from sentry_sdk.integrations.aiohttp import AioHttpIntegration

try:
Expand DownExpand Up@@ -54,6 +54,8 @@ async def hello(request):
 "Accept-Encoding": "gzip, deflate",
 "Host": host,
 "User-Agent": request["headers"]["User-Agent"],
 "baggage": mock.ANY,
 "sentry-trace": mock.ANY,
 }


Expand DownExpand Up@@ -372,11 +374,13 @@ async def hello(request):

 events = capture_events()

 trace_id = "582b43a4192642f0b136d5159a501701"
 sentry_trace_header = "{}-{}-{}".format(trace_id, "6e8f22c393e68f19", 1)

 # The aiohttp_client is instrumented so will generate the sentry-trace header and add request.
 # Get the sentry-trace header from the request so we can later compare with transaction events.
 client = await aiohttp_client(app)
 resp = await client.get("/", headers={"sentry-trace": sentry_trace_header})
 resp = await client.get("/")
 sentry_trace_header = resp.request_info.headers.get("sentry-trace")
 trace_id = sentry_trace_header.split("-")[0]

 assert resp.status == 500

 msg_event, error_event, transaction_event = events
Expand DownExpand Up@@ -410,11 +414,13 @@ async def hello(request):

 events = capture_events()

 trace_id = "582b43a4192642f0b136d5159a501701"
 sentry_trace_header = "{}-{}-{}".format(trace_id, "6e8f22c393e68f19", 1)

 # The aiohttp_client is instrumented so will generate the sentry-trace header and add request.
 # Get the sentry-trace header from the request so we can later compare with transaction events.
 client = await aiohttp_client(app)
 resp = await client.get("/", headers={"sentry-trace": sentry_trace_header})
 resp = await client.get("/")
 sentry_trace_header = resp.request_info.headers.get("sentry-trace")
 trace_id = sentry_trace_header.split("-")[0]

 assert resp.status == 500

 msg_event, error_event = events
Expand All@@ -427,3 +433,75 @@ async def hello(request):

 assert msg_event["contexts"]["trace"]["trace_id"] == trace_id
 assert error_event["contexts"]["trace"]["trace_id"] == trace_id


@pytest.mark.asyncio
async def test_crumb_capture(
 sentry_init, aiohttp_raw_server, aiohttp_client, loop, capture_events
):
 def before_breadcrumb(crumb, hint):
 crumb["data"]["extra"] = "foo"
 return crumb

 sentry_init(
 integrations=[AioHttpIntegration()], before_breadcrumb=before_breadcrumb
 )

 async def handler(request):
 return web.Response(text="OK")

 raw_server = await aiohttp_raw_server(handler)

 with start_transaction():
 events = capture_events()

 client = await aiohttp_client(raw_server)
 resp = await client.get("/")
 assert resp.status == 200
 capture_message("Testing!")

 (event,) = events

 crumb = event["breadcrumbs"]["values"][0]
 assert crumb["type"] == "http"
 assert crumb["category"] == "httplib"
 assert crumb["data"] == {
 "url": "http://127.0.0.1:{}/".format(raw_server.port),
 "http.fragment": "",
 "http.method": "GET",
 "http.query": "",
 "http.response.status_code": 200,
 "reason": "OK",
 "extra": "foo",
 }


@pytest.mark.asyncio
async def test_outgoing_trace_headers(sentry_init, aiohttp_raw_server, aiohttp_client):
 sentry_init(
 integrations=[AioHttpIntegration()],
 traces_sample_rate=1.0,
 )

 async def handler(request):
 return web.Response(text="OK")

 raw_server = await aiohttp_raw_server(handler)

 with start_transaction(
 name="/interactions/other-dogs/new-dog",
 op="greeting.sniff",
 # make trace_id difference between transactions
 trace_id="0123456789012345678901234567890",
 ) as transaction:
 client = await aiohttp_client(raw_server)
 resp = await client.get("/")
 request_span = transaction._span_recorder.spans[-1]

 assert resp.request_info.headers[
 "sentry-trace"
 ] == "{trace_id}-{parent_span_id}-{sampled}".format(
 trace_id=transaction.trace_id,
 parent_span_id=request_span.span_id,
 sampled=1,
 )