Allow configuring different Sampler in Django App (#252)

Extended aws_xray_sdk.ext.django app to be able to select Sampler, and avoid being stuck with the DefaultSampler

Co-authored-by: Prashant Srivastava <[email protected]>

Author: lalvarezguillen

aws_xray_sdk/ext/django/apps.py

@@ -30,6 +30,7 @@ def ready(self):
             daemon_address=settings.AWS_XRAY_DAEMON_ADDRESS,
             sampling=settings.SAMPLING,
             sampling_rules=settings.SAMPLING_RULES,
+            sampler=settings.SAMPLER,
             context_missing=settings.AWS_XRAY_CONTEXT_MISSING,
             plugins=settings.PLUGINS,
             service=settings.AWS_XRAY_TRACING_NAME,

aws_xray_sdk/ext/django/conf.py

@@ -10,6 +10,7 @@
     'PLUGINS': (),
     'SAMPLING': True,
     'SAMPLING_RULES': None,
+    'SAMPLER': None,
     'AWS_XRAY_TRACING_NAME': None,
     'DYNAMIC_NAMING': None,
     'STREAMING_THRESHOLD': None,

tests/ext/django/app/settings.py

@@ -2,6 +2,7 @@
 Config file for a django app used by django testing client
 """
 import os
+from aws_xray_sdk.core.sampling.sampler import LocalSampler
 
 
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
@@ -60,6 +61,7 @@
 XRAY_RECORDER = {
     'AWS_XRAY_TRACING_NAME': 'django',
     'SAMPLING': False,
+    'SAMPLER': LocalSampler(),
 }
 
 LANGUAGE_CODE = 'en-us'

tests/ext/django/test_settings.py

@@ -0,0 +1,16 @@
+from unittest import mock
+
+import django
+from aws_xray_sdk import global_sdk_config
+from django.test import TestCase, override_settings
+from django.conf import settings
+from django.apps import apps
+
+from aws_xray_sdk.core import xray_recorder
+from aws_xray_sdk.core.sampling.sampler import LocalSampler
+
+
+class XRayConfigurationTestCase(TestCase):
+    def test_sampler_can_be_configured(self):
+        assert isinstance(settings.XRAY_RECORDER['SAMPLER'], LocalSampler)
+        assert isinstance(xray_recorder.sampler, LocalSampler)