Update 0.12-dev with 'v0.11.1' release

Author: Emanuele Palazzetti

.circleci/config.yml

@@ -204,8 +204,8 @@ jobs:
       - restore_cache:
           keys:
               - tox-cache-bottle-{{ checksum "tox.ini" }}
-      - run: tox -e '{py27,py34,py35,py36}-bottle{12}-webtest' --result-json /tmp/bottle.1.results
-      - run: tox -e '{py27,py34,py35,py36}-bottle-autopatch{12}-webtest' --result-json /tmp/bottle.2.results
+      - run: tox -e '{py27,py34,py35,py36}-bottle{11,12}-webtest' --result-json /tmp/bottle.1.results
+      - run: tox -e '{py27,py34,py35,py36}-bottle-autopatch{11,12}-webtest' --result-json /tmp/bottle.2.results
       - persist_to_workspace:
           root: /tmp
           paths:

ddtrace/__init__.py

@@ -4,7 +4,7 @@
 from .tracer import Tracer
 from .configuration import Config
 
-__version__ = '0.11.0'
+__version__ = '0.11.1'
 
 # a global tracer instance with integration settings
 tracer = Tracer()

ddtrace/contrib/bottle/trace.py

@@ -1,4 +1,3 @@
-
 # 3p
 from bottle import response, request
 
@@ -10,26 +9,26 @@
 from ...propagation.http import HTTPPropagator
 
 class TracePlugin(object):
-
     name = 'trace'
     api = 2
 
-    def __init__(self, service="bottle", tracer=None, distributed_tracing=None):
+    def __init__(self, service='bottle', tracer=None, distributed_tracing=None):
         self.service = service
         self.tracer = tracer or ddtrace.tracer
+        self.distributed_tracing = distributed_tracing
         self.tracer.set_service_info(
             service=service,
-            app="bottle",
-            app_type=AppTypes.web)
-        self.distributed_tracing = distributed_tracing
+            app='bottle',
+            app_type=AppTypes.web,
+        )
 
     def apply(self, callback, route):
 
         def wrapped(*args, **kwargs):
             if not self.tracer or not self.tracer.enabled:
                 return callback(*args, **kwargs)
 
-            resource = "%s %s" % (request.method, request.route.rule)
+            resource = '{} {}'.format(request.method, route.rule)
 
             # Propagate headers such as x-datadog-trace-id.
             if self.distributed_tracing:
@@ -38,7 +37,7 @@ def wrapped(*args, **kwargs):
                 if context.trace_id:
                     self.tracer.context_provider.activate(context)
 
-            with self.tracer.trace("bottle.request", service=self.service, resource=resource) as s:
+            with self.tracer.trace('bottle.request', service=self.service, resource=resource) as s:
                 code = 0
                 try:
                     return callback(*args, **kwargs)

ddtrace/contrib/django/db.py

@@ -13,20 +13,36 @@
 log = logging.getLogger(__name__)
 
 CURSOR_ATTR = '_datadog_original_cursor'
+ALL_CONNS_ATTR = '_datadog_original_connections_all'
 
 
 def patch_db(tracer):
-    for c in connections.all():
-        patch_conn(tracer, c)
+    if hasattr(connections, ALL_CONNS_ATTR):
+        log.debug('db already patched')
+        return
+    setattr(connections, ALL_CONNS_ATTR, connections.all)
+
+    def all_connections(self):
+        conns = getattr(self, ALL_CONNS_ATTR)()
+        for conn in conns:
+            patch_conn(tracer, conn)
+        return conns
+
+    connections.all = all_connections.__get__(connections, type(connections))
 
 def unpatch_db():
     for c in connections.all():
         unpatch_conn(c)
 
+    all_connections = getattr(connections, ALL_CONNS_ATTR, None)
+    if all_connections is None:
+        log.debug('nothing to do, the db is not patched')
+        return
+    connections.all = all_connections
+    delattr(connections, ALL_CONNS_ATTR)
 
 def patch_conn(tracer, conn):
     if hasattr(conn, CURSOR_ATTR):
-        log.debug("already patched")
         return
 
     setattr(conn, CURSOR_ATTR, conn.cursor)

ddtrace/contrib/django/middleware.py

