Instrumented mysql not working with pymysql

[BrikerMan]

I am using PyMySQL==0.9.2 for MySQL connection. I can't get MySQL instrument for my requests.

repreduce
If I just import pumysql, agent will not found the mysql module.

import pymysql
pymysql.connect(**db_conf,
                charset='utf8mb4',
                cursorclass=pymysql.cursors.SSDictCursor)
# LOG
DEBUG elasticapm.instrument:base.py:73 - Skipping instrumentation of mysql. Module MySQLdb not found

If I just import pumysql as MySQLdb, agent will found the mysql module, but not working.

import pymysql
pymysql.install_as_MySQLdb()
pymysql.connect(**db_conf,
                charset='utf8mb4',
                cursorclass=pymysql.cursors.SSDictCursor)

# LOG
DEBUG elasticapm.instrument:base.py:82 - Instrumented mysql, MySQLdb.connect

Environment (please complete the following information)

• OS: mac 10.14.2 (18C54)
• Python version: python 3.6.5
• Framework and version [e.g. Django 2.1]: Flask==1.0.2
• APM Server version: 6.4.0
• Agent version: elastic-apm==3.0.3

[beniwohli]

Hi @BrikerMan

unfortunately, we don't yet support pymysql instrumentation, and I'm unfamiliar with its MySQLdb compatibility mode.

While adding support for pymysql would probably be relatively straight forward, we need to be vary to not overload the agent with built-in instrumentations. Every new instrumentation we write needs to be tested, supported and updated, adding a lot of additional load. We are currently looking into ways to add custom module instrumentation without having to depend on built-in instrumentation.

[BrikerMan]

Adding optional instrumentation modules sounds right. Thanks for your help~

[lreuven]

@beniwohli isn't that covered by #603 ?

[beniwohli]

@lreuven only partially, I don't think it would address compatibility mode

[basepi]

We now support pymysql: #603