Merge pull request #421 from palazzem/dbapi-query-tag

[dbapi] remove `sql.query` tag so that the content is obfuscated in the Agent

Author: Emanuele Palazzetti

ddtrace/contrib/dbapi/__init__.py

@@ -33,7 +33,6 @@ def _trace_method(self, method, resource, extra_tags, *args, **kwargs):
 
         with pin.tracer.trace(self._self_datadog_name, service=service, resource=resource) as s:
             s.span_type = sql.TYPE
-            s.set_tag(sql.QUERY, resource)
             s.set_tags(pin.tags)
             s.set_tags(extra_tags)
 

tests/contrib/mysql/test_mysql.py

@@ -1,6 +1,6 @@
 # 3p
 import mysql
-from nose.tools import eq_
+from nose.tools import eq_, ok_
 
 # project
 from ddtrace import Pin
@@ -11,14 +11,19 @@
 
 
 class MySQLCore(object):
-
-    # Reuse the connection across tests
+    """Base test case for MySQL drivers"""
     conn = None
     TEST_SERVICE = 'test-mysql'
 
     def tearDown(self):
-        if self.conn and self.conn.is_connected():
-            self.conn.close()
+        # Reuse the connection across tests
+        if self.conn:
+            try:
+                self.conn.ping()
+            except MySQLdb.InterfaceError:
+                pass
+            else:
+                self.conn.close()
         unpatch()
 
     def _get_conn_tracer(self):
@@ -45,9 +50,7 @@ def test_simple_query(self):
             'out.port': u'3306',
             'db.name': u'test',
             'db.user': u'test',
-            'sql.query': u'SELECT 1',
         })
-        # eq_(span.get_metric('sql.rows'), -1)
 
     def test_query_with_several_rows(self):
         conn, tracer = self._get_conn_tracer()
@@ -60,8 +63,7 @@ def test_query_with_several_rows(self):
         spans = writer.pop()
         eq_(len(spans), 1)
         span = spans[0]
-        eq_(span.get_tag('sql.query'), query)
-        # eq_(span.get_tag('sql.rows'), 3)
+        ok_(span.get_tag('sql.query') is None)
 
     def test_query_many(self):
         # tests that the executemany method is correctly wrapped.
@@ -92,7 +94,7 @@ def test_query_many(self):
         spans = writer.pop()
         eq_(len(spans), 2)
         span = spans[-1]
-        eq_(span.get_tag('sql.query'), query)
+        ok_(span.get_tag('sql.query') is None)
         cursor.execute("drop table if exists dummy")
 
     def test_query_proc(self):
@@ -132,9 +134,8 @@ def test_query_proc(self):
             'out.port': u'3306',
             'db.name': u'test',
             'db.user': u'test',
-            'sql.query': u'sp_sum',
         })
-        # eq_(span.get_metric('sql.rows'), 1)
+        ok_(span.get_tag('sql.query') is None)
 
 
 class TestMysqlPatch(MySQLCore):
@@ -197,8 +198,8 @@ def test_patch_unpatch(self):
                 'out.port': u'3306',
                 'db.name': u'test',
                 'db.user': u'test',
-                'sql.query': u'SELECT 1',
             })
+            ok_(span.get_tag('sql.query') is None)
 
         finally:
             unpatch()

tests/contrib/mysqldb/test_mysql.py

@@ -3,7 +3,7 @@
 from ddtrace import Pin
 from ddtrace.contrib.mysqldb.patch import patch, unpatch
 
-from nose.tools import eq_
+from nose.tools import eq_, ok_
 
 from ..config import MYSQL_CONFIG
 from ...util import assert_dict_issuperset
@@ -53,7 +53,6 @@ def test_simple_query(self):
             'out.port': u'3306',
             'db.name': u'test',
             'db.user': u'test',
-            'sql.query': u'SELECT 1',
         })
 
     def test_simple_query_with_positional_args(self):
@@ -76,7 +75,6 @@ def test_simple_query_with_positional_args(self):
             'out.port': u'3306',
             'db.name': u'test',
             'db.user': u'test',
-            'sql.query': u'SELECT 1',
         })
 
     def test_query_with_several_rows(self):
@@ -90,7 +88,7 @@ def test_query_with_several_rows(self):
         spans = writer.pop()
         eq_(len(spans), 1)
         span = spans[0]
-        eq_(span.get_tag('sql.query'), query)
+        ok_(span.get_tag('sql.query') is None)
 
     def test_query_many(self):
         # tests that the executemany method is correctly wrapped.
@@ -123,7 +121,7 @@ def test_query_many(self):
         spans = writer.pop()
         eq_(len(spans), 2)
         span = spans[-1]
-        eq_(span.get_tag('sql.query'), query)
+        ok_(span.get_tag('sql.query') is None)
         cursor.execute("drop table if exists dummy")
 
     def test_query_proc(self):
@@ -166,8 +164,8 @@ def test_query_proc(self):
             'out.port': u'3306',
             'db.name': u'test',
             'db.user': u'test',
-            'sql.query': u'sp_sum',
         })
+        ok_(span.get_tag('sql.query') is None)
 
 
 class TestMysqlPatch(MySQLCore):
@@ -252,8 +250,8 @@ def test_patch_unpatch(self):
                 'out.port': u'3306',
                 'db.name': u'test',
                 'db.user': u'test',
-                'sql.query': u'SELECT 1',
             })
+            ok_(span.get_tag('sql.query') is None)
 
         finally:
             unpatch()

tests/contrib/psycopg/test_psycopg.py

@@ -6,7 +6,7 @@
 from psycopg2 import _psycopg
 from psycopg2 import extensions
 from psycopg2 import extras
-from nose.tools import eq_
+from nose.tools import eq_, ok_
 
 # project
 from ddtrace.contrib.psycopg import connection_factory
@@ -56,7 +56,7 @@ def assert_conn_is_traced(self, tracer, db, service):
         eq_(span.name, "postgres.query")
         eq_(span.resource, q)
         eq_(span.service, service)
-        eq_(span.meta["sql.query"], q)
+        ok_(span.get_tag("sql.query") is None)
         eq_(span.error, 0)
         eq_(span.span_type, "sql")
         assert start <= span.start <= end
@@ -78,7 +78,7 @@ def assert_conn_is_traced(self, tracer, db, service):
         eq_(span.name, "postgres.query")
         eq_(span.resource, q)
         eq_(span.service, service)
-        eq_(span.meta["sql.query"], q)
+        ok_(span.get_tag("sql.query") is None)
         eq_(span.error, 1)
         eq_(span.meta["out.host"], "localhost")
         eq_(span.meta["out.port"], TEST_PORT)

tests/contrib/sqlite3/test_sqlite3.py

@@ -3,7 +3,7 @@
 import time
 
 # 3p
-from nose.tools import eq_
+from nose.tools import eq_, ok_
 
 # project
 import ddtrace
@@ -78,7 +78,7 @@ def test_sqlite(self):
             eq_(span.span_type, "sql")
             eq_(span.resource, q)
             eq_(span.service, service)
-            eq_(span.meta["sql.query"], q)
+            ok_(span.get_tag("sql.query") is None)
             eq_(span.error, 0)
             assert start <= span.start <= end
             assert span.duration <= end - start
@@ -98,7 +98,7 @@ def test_sqlite(self):
             eq_(span.name, "sqlite.query")
             eq_(span.resource, q)
             eq_(span.service, service)
-            eq_(span.meta["sql.query"], q)
+            ok_(span.get_tag("sql.query") is None)
             eq_(span.error, 1)
             eq_(span.span_type, "sql")
             assert span.get_tag(errors.ERROR_STACK)