forked from getsentry/sentry-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathaiomysql.py
More file actions
275 lines (213 loc) · 9.09 KB
/
Copy pathaiomysql.py
File metadata and controls
275 lines (213 loc) · 9.09 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
# -*- coding: utf-8 -*-
from __future__ import annotations
from typing import Any, Awaitable, Callable, TypeVar
import sentry_sdk
from sentry_sdk.consts import OP, SPANDATA
from sentry_sdk.integrations import DidNotEnable, Integration, _check_minimum_version
from sentry_sdk.traces import StreamedSpan
from sentry_sdk.tracing_utils import (
add_query_source,
has_span_streaming_enabled,
record_sql_queries,
)
from sentry_sdk.utils import (
capture_internal_exceptions,
parse_version,
)
try:
import aiomysql # type: ignore[import-not-found]
from aiomysql.connection import Connection # type: ignore[import-not-found]
from aiomysql.cursors import Cursor # type: ignore[import-not-found]
except ImportError:
raise DidNotEnable("aiomysql not installed.")
class AioMySQLIntegration(Integration):
identifier = "aiomysql"
origin = f"auto.db.{identifier}"
_record_params = False
def __init__(self, *, record_params: bool = False):
AioMySQLIntegration._record_params = record_params
@staticmethod
def setup_once() -> None:
aiomysql_version = parse_version(aiomysql.__version__)
_check_minimum_version(AioMySQLIntegration, aiomysql_version)
Cursor.execute = _wrap_execute(Cursor.execute)
Cursor.executemany = _wrap_executemany(Cursor.executemany)
# Patch Connection._connect — this catches ALL connections:
# - aiomysql.connect()
# - aiomysql.create_pool() (pool.py does `from .connection import connect`
# which ultimately calls Connection._connect)
# - Reconnects
Connection._connect = _wrap_connect(Connection._connect)
T = TypeVar("T")
def _normalize_query(query: str | bytes | bytearray) -> str:
if isinstance(query, (bytes, bytearray)):
query = query.decode("utf-8", errors="replace")
return " ".join(query.split())
def _wrap_execute(f: Callable[..., Awaitable[T]]) -> Callable[..., Awaitable[T]]:
"""Wrap Cursor.execute to capture SQL queries."""
async def _inner(*args: Any, **kwargs: Any) -> T:
if sentry_sdk.get_client().get_integration(AioMySQLIntegration) is None:
return await f(*args, **kwargs)
cursor = args[0]
# Skip if flagged by executemany (avoids double-recording).
# Do NOT reset the flag here — it must stay True for the entire
# duration of executemany, which may call execute multiple times
# in a loop (non-INSERT fallback). Only _wrap_executemany's
# finally block should clear it.
if getattr(cursor, "_sentry_skip_next_execute", False):
return await f(*args, **kwargs)
query = args[1] if len(args) > 1 else kwargs.get("query", "")
query_str = _normalize_query(query)
params = args[2] if len(args) > 2 else kwargs.get("args")
conn = _get_connection(cursor)
integration = sentry_sdk.get_client().get_integration(AioMySQLIntegration)
params_list = params if integration and integration._record_params else None
param_style = "pyformat" if params_list else None
with record_sql_queries(
cursor=None,
query=query_str,
params_list=params_list,
paramstyle=param_style,
executemany=False,
span_origin=AioMySQLIntegration.origin,
) as span:
if conn:
_set_db_data(span, conn)
res = await f(*args, **kwargs)
if isinstance(span, StreamedSpan):
with capture_internal_exceptions():
add_query_source(span)
if not isinstance(span, StreamedSpan):
with capture_internal_exceptions():
add_query_source(span)
return res
return _inner
def _wrap_executemany(f: Callable[..., Awaitable[T]]) -> Callable[..., Awaitable[T]]:
"""Wrap Cursor.executemany to capture SQL queries."""
async def _inner(*args: Any, **kwargs: Any) -> T:
if sentry_sdk.get_client().get_integration(AioMySQLIntegration) is None:
return await f(*args, **kwargs)
cursor = args[0]
query = args[1] if len(args) > 1 else kwargs.get("query", "")
query_str = _normalize_query(query)
seq_of_params = args[2] if len(args) > 2 else kwargs.get("args")
conn = _get_connection(cursor)
integration = sentry_sdk.get_client().get_integration(AioMySQLIntegration)
params_list = (
seq_of_params if integration and integration._record_params else None
)
param_style = "pyformat" if params_list else None
# Prevent double-recording: _do_execute_many calls self.execute internally
cursor._sentry_skip_next_execute = True
try:
with record_sql_queries(
cursor=None,
query=query_str,
params_list=params_list,
paramstyle=param_style,
executemany=True,
span_origin=AioMySQLIntegration.origin,
) as span:
if conn:
_set_db_data(span, conn)
res = await f(*args, **kwargs)
if isinstance(span, StreamedSpan):
with capture_internal_exceptions():
add_query_source(span)
if not isinstance(span, StreamedSpan):
with capture_internal_exceptions():
add_query_source(span)
return res
finally:
cursor._sentry_skip_next_execute = False
return _inner
def _get_connection(cursor: Any) -> Any:
"""Get the underlying connection from a cursor."""
return getattr(cursor, "connection", None)
def _wrap_connect(f: Callable[..., Awaitable[T]]) -> Callable[..., Awaitable[T]]:
"""Wrap Connection._connect to capture connection spans."""
async def _inner(self: "Connection") -> T:
client = sentry_sdk.get_client()
if client.get_integration(AioMySQLIntegration) is None:
return await f(self)
if has_span_streaming_enabled(client.options):
breadcrumb_data = _get_connect_data(self, use_streaming_keys=True)
span_attributes: dict[str, Any] = {
"sentry.op": OP.DB,
"sentry.origin": AioMySQLIntegration.origin,
} | breadcrumb_data
with sentry_sdk.traces.start_span(
name="connect", attributes=span_attributes
) as span:
with capture_internal_exceptions():
sentry_sdk.add_breadcrumb(
message="connect", category="query", data=breadcrumb_data
)
res = await f(self)
else:
connect_data = _get_connect_data(self)
with sentry_sdk.start_span(
op=OP.DB,
name="connect",
origin=AioMySQLIntegration.origin,
) as span:
_set_db_data(span, self)
with capture_internal_exceptions():
sentry_sdk.add_breadcrumb(
message="connect",
category="query",
data=connect_data,
)
res = await f(self)
return res
return _inner
def _get_connect_data(conn: Any, *, use_streaming_keys: bool = False) -> dict[str, Any]:
if use_streaming_keys:
db_system = SPANDATA.DB_SYSTEM_NAME
db_name = SPANDATA.DB_NAMESPACE
else:
db_system = SPANDATA.DB_SYSTEM
db_name = SPANDATA.DB_NAME
data: dict[str, Any] = {
db_system: "mysql",
SPANDATA.DB_DRIVER_NAME: "aiomysql",
}
host = getattr(conn, "host", None)
if host is not None:
data[SPANDATA.SERVER_ADDRESS] = host
port = getattr(conn, "port", None)
if port is not None:
data[SPANDATA.SERVER_PORT] = port
database = getattr(conn, "db", None)
if database is not None:
data[db_name] = database
user = getattr(conn, "user", None)
if user is not None:
data[SPANDATA.DB_USER] = user
return data
def _set_db_data(span: Any, conn: Any) -> None:
"""Set database-related span data from connection object."""
if isinstance(span, StreamedSpan):
set_value = span.set_attribute
db_system = SPANDATA.DB_SYSTEM_NAME
db_name = SPANDATA.DB_NAMESPACE
else:
# Remove this else block once we've completely migrated to streamed spans
# The use of deprecated attributes here is to ensure backwards compatibility
set_value = span.set_data
db_system = SPANDATA.DB_SYSTEM
db_name = SPANDATA.DB_NAME
set_value(db_system, "mysql")
set_value(SPANDATA.DB_DRIVER_NAME, "aiomysql")
host = getattr(conn, "host", None)
if host is not None:
set_value(SPANDATA.SERVER_ADDRESS, host)
port = getattr(conn, "port", None)
if port is not None:
set_value(SPANDATA.SERVER_PORT, port)
database = getattr(conn, "db", None)
if database is not None:
set_value(db_name, database)
user = getattr(conn, "user", None)
if user is not None:
set_value(SPANDATA.DB_USER, user)