Add support for configure transport in Django middleware (#83)

Author: liyanhui1228

trace/opencensus/trace/ext/django/config.py

@@ -28,17 +28,18 @@
 DEFAULT_DJANGO_TRACER_PARAMS = {
     # https://cloud.google.com/appengine/docs/flexible/python/
     # how-instances-are-managed#health_checking
-    'BLACKLIST_PATHS': ['/_ah/health'],
+    'BLACKLIST_PATHS': ['_ah/health'],
     'GCP_EXPORTER_PROJECT': None,
     'SAMPLING_RATE': 0.5,
     'ZIPKIN_EXPORTER_SERVICE_NAME': 'my_service',
     'ZIPKIN_EXPORTER_HOST_NAME': 'localhost',
     'ZIPKIN_EXPORTER_PORT': 9411,
-
+    'TRANSPORT': 'opencensus.trace.exporters.transports.sync.SyncTransport',
 }
 
 
 PATH_DELIMITER = '.'
+TRANSPORT = 'TRANSPORT'
 
 log = logging.getLogger(__name__)
 
@@ -61,6 +62,12 @@ def __init__(self):
             'OPENCENSUS_TRACE_PARAMS',
             DEFAULT_DJANGO_TRACER_PARAMS)
 
+        # Set default value for the tracer config if user not specified
+        _set_default_configs(self.settings, DEFAULT_DJANGO_TRACER_CONFIG)
+
+        # Set default value for the params if user not specified
+        _set_default_configs(self.params, DEFAULT_DJANGO_TRACER_PARAMS)
+
     def __getattr__(self, attr):
         # If not in defaults, it is something we cannot parse.
         if attr not in DEFAULT_DJANGO_TRACER_CONFIG:
@@ -74,6 +81,17 @@ def __getattr__(self, attr):
         return module_class
 
 
