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
|
.. _thirdparty:
Third Party Library Support
===========================
Patching Supported Libraries
----------------------------
The SDK supports aioboto3, aiobotocore, boto3, botocore, requests, sqlite3 and mysql-connector.
To patch, use code like the following in the main app::
from aws_xray_sdk.core import patch_all
patch_all()
``patch_all`` ignores any libraries that are not installed.
To patch specific modules::
from aws_xray_sdk.core import patch
i_want_to_patch = ('botocore') # a tuple that contains the libs you want to patch
patch(i_want_to_patch)
The following modules are availble to patch::
SUPPORTED_MODULES = (
'aioboto3',
'aiobotocore',
'boto3',
'botocore',
'requests',
'sqlite3',
'mysql',
)
Patching boto3 and botocore are equivalent since boto3 depends on botocore
Patching mysql
----------------------------
For mysql, only the mysql-connector module is supported and you have to use
code like the following to generate a subsegment for an SQL query::
def call_mysql():
conn = mysql.connector.connect(
host='host',
port='some_port',
user='some_user',
password='your_password',
database='your_db_name'
)
conn.cursor().execute('SHOW TABLES')
Patching aioboto3 and aiobotocore
---------------------------------
On top of patching aioboto3 or aiobotocore, the xray_recorder also needs to be
configured to use the ``AsyncContext``. The following snippet shows how to set
up the X-Ray SDK with an Async Context, bear in mind this requires Python 3.5+::
from aws_xray_sdk.core.async_context import AsyncContext
from aws_xray_sdk.core import xray_recorder
# Configure X-Ray to use AsyncContext
xray_recorder.configure(service='service_name', context=AsyncContext())
See :ref:`Configure Global Recorder <configurations>` for more information about
configuring the ``xray_recorder``.
|
