Merge pull request #3 from instana/post_import_hooks

Auto instrumentation using post import hooks

Author: pglombardo

.travis.yml

@@ -1,6 +1,5 @@
 language: python
 python:
   - "2.7"
-  - "3.6"
 install: "pip install -r requirements.txt"
-script: nosetests
+script: nosetests -v

README.md

@@ -16,34 +16,17 @@ Any and all feedback is welcome.  Happy Python visibility.
 
 ## Installation
 
-The instana package is [hosted on pypi](https://pypi.python.org/pypi/instana) and can be installed with:
+There are two steps required to install the the Instana package for your applications:
 
-    $ pip install instana
+1. `pip install instana` into the virtual-env or container ([hosted on pypi](https://pypi.python.org/pypi/instana))
+
+2. Enable instrumentation for the frameworks in use by setting an environment variable:
+  `AUTOWRAPT_BOOTSTRAP=instana.django`
 
 ## Usage
 
 The instana package will automatically collect key metrics from your Python processes.  Just install and go.
 
-## Django Middleware
-
-For the initial BETA, Django instrumentation must be manually inserted into the Django middleware list.  This will be automated before post BETA release.
-
-in `myapp/settings.py`:
-```python
-import instana.middleware
-
-MIDDLEWARE = [
-    'instana.middleware.InstanaMiddleware',            # Add Instana at the start of the list
-    'django.middleware.security.SecurityMiddleware',
-    'django.contrib.sessions.middleware.SessionMiddleware',
-    'django.middleware.common.CommonMiddleware',
-    'django.middleware.csrf.CsrfViewMiddleware',
-    'django.contrib.auth.middleware.AuthenticationMiddleware',
-    'django.contrib.messages.middleware.MessageMiddleware',
-    'django.middleware.clickjacking.XFrameOptionsMiddleware',
-]
-```
-
 ## Tracing
 
 This Python package supports [OpenTracing](http://opentracing.io/).

instana/middleware.py renamed to instana/django.py

@@ -1,9 +1,13 @@
+from __future__ import print_function
 import opentracing as ot
 from instana import tracer
 import opentracing.ext.tags as ext
 
+DJ_INSTANA_MIDDLEWARE = 'instana.django.InstanaMiddleware'
+
 
 class InstanaMiddleware(object):
+    """ Django Middleware to provide request tracing for Instana """
     def __init__(self, get_response):
         self.get_response = get_response
         ot.global_tracer = tracer.InstanaTracer()
@@ -28,3 +32,18 @@ def __call__(self, request):
         ot.global_tracer.inject(span.context, ot.Format.HTTP_HEADERS, response)
         span.finish()
         return response
+
+
+def hook(module):
+    """ Hook method to install the Instana middleware into Django """
+    if DJ_INSTANA_MIDDLEWARE in module.settings.MIDDLEWARE:
+        return
+
+    if type(module.settings.MIDDLEWARE) is tuple:
+        module.settings.MIDDLEWARE = (
+                DJ_INSTANA_MIDDLEWARE,) + module.settings.MIDDLEWARE
+    elif type(module.settings.MIDDLEWARE) is list:
+        module.settings.MIDDLEWARE = [
+                DJ_INSTANA_MIDDLEWARE] + module.settings.MIDDLEWARE
+    else:
+        print("Instana: Couldn't add InstanaMiddleware to Django")

instana/fsm.py

@@ -111,7 +111,7 @@ def announce_sensor(self, e):
             return True
 
     def schedule_retry(self, fun, e, name):
-        l.error("Scheduling: " + name)
+        l.debug("Scheduling: " + name)
         self.timer = t.Timer(self.RETRY_PERIOD, fun, [e])
         self.timer.daemon = True
         self.timer.name = name

instana/recorder.py

@@ -6,6 +6,7 @@
 import instana.span as sd
 import Queue
 import time
+import os
 
 
 class InstanaRecorder(SpanRecorder):
@@ -60,7 +61,7 @@ def record_span(self, span):
         Convert the passed BasicSpan into an InstanaSpan and
         add it to the span queue
         """
-        if self.sensor.agent.can_send():
+        if self.sensor.agent.can_send() or os.environ["INSTANA_TEST"]:
             instana_span = None
 
             if span.operation_name in self.registered_spans:

requirements.txt

@@ -3,3 +3,4 @@ fysom>=2.1.2
 opentracing>=1.2.1
 basictracer>=2.2.0
 psutil>=5.1.3
+autowrapt>=1.0

setup.py

@@ -1,7 +1,7 @@
 from setuptools import setup, find_packages
 
 setup(name='instana',
-      version='0.0.1.2',
+      version='0.4.0',
       download_url='https://github.com/instana/python-sensor',
       url='https://www.instana.com/',
       license='MIT',
@@ -11,11 +11,13 @@
       packages=find_packages(exclude=['tests', 'examples']),
       long_description="The instana package provides Python metrics and traces for Instana.",
       zip_safe=False,
-      setup_requires=['nose>=1.0',
-                      'fysom>=2.1.2',
-                      'opentracing>=1.2.1,<1.3',
-                      'basictracer>=2.2.0',
-                      'psutil>=5.1.3'],
+      setup_requires=['nose>=1.0'],
+      install_requires=['autowrapt>=1.0',
+                        'fysom>=2.1.2',
+                        'opentracing>=1.2.1,<1.3',
+                        'basictracer>=2.2.0',
+                        'psutil>=5.1.3'],
+      entry_points={'instana.django': ['django.core.handlers.base = instana.django:hook']},
       test_suite='nose.collector',
       keywords=['performance', 'opentracing', 'metrics', 'monitoring'],
       classifiers=[