@@ -11,6 +11,7 @@
 # 3p
 from django.core.exceptions import MiddlewareNotUsed
 from django.conf import settings as django_settings
+import django
 
 try:
     from django.utils.deprecation import MiddlewareMixin
@@ -22,33 +23,37 @@
 
 EXCEPTION_MIDDLEWARE = 'ddtrace.contrib.django.TraceExceptionMiddleware'
 TRACE_MIDDLEWARE = 'ddtrace.contrib.django.TraceMiddleware'
-MIDDLEWARE_ATTRIBUTES = ['MIDDLEWARE', 'MIDDLEWARE_CLASSES']
+MIDDLEWARE = 'MIDDLEWARE'
+MIDDLEWARE_CLASSES = 'MIDDLEWARE_CLASSES'
+
+def get_middleware_insertion_point():
+    """Returns the attribute name and collection object for the Django middleware.
+    If middleware cannot be found, returns None for the middleware collection."""
+    middleware = getattr(django_settings, MIDDLEWARE, None)
+    # Prioritise MIDDLEWARE over ..._CLASSES, but only in 1.10 and later.
+    if middleware and django.VERSION >= (1, 10):
+        return MIDDLEWARE, middleware
+    return MIDDLEWARE_CLASSES, getattr(django_settings, MIDDLEWARE_CLASSES, None)
 
 def insert_trace_middleware():
-    for middleware_attribute in MIDDLEWARE_ATTRIBUTES:
-        middleware = getattr(django_settings, middleware_attribute, None)
-        if middleware is not None and TRACE_MIDDLEWARE not in set(middleware):
-            setattr(django_settings, middleware_attribute, type(middleware)((TRACE_MIDDLEWARE,)) + middleware)
-            break
+    middleware_attribute, middleware = get_middleware_insertion_point()
+    if middleware is not None and TRACE_MIDDLEWARE not in set(middleware):
+        setattr(django_settings, middleware_attribute, type(middleware)((TRACE_MIDDLEWARE,)) + middleware)
 
 def remove_trace_middleware():
-    for middleware_attribute in MIDDLEWARE_ATTRIBUTES:
-        middleware = getattr(django_settings, middleware_attribute, None)
-        if middleware and TRACE_MIDDLEWARE in set(middleware):
-            middleware.remove(TRACE_MIDDLEWARE)
+    _, middleware = get_middleware_insertion_point()
+    if middleware and TRACE_MIDDLEWARE in set(middleware):
+        middleware.remove(TRACE_MIDDLEWARE)
 
 def insert_exception_middleware():
-    for middleware_attribute in MIDDLEWARE_ATTRIBUTES:
-        middleware = getattr(django_settings, middleware_attribute, None)
-        if middleware is not None and EXCEPTION_MIDDLEWARE not in set(middleware):
-            setattr(django_settings, middleware_attribute, middleware + type(middleware)((EXCEPTION_MIDDLEWARE,)))
-            break
+    middleware_attribute, middleware = get_middleware_insertion_point()
+    if middleware is not None and EXCEPTION_MIDDLEWARE not in set(middleware):
+        setattr(django_settings, middleware_attribute, middleware + type(middleware)((EXCEPTION_MIDDLEWARE,)))
 
 def remove_exception_middleware():
-    for middleware_attribute in MIDDLEWARE_ATTRIBUTES:
-        middleware = getattr(django_settings, middleware_attribute, None)
-        if middleware and EXCEPTION_MIDDLEWARE in set(middleware):
-            middleware.remove(EXCEPTION_MIDDLEWARE)
+    _, middleware = get_middleware_insertion_point()
+    if middleware and EXCEPTION_MIDDLEWARE in set(middleware):
+        middleware.remove(EXCEPTION_MIDDLEWARE)
 
 class InstrumentationMixin(MiddlewareClass):
     """

ddtrace/contrib/tornado/__init__.py

@@ -70,8 +70,8 @@ def notify(self):
 * ``enabled`` (default: `True`): define if the tracer is enabled or not. If set to `false`, the
   code is still instrumented but no spans are sent to the APM agent.
 * ``distributed_tracing`` (default: `False`): enable distributed tracing if this is called
-remotely from an instrumented application.
-We suggest to enable it only for internal services where headers are under your control.
+  remotely from an instrumented application.
+  We suggest to enable it only for internal services where headers are under your control.
 * ``agent_hostname`` (default: `localhost`): define the hostname of the APM agent.
 * ``agent_port`` (default: `8126`): define the port of the APM agent.
 """

ddtrace/filters.py

@@ -3,16 +3,15 @@
 from .ext import http
 
 class FilterRequestsOnUrl(object):
-    """Filter out traces from incoming http requests based on the request's url
-
+    """Filter out traces from incoming http requests based on the request's url.
     This class takes as argument a list of regular expression patterns
     representing the urls to be excluded from tracing. A trace will be excluded
-    if its root span contains a http.url tag and if this tag matches any of
+    if its root span contains a ``http.url`` tag and if this tag matches any of
     the provided regular expression using the standard python regexp match
     semantic (https://docs.python.org/2/library/re.html#re.match).
 
-    :param list regexps: the  list of regular expressions (as strings) defining
-    the urls that should be filtered out. (a single string is also accepted)
+    :param list regexps: a list of regular expressions (or a single string) defining
+                         the urls that should be filtered out.
 
     Examples:
 
@@ -27,8 +26,6 @@ class FilterRequestsOnUrl(object):
     To filter out calls to both http://test.example.com and http://example.com/healthcheck::
 
         FilterRequestOnUrl([r'http://test\.example\.com', r'http://example\.com/healthcheck'])
-
-
     """
     def __init__(self, regexps):
         if isinstance(regexps, str):

docs/index.rst

@@ -73,7 +73,7 @@ Instrumentation
 Web
 ~~~
 
-We support many `Web Frameworks`_. Install the middleware for yours.
+We support many :ref:`web-frameworks`. Install the middleware for yours.
 
 Databases
 ~~~~~~~~~
@@ -124,6 +124,8 @@ If the Datadog Agent is on a separate host from your application, you can modify
 
 By default, these will be set to localhost and 8126 respectively.
 
+.. _web-frameworks:
+
 Web Frameworks
 --------------
 
@@ -251,7 +253,7 @@ Redis
 .. automodule:: ddtrace.contrib.redis
 
 Requests
-~~~~~
+~~~~~~~~
 
 .. automodule:: ddtrace.contrib.requests
 
@@ -527,61 +529,61 @@ Supported versions
 
 We officially support Python 2.7, 3.4 and above.
 
-+-----------------+--------------------+
-| Integrations    | Supported versions |
-+=================+====================+
-| aiohttp         | >= 1.2             |
-+-----------------+--------------------+
-| aiobotocore     | >= 0.2.3           |
-+-----------------+--------------------+
-| aiopg           | >= 0.12.0          |
-+-----------------+--------------------+
-| boto            | >= 2.29.0          |
-+-----------------+--------------------+
-| botocore        | >= 1.4.51          |
-+-----------------+--------------------+
-| bottle          | >= 0.12            |
-+-----------------+--------------------+
-| celery          | >= 3.1             |
-+-----------------+--------------------+
-| cassandra       | >= 3.5             |
-+---------------------+----------------+
-| djangorestframework | >= 3.4         |
-+---------------------+----------------+
-| django          | >= 1.8             |
-+-----------------+--------------------+
-| elasticsearch   | >= 1.6             |
-+-----------------+--------------------+
-| falcon          | >= 1.0             |
-+-----------------+--------------------+
-| flask           | >= 0.10            |
-+-----------------+--------------------+
-| flask_cache     | >= 0.12            |
-+-----------------+--------------------+
-| gevent          | >= 1.0             |
-+-----------------+--------------------+
-| mongoengine     | >= 0.11            |
-+-----------------+--------------------+
-| mysql-connector | >= 2.1             |
-+-----------------+--------------------+
-| MySQL-python    | >= 1.2.3           |
-+-----------------+--------------------+
-| mysqlclient     | >= 1.3             |
-+-----------------+--------------------+
-| psycopg2        | >= 2.4             |
-+-----------------+--------------------+
-| pylibmc         | >= 1.4             |
-+-----------------+--------------------+
-| pylons          | >= 0.9.6           |
-+-----------------+--------------------+
-| pymongo         | >= 3.0             |
-+-----------------+--------------------+
-| pyramid         | >= 1.7             |
-+-----------------+--------------------+
-| redis           | >= 2.6             |
-+-----------------+--------------------+
-| sqlalchemy      | >= 1.0             |
-+-----------------+--------------------+
++---------------------+--------------------+
+| Integrations        | Supported versions |
++=====================+====================+
+| aiohttp             | >= 1.2             |
++---------------------+--------------------+
+| aiobotocore         | >= 0.2.3           |
++---------------------+--------------------+
+| aiopg               | >= 0.12.0          |
++---------------------+--------------------+
+| boto                | >= 2.29.0          |
++---------------------+--------------------+
+| botocore            | >= 1.4.51          |
++---------------------+--------------------+
+| bottle              | >= 0.11            |
++---------------------+--------------------+
+| celery              | >= 3.1             |
++---------------------+--------------------+
+| cassandra           | >= 3.5             |
++---------------------+--------------------+
+| djangorestframework | >= 3.4             |
++---------------------+--------------------+
+| django              | >= 1.8             |
++---------------------+--------------------+
+| elasticsearch       | >= 1.6             |
++---------------------+--------------------+
+| falcon              | >= 1.0             |
++---------------------+--------------------+
+| flask               | >= 0.10            |
++---------------------+--------------------+
+| flask_cache         | >= 0.12            |
++---------------------+--------------------+
+| gevent              | >= 1.0             |
++---------------------+--------------------+
+| mongoengine         | >= 0.11            |
++---------------------+--------------------+
+| mysql-connector     | >= 2.1             |
++---------------------+--------------------+
+| MySQL-python        | >= 1.2.3           |
++---------------------+--------------------+
+| mysqlclient         | >= 1.3             |
++---------------------+--------------------+
+| psycopg2            | >= 2.4             |
++---------------------+--------------------+
+| pylibmc             | >= 1.4             |
++---------------------+--------------------+
+| pylons              | >= 0.9.6           |
++---------------------+--------------------+
+| pymongo             | >= 3.0             |
++---------------------+--------------------+
+| pyramid             | >= 1.7             |
++---------------------+--------------------+
+| redis               | >= 2.6             |
++---------------------+--------------------+
+| sqlalchemy          | >= 1.0             |
++---------------------+--------------------+
 
 
 These are the fully tested versions but `ddtrace` can be compatible with lower versions.

tests/contrib/django/app/settings.py

@@ -84,7 +84,7 @@
     ]
 
 # Django 2.0 has different defaults
-if django.VERSION >= (2, 0):
+elif django.VERSION >= (2, 0):
     MIDDLEWARE = [
         'django.contrib.sessions.middleware.SessionMiddleware',
         'django.middleware.common.CommonMiddleware',
@@ -97,20 +97,20 @@
         'tests.contrib.django.app.middlewares.CatchExceptionMiddleware',
     ]
 
-# Always add the legacy conf to make sure we handle it properly
 # Pre 1.10 style
-MIDDLEWARE_CLASSES = [
-    'django.contrib.sessions.middleware.SessionMiddleware',
-    'django.middleware.common.CommonMiddleware',
-    'django.middleware.csrf.CsrfViewMiddleware',
-    'django.contrib.auth.middleware.AuthenticationMiddleware',
-    'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
-    'django.contrib.messages.middleware.MessageMiddleware',
-    'django.middleware.clickjacking.XFrameOptionsMiddleware',
-    'django.middleware.security.SecurityMiddleware',
+else:
+    MIDDLEWARE_CLASSES = [
+        'django.contrib.sessions.middleware.SessionMiddleware',
+        'django.middleware.common.CommonMiddleware',
+        'django.middleware.csrf.CsrfViewMiddleware',
+        'django.contrib.auth.middleware.AuthenticationMiddleware',
+        'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
+        'django.contrib.messages.middleware.MessageMiddleware',
+        'django.middleware.clickjacking.XFrameOptionsMiddleware',
+        'django.middleware.security.SecurityMiddleware',
 
-    'tests.contrib.django.app.middlewares.CatchExceptionMiddleware',
-]
+        'tests.contrib.django.app.middlewares.CatchExceptionMiddleware',
+    ]
 
 INSTALLED_APPS = [
     'django.contrib.admin',