+def _set_default_configs(user_settings, default):
+    """Set the default value to user settings if user not specified
+    the value.
+    """
+    for key in default:
+        if key not in user_settings:
+            user_settings[key] = default[key]
+
+    return user_settings
+
+
 def convert_to_import(path):
     """Given a string which represents the import path, convert to the
     class to import.

trace/opencensus/trace/ext/django/middleware.py

@@ -16,7 +16,7 @@
 import logging
 
 from opencensus.trace.ext import utils
-from opencensus.trace.ext.django.config import settings
+from opencensus.trace.ext.django.config import (settings, convert_to_import)
 from opencensus.trace import labels_helper
 from opencensus.trace import request_tracer
 from opencensus.trace import execution_context
@@ -38,6 +38,7 @@
 BLACKLIST_PATHS = 'BLACKLIST_PATHS'
 GCP_EXPORTER_PROJECT = 'GCP_EXPORTER_PROJECT'
 SAMPLING_RATE = 'SAMPLING_RATE'
+TRANSPORT = 'TRANSPORT'
 ZIPKIN_EXPORTER_SERVICE_NAME = 'ZIPKIN_EXPORTER_SERVICE_NAME'
 ZIPKIN_EXPORTER_HOST_NAME = 'ZIPKIN_EXPORTER_HOST_NAME'
 ZIPKIN_EXPORTER_PORT = 'ZIPKIN_EXPORTER_PORT'
@@ -112,9 +113,13 @@ def __init__(self, get_response=None):
             self.sampler = self._sampler()
 
         # Initialize the exporter
+        transport = convert_to_import(settings.params.get(TRANSPORT))
+
         if self._exporter.__name__ == 'GoogleCloudExporter':
             _project_id = settings.params.get(GCP_EXPORTER_PROJECT, None)
-            self.exporter = self._exporter(project_id=_project_id)
+            self.exporter = self._exporter(
+                project_id=_project_id,
+                transport=transport)
         elif self._exporter.__name__ == 'ZipkinExporter':
             _zipkin_service_name = settings.params.get(
                 ZIPKIN_EXPORTER_SERVICE_NAME, 'my_service')
@@ -125,9 +130,10 @@ def __init__(self, get_response=None):
             self.exporter = self._exporter(
                 service_name=_zipkin_service_name,
                 host_name=_zipkin_host_name,
-                port=_zipkin_port)
+                port=_zipkin_port,
+                transport=transport)
         else:
-            self.exporter = self._exporter()
+            self.exporter = self._exporter(transport=transport)
 
         # Initialize the propagator
         self.propagator = self._propagator()

trace/tests/system/django/app/settings.py

@@ -91,7 +91,8 @@
 
 OPENCENSUS_TRACE_PARAMS = {
     'SAMPLING_RATE': 0.5,
-    'BLACKLIST_PATHS': ['_ah/health',]
+    'BLACKLIST_PATHS': ['_ah/health',],
+    'TRANSPORT': 'opencensus.trace.exporters.transports.sync.SyncTransport',
 }
 
 # Internationalization

trace/tests/system/django/app/views.py

@@ -40,12 +40,10 @@
 
 
 def home(request):
-    time.sleep(1)
     return render(request, 'home.html')
 
 
 def greetings(request):
-    time.sleep(1)
     if request.method == 'POST':
         form = HelloForm(request.POST)
 

trace/tests/unit/ext/django/test_config.py

@@ -60,6 +60,36 @@ def test__getattr___valid(self):
         assert isinstance(sampler_class(), AlwaysOnSampler)
 
 
+class Test__set_default_configs(unittest.TestCase):
+
+    def test__set_default_configs(self):
+        from opencensus.trace.ext.django import config
+
+        custom_django_params = {
+            'SAMPLING_RATE': 0.6,
+            'BLACKLIST_PATHS': ['_ah/health', ],
+            'TRANSPORT':
+                'opencensus.trace.exporters.transports.sync.SyncTransport',
+        }
+
+        params = config._set_default_configs(
+            custom_django_params,
+            config.DEFAULT_DJANGO_TRACER_PARAMS)
+
+        expected_params = {
+            'BLACKLIST_PATHS': ['_ah/health', ],
+            'GCP_EXPORTER_PROJECT': None,
+            'SAMPLING_RATE': 0.6,
+            'ZIPKIN_EXPORTER_SERVICE_NAME': 'my_service',
+            'ZIPKIN_EXPORTER_HOST_NAME': 'localhost',
+            'ZIPKIN_EXPORTER_PORT': 9411,
+            'TRANSPORT':
+                'opencensus.trace.exporters.transports.sync.SyncTransport',
+        }
+
+        self.assertEqual(params, expected_params)
+
+
 class Test_convert_to_import(unittest.TestCase):
 
     def test_convert_to_import(self):

trace/tests/unit/ext/django/test_middleware.py

@@ -39,16 +39,20 @@ def test_constructor_cloud(self):
         from opencensus.trace.ext.django import middleware
         from opencensus.trace.samplers import always_on
         from opencensus.trace.propagation import google_cloud_format
+        from opencensus.trace.exporters.transports import sync
 
         class MockCloudExporter(object):
-            def __init__(self, project_id):
+            def __init__(self, project_id, transport):
                 self.project_id = project_id
+                self.transport = transport
 
         MockCloudExporter.__name__ = 'GoogleCloudExporter'
 
         project_id = 'my_project'
         params = {
             'GCP_EXPORTER_PROJECT': project_id,
+            'TRANSPORT':
+                'opencensus.trace.exporters.transports.sync.SyncTransport',
         }
 
         patch_params = mock.patch(
@@ -75,6 +79,7 @@ def __init__(self, project_id):
             google_cloud_format.GoogleCloudFormatPropagator)
 
         self.assertEqual(middleware.exporter.project_id, project_id)
+        self.assertEqual(middleware.exporter.transport, sync.SyncTransport)
 
     def test_constructor_zipkin(self):
         from opencensus.trace.ext.django import middleware
@@ -89,6 +94,8 @@ def test_constructor_zipkin(self):
             'ZIPKIN_EXPORTER_SERVICE_NAME': service_name,
             'ZIPKIN_EXPORTER_HOST_NAME': host_name,
             'ZIPKIN_EXPORTER_PORT': port,
+            'TRANSPORT':
+                'opencensus.trace.exporters.transports.sync.SyncTransport',
         }
 
         patch_zipkin = mock.patch(
@@ -129,6 +136,8 @@ def test_constructor_probability_sampler(self):
         rate = 0.8
         params = {
             'SAMPLING_RATE': 0.8,
+            'TRANSPORT':
+                'opencensus.trace.exporters.transports.sync.SyncTransport',
         }
 
         patch_sampler = mock.patch(
@@ -210,7 +219,10 @@ def test_blacklist_path(self):
         execution_context.clear()
 
         blacklist_paths = ['test_blacklist_path',]
-        params = {'BLACKLIST_PATHS': ['test_blacklist_path',]}
+        params = {
+            'BLACKLIST_PATHS': ['test_blacklist_path',],
+            'TRANSPORT':
+                'opencensus.trace.exporters.transports.sync.SyncTransport',}
         patch_params = mock.patch(
             'opencensus.trace.ext.django.middleware.settings.params',
             params)