Merge pull request #828 from DataDog/majorgreys/trace-search-on-default

Trace search client configuration

Author: majorgreys

ddtrace/constants.py

@@ -1,7 +1,7 @@
 FILTERS_KEY = 'FILTERS'
 SAMPLE_RATE_METRIC_KEY = '_sample_rate'
 SAMPLING_PRIORITY_KEY = '_sampling_priority_v1'
+ANALYTICS_SAMPLE_RATE_KEY = '_dd1.sr.eausr'
 ORIGIN_KEY = '_dd.origin'
-EVENT_SAMPLE_RATE_KEY = '_dd1.sr.eausr'
 
-NUMERIC_TAGS = (EVENT_SAMPLE_RATE_KEY, )
+NUMERIC_TAGS = (ANALYTICS_SAMPLE_RATE_KEY, )

ddtrace/contrib/aiobotocore/__init__.py

@@ -1,7 +1,7 @@
 """
 The aiobotocore integration will trace all AWS calls made with the ``aiobotocore``
 library. This integration isn't enabled when applying the default patching.
-To enable it, you must run ``patch_all(botocore=True)``
+To enable it, you must run ``patch_all(aiobotocore=True)``
 
 ::
 

ddtrace/contrib/aiobotocore/patch.py

@@ -1,9 +1,11 @@
 import asyncio
 from ddtrace.vendor import wrapt
+from ddtrace import config
 import aiobotocore.client
 
 from aiobotocore.endpoint import ClientResponseContentProxy
 
+from ...constants import ANALYTICS_SAMPLE_RATE_KEY
 from ...pin import Pin
 from ...ext import http, aws
 from ...compat import PYTHON_VERSION_INFO
@@ -117,4 +119,10 @@ def _wrapped_api_call(original_func, instance, args, kwargs):
         if request_id2:
             span.set_tag('aws.requestid2', request_id2)
 
+        # set analytics sample rate
+        span.set_tag(
+            ANALYTICS_SAMPLE_RATE_KEY,
+            config.aiobotocore.get_analytics_sample_rate()
+        )
+
         return result

ddtrace/contrib/aiohttp/__init__.py

@@ -32,6 +32,7 @@
 * ``distributed_tracing_enabled`` (default: ``True``): enable distributed tracing during
   the middleware execution, so that a new span is created with the given ``trace_id`` and
   ``parent_id`` injected via request headers.
+* ``analytics_enabled`` (default: ``None``): enables APM events in Trace Search & Analytics.
 
 Third-party modules that are currently supported by the ``patch()`` method are:
 

ddtrace/contrib/aiohttp/middlewares.py

@@ -2,8 +2,8 @@
 
 from ..asyncio import context_provider
 from ...compat import stringify
-from ...constants import EVENT_SAMPLE_RATE_KEY
-from ...ext import AppTypes, http
+from ...constants import ANALYTICS_SAMPLE_RATE_KEY
+from ...ext import http
 from ...propagation.http import HTTPPropagator
 from ...settings import config
 
@@ -47,8 +47,13 @@ def attach_context(request):
         )
 
         # Configure trace search sample rate
-        if config.aiohttp.event_sample_rate is not None:
-            request_span.set_tag(EVENT_SAMPLE_RATE_KEY, config.aiohttp.event_sample_rate)
+        # DEV: aiohttp is special case maintains separate configuration from config api
+        analytics_enabled = app[CONFIG_KEY]['analytics_enabled']
+        if (config.analytics_enabled and analytics_enabled is not False) or analytics_enabled is True:
+            request_span.set_tag(
+                ANALYTICS_SAMPLE_RATE_KEY,
+                app[CONFIG_KEY].get('analytics_sample_rate', True)
+            )
 
         # attach the context and the root span to the request; the Context
         # may be freely used by the application code
@@ -118,6 +123,8 @@ def trace_app(app, tracer, service='aiohttp-web'):
         'tracer': tracer,
         'service': service,
         'distributed_tracing_enabled': True,
+        'analytics_enabled': None,
+        'analytics_sample_rate': 1.0,
     }
 
     # the tracer must work with asynchronous Context propagation

ddtrace/contrib/boto/patch.py

@@ -2,6 +2,8 @@
 from ddtrace.vendor import wrapt
 import inspect
 
+from ddtrace import config
+from ...constants import ANALYTICS_SAMPLE_RATE_KEY
 from ...pin import Pin
 from ...ext import http, aws
 from ...utils.wrappers import unwrap
@@ -97,6 +99,12 @@ def patched_query_request(original_func, instance, args, kwargs):
         span.set_tag(http.STATUS_CODE, getattr(result, "status"))
         span.set_tag(http.METHOD, getattr(result, "_method"))
 
+        # set analytics sample rate
+        span.set_tag(
+            ANALYTICS_SAMPLE_RATE_KEY,
+            config.boto.get_analytics_sample_rate()
+        )
+
         return result
 
 
@@ -152,6 +160,12 @@ def patched_auth_request(original_func, instance, args, kwargs):
         span.set_tag(http.STATUS_CODE, getattr(result, "status"))
         span.set_tag(http.METHOD, getattr(result, "_method"))
 
+        # set analytics sample rate
+        span.set_tag(
+            ANALYTICS_SAMPLE_RATE_KEY,
+            config.boto.get_analytics_sample_rate()
+        )
+
         return result
 
 

ddtrace/contrib/botocore/patch.py

@@ -3,9 +3,11 @@
 """
 # 3p
 from ddtrace.vendor import wrapt
+from ddtrace import config
 import botocore.client
 
 # project
+from ...constants import ANALYTICS_SAMPLE_RATE_KEY
 from ...pin import Pin
 from ...ext import http, aws
 from ...utils.formats import deep_getattr
@@ -71,4 +73,10 @@ def patched_api_call(original_func, instance, args, kwargs):
         span.set_tag(http.STATUS_CODE, result['ResponseMetadata']['HTTPStatusCode'])
         span.set_tag("retry_attempts", result['ResponseMetadata']['RetryAttempts'])
 
+        # set analytics sample rate
+        span.set_tag(
+            ANALYTICS_SAMPLE_RATE_KEY,
+            config.botocore.get_analytics_sample_rate()
+        )
+
         return result

ddtrace/contrib/bottle/trace.py

@@ -3,10 +3,10 @@
 
 # stdlib
 import ddtrace
-from ddtrace.ext import http
 
 # project
-from ...constants import EVENT_SAMPLE_RATE_KEY
+from ...constants import ANALYTICS_SAMPLE_RATE_KEY
+from ...ext import http
 from ...propagation.http import HTTPPropagator
 from ...settings import config
 
@@ -38,9 +38,11 @@ def wrapped(*args, **kwargs):
                     self.tracer.context_provider.activate(context)
 
             with self.tracer.trace('bottle.request', service=self.service, resource=resource, span_type=SPAN_TYPE) as s:
-                # Configure trace search sample rate
-                if config.bottle.event_sample_rate is not None:
-                    s.set_tag(EVENT_SAMPLE_RATE_KEY, config.bottle.event_sample_rate)
+                # set analytics sample rate with global config enabled
+                s.set_tag(
+                    ANALYTICS_SAMPLE_RATE_KEY,
+                    config.bottle.get_analytics_sample_rate(use_global_config=True)
+                )
 
                 code = 0
                 try:

ddtrace/contrib/cassandra/session.py

@@ -5,15 +5,17 @@
 
 # 3p
 import cassandra.cluster
-from ddtrace.vendor import wrapt
 
 # project
 from ...compat import stringify
+from ...constants import ANALYTICS_SAMPLE_RATE_KEY
 from ...ext import net, cassandra as cassx, errors
 from ...internal.logger import get_logger
 from ...pin import Pin
+from ...settings import config
 from ...utils.deprecation import deprecated
 from ...utils.formats import deep_getattr
+from ...vendor import wrapt
 
 log = get_logger(__name__)
 
@@ -183,6 +185,11 @@ def _start_span_and_set_tags(pin, query, session, cluster):
     _sanitize_query(span, query)
     span.set_tags(_extract_session_metas(session))     # FIXME[matt] do once?
     span.set_tags(_extract_cluster_metas(cluster))
+    # set analytics sample rate if enabled
+    span.set_tag(
+        ANALYTICS_SAMPLE_RATE_KEY,
+        config.cassandra.get_analytics_sample_rate()
+    )
     return span
 
 

ddtrace/contrib/dbapi/__init__.py

@@ -1,13 +1,16 @@
 """
 Generic dbapi tracing code.
 """
+
+from ...constants import ANALYTICS_SAMPLE_RATE_KEY
 from ...ext import AppTypes, sql
 from ...internal.logger import get_logger
 from ...pin import Pin
 from ...settings import config
 from ...utils.formats import asbool, get_env
 from ...vendor import wrapt
 
+
 log = get_logger(__name__)
 
 config._add('dbapi2', dict(
@@ -47,6 +50,13 @@ def _trace_method(self, method, name, resource, extra_tags, *args, **kwargs):
             s.set_tags(pin.tags)
             s.set_tags(extra_tags)
 
+            # set analytics sample rate if enabled but only for non-FetchTracedCursor
+            if not isinstance(self, FetchTracedCursor):
+                s.set_tag(
+                    ANALYTICS_SAMPLE_RATE_KEY,
+                    config.dbapi2.get_analytics_sample_rate()
+                )
+
             try:
                 return method(*args, **kwargs)
             finally: