added support for pyodbc instrumentation

closes #237
closes #238

Author: beniwohli

elasticapm/instrumentation/packages/pyodbc.py

@@ -0,0 +1,26 @@
+from elasticapm.instrumentation.packages.dbapi2 import (ConnectionProxy,
+                                                        CursorProxy,
+                                                        DbApi2Instrumentation,
+                                                        extract_signature)
+
+
+class PyODBCCursorProxy(CursorProxy):
+    provider_name = 'pyodbc'
+
+    def extract_signature(self, sql):
+        return extract_signature(sql)
+
+
+class PyODBCConnectionProxy(ConnectionProxy):
+    cursor_proxy = PyODBCCursorProxy
+
+
+class PyODBCInstrumentation(DbApi2Instrumentation):
+    name = 'pyodbc'
+
+    instrument_list = [
+        ("pyodbc", "connect"),
+    ]
+
+    def call(self, module, method, wrapped, instance, args, kwargs):
+        return PyODBCConnectionProxy(wrapped(*args, **kwargs))

elasticapm/instrumentation/register.py

@@ -20,6 +20,7 @@
     'elasticapm.instrumentation.packages.elasticsearch.ElasticsearchInstrumentation',
     'elasticapm.instrumentation.packages.cassandra.CassandraInstrumentation',
     'elasticapm.instrumentation.packages.pymssql.PyMSSQLInstrumentation',
+    'elasticapm.instrumentation.packages.pyodbc.PyODBCInstrumentation',
 
     'elasticapm.instrumentation.packages.django.template.DjangoTemplateInstrumentation',
     'elasticapm.instrumentation.packages.django.template.DjangoTemplateSourceInstrumentation',

tests/.jenkins_exclude.yml

@@ -98,3 +98,8 @@ exclude:
   # pymssql
   - PYTHON_VERSION: pypy-2 # currently fails with error on pypy2
     FRAMEWORK: pymssql-newest
+  # pyodbc
+  - PYTHON_VERSION: pypy-2
+    FRAMEWORK: pyodbc-newest
+  - PYTHON_VERSION: pypy-3
+    FRAMEWORK: pyodbc-newest

tests/.jenkins_framework.yml

@@ -17,6 +17,7 @@ FRAMEWORK:
   - redis-newest
   - psycopg2-newest
   - pymssql-newest
+  - pyodbc-newest
   - memcached-newest
   - pylibmc-newest
   - elasticsearch-2

tests/Dockerfile

@@ -1,7 +1,14 @@
 ARG PYTHON_IMAGE
 FROM ${PYTHON_IMAGE}
 
-RUN apt-get update && apt-get -y --no-install-recommends install ca-certificates curl netcat libmemcached-dev freetds-dev &&\
+RUN apt-get update && apt-get -y --no-install-recommends install \
+                                                            ca-certificates \
+                                                            curl \
+                                                            netcat \
+                                                            odbc-postgresql \
+                                                            unixodbc-dev \
+                                                            freetds-dev \
+                                                            libmemcached-dev &&\
     rm -rf /var/lib/apt/lists/*
 
 # connection to ha.pool.sks-keyservers.net fails sometimes, so let's retry with couple different servers

tests/instrumentation/pyodbc_tests.py

@@ -0,0 +1,54 @@
+import os
+
+import pytest
+
+pyodbc = pytest.importorskip("pyodbc")
+
+pytestmark = pytest.mark.pyodbc
+
+
+@pytest.yield_fixture(scope='function')
+def pyodbc_postgres_connection(request):
+    conn_str = (
+        "DRIVER={PostgreSQL Unicode};"
+        "DATABASE=%s;"
+        "UID=%s;"
+        "SERVER=%s;"
+        "PORT=%s;"
+    ) % (
+        os.environ.get('POSTGRES_DB', 'elasticapm_test'),
+        os.environ.get('POSTGRES_USER', 'postgres'),
+        os.environ.get('POSTGRES_HOST', None),
+        os.environ.get('POSTGRES_PORT', None),
+    )
+    conn = pyodbc.connect(conn_str)
+    cursor = conn.cursor()
+    cursor.execute(
+        "CREATE TABLE test(id int, name VARCHAR(5) NOT NULL);"
+        "INSERT INTO test VALUES (1, 'one'), (2, 'two'), (3, 'three');"
+    )
+
+    yield conn
+
+    # cleanup
+    cursor.execute('ROLLBACK')
+
+
+@pytest.mark.integrationtest
+def test_pyodbc_select(instrument, pyodbc_postgres_connection, elasticapm_client):
+    cursor = pyodbc_postgres_connection.cursor()
+    query = "SELECT * FROM test WHERE name LIKE 't%'"
+
+    try:
+        elasticapm_client.begin_transaction("web.django")
+        cursor.execute(query)
+        cursor.fetchall()
+        elasticapm_client.end_transaction(None, "test-transaction")
+    finally:
+        transactions = elasticapm_client.instrumentation_store.get_all()
+        spans = transactions[0]['spans']
+        span = spans[0]
+        assert span['name'] == 'SELECT FROM test'
+        assert 'db' in span['context']
+        assert span['context']['db']['type'] == 'sql'
+        assert span['context']['db']['statement'] == query

tests/requirements/requirements-pyodbc-newest.txt

@@ -0,0 +1,2 @@
+pyodbc
+-r requirements-base.txt

tests/scripts/envs/pyodbc.sh

@@ -0,0 +1,7 @@
+export PYTEST_MARKER="-m pyodbc"
+export DOCKER_DEPS="postgres"
+export POSTGRES_HOST="postgres"
+export POSTGRES_USER="postgres"
+export POSTGRES_DB="elasticapm_test"
+export POSTGRES_HOST="postgres"
+export POSTGRES_PORT="5432"