update docs for TwL (#1751)

Kyle-Verhoog · majorgreys · web-flow · commit 6b34a9705c26 · 2020-11-05T11:58:29.000-05:00
Co-authored-by: Tahir H. Butt &lt;tahir.butt@datadoghq.com&gt;
diff --git a/ddtrace/contrib/aiohttp/__init__.py b/ddtrace/contrib/aiohttp/__init__.py
@@ -32,7 +32,6 @@
 * ``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``): analyze spans for AioHTTP in App Analytics.
 
 Third-party modules that are currently supported by the ``patch()`` method are:
 
diff --git a/ddtrace/contrib/asgi/__init__.py b/ddtrace/contrib/asgi/__init__.py
@@ -39,14 +39,6 @@ def custom_handle_exception_span(exc, span):
 
    Default: ``True``
 
-.. py:data:: ddtrace.config.asgi['analytics_enabled']
-
-   Whether to analyze spans for Asgi in App Analytics.
-
-   Can also be enabled with the ``DD_TRACE_ASGI_ANALYTICS_ENABLED`` environment variable.
-
-   Default: ``None``
-
 .. py:data:: ddtrace.config.asgi['service_name']
 
    The service name reported for your ASGI app.
diff --git a/ddtrace/contrib/django/__init__.py b/ddtrace/contrib/django/__init__.py
@@ -35,14 +35,6 @@
 
    Default: ``True``
 
-.. py:data:: ddtrace.config.django['analytics_enabled']
-
-   Whether to analyze spans for Django in App Analytics.
-
-   Can also be enabled with the ``DD_TRACE_DJANGO_ANALYTICS_ENABLED`` environment variable.
-
-   Default: ``None``
-
 .. py:data:: ddtrace.config.django['service_name']
 
    The service name reported for your Django app.
@@ -175,10 +167,6 @@
 +-----------------------------+-------------------------------------------------------------------------------------------------------------------------+
 | ``DISTRIBUTED_TRACING``     | ``config.django['distributed_tracing_enabled']``                                                                        |
 +-----------------------------+-------------------------------------------------------------------------------------------------------------------------+
-| ``ANALYTICS_ENABLED``       | ``config.django['analytics_enabled']``                                                                                  |
-+-----------------------------+-------------------------------------------------------------------------------------------------------------------------+
-| ``ANALYTICS_SAMPLE_RATE``   | ``config.django['analytics_sample_rate']``                                                                              |
-+-----------------------------+-------------------------------------------------------------------------------------------------------------------------+
 | ``TRACE_QUERY_STRING``      | ``config.django['trace_query_string']``                                                                                 |
 +-----------------------------+-------------------------------------------------------------------------------------------------------------------------+
 | ``TAGS``                    | ``DD_TAGS`` environment variable or ``tracer.set_tags()``                                                               |
@@ -208,8 +196,6 @@
        'DEFAULT_DATABASE_PREFIX': 'my-',
        'ENABLED': True,
        'DISTRIBUTED_TRACING': True,
-       'ANALYTICS_ENABLED': True,
-       'ANALYTICS_SAMPLE_RATE': 0.5,
        'TRACE_QUERY_STRING': None,
        'TAGS': {'env': 'production'},
        'TRACER': 'my.custom.tracer',
@@ -230,8 +216,6 @@
    config.django['instrument_databases'] = True
    config.django['instrument_caches'] = True
    config.django['trace_query_string'] = True
-   config.django['analytics_enabled'] = True
-   config.django['analytics_sample_rate'] = 0.5
    tracer.set_tags({'env': 'production'})
 
    import my.custom.tracer
diff --git a/ddtrace/contrib/falcon/__init__.py b/ddtrace/contrib/falcon/__init__.py
@@ -20,9 +20,6 @@
 To disable distributed tracing when using autopatching, set the
 ``DATADOG_FALCON_DISTRIBUTED_TRACING`` environment variable to ``False``.
 
-To enable analyzed spans for App Analytics, set the
-``DD_FALCON_ANALYTICS_ENABLED`` environment variable to ``True``.
-
 **Supported span hooks**
 
 The following is a list of available tracer hooks that can be used to intercept
diff --git a/ddtrace/contrib/flask/__init__.py b/ddtrace/contrib/flask/__init__.py
@@ -37,14 +37,6 @@ def index():
 
    Default: ``True``
 
-.. py:data:: ddtrace.config.flask['analytics_enabled']
-
-   Whether to analyze spans for Flask in App Analytics.
-
-   Can also be enabled with the ``DD_TRACE_FLASK_ANALYTICS_ENABLED`` environment variable.
-
-   Default: ``None``
-
 .. py:data:: ddtrace.config.flask['service_name']
 
    The service name reported for your Flask app.
diff --git a/ddtrace/contrib/molten/__init__.py b/ddtrace/contrib/molten/__init__.py
@@ -23,14 +23,6 @@ def hello(name: str, age: int) -> str:
 
    Default: ``True``
 
-.. py:data:: ddtrace.config.molten['analytics_enabled']
-
-   Whether to analyze spans for Molten in App Analytics.
-
-   Can also be enabled with the ``DD_TRACE_MOLTEN_ANALYTICS_ENABLED`` environment variable.
-
-   Default: ``None``
-
 .. py:data:: ddtrace.config.molten['service_name']
 
    The service name reported for your Molten app.
diff --git a/ddtrace/contrib/pyramid/__init__.py b/ddtrace/contrib/pyramid/__init__.py
@@ -20,7 +20,6 @@
 * ``datadog_trace_service``: change the `pyramid` service name
 * ``datadog_trace_enabled``: sets if the Tracer is enabled or not
 * ``datadog_distributed_tracing``: set it to ``False`` to disable Distributed Tracing
-* ``datadog_analytics_enabled``: set it to ``True`` to analyze spans for Pyramid in App Analytics
 
 If you use the ``pyramid.tweens`` settings value to set the tweens for your
 application, you need to add ``ddtrace.contrib.pyramid:trace_tween_factory``
diff --git a/ddtrace/contrib/requests/__init__.py b/ddtrace/contrib/requests/__init__.py
@@ -24,14 +24,10 @@
     # disable distributed tracing globally
     config.requests['distributed_tracing'] = False
 
-    # enable trace analytics globally
-    config.requests['analytics_enabled'] = True
-
     # change the service name/distributed tracing only for this session
     session = Session()
     cfg = config.get_from(session)
     cfg['service_name'] = 'auth-api'
-    cfg['analytics_enabled'] = True
 
 :ref:`Headers tracing <http-headers-tracing>` is supported for this integration.
 """
diff --git a/ddtrace/contrib/sanic/__init__.py b/ddtrace/contrib/sanic/__init__.py
@@ -40,13 +40,6 @@ def index(request):
 
    Default: ``True``
 
-.. py:data:: ddtrace.config.sanic['analytics_enabled']
-
-   Whether to analyze spans for Sanic in App Analytics.
-
-   Can also be enabled with the ``DD_TRACE_SANIC_ANALYTICS_ENABLED`` environment variable.
-
-   Default: ``None``
 
 .. py:data:: ddtrace.config.sanic['service_name']
 
diff --git a/ddtrace/contrib/tornado/__init__.py b/ddtrace/contrib/tornado/__init__.py
@@ -76,7 +76,6 @@ def log_exception(self, typ, value, tb):
             'default_service': 'my-tornado-app',
             'tags': {'env': 'production'},
             'distributed_tracing': False,
-            'analytics_enabled': False,
             'settings': {
                 'FILTERS':  [
                     FilterRequestsOnUrl(r'http://test\\.example\\.com'),
@@ -100,7 +99,6 @@ def log_exception(self, typ, value, tb):
 * ``distributed_tracing`` (default: `True`): 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.
-* ``analytics_enabled`` (default: `None`):  analyze spans for Tornado in App Analytics.
 * ``agent_hostname`` (default: `localhost`): define the hostname of the APM agent.
 * ``agent_port`` (default: `8126`): define the port of the APM agent.
 * ``settings`` (default: ``{}``): Tracer extra settings used to change, for instance, the filtering behavior.
diff --git a/ddtrace/sampler.py b/ddtrace/sampler.py
@@ -116,9 +116,6 @@ def update_rate_by_service_sample_rates(self, rate_by_service):
 
 
 class DatadogSampler(BaseSampler, BasePrioritySampler):
-    """
-    This sampler is currently in ALPHA and it's API may change at any time, use at your own risk.
-    """
     __slots__ = ('default_sampler', 'limiter', 'rules')
 
     NO_RATE_LIMIT = -1
diff --git a/docs/advanced_usage.rst b/docs/advanced_usage.rst
@@ -24,7 +24,7 @@ You can also use a Unix Domain Socket to connect to the agent::
 Distributed Tracing
 -------------------
 
-To trace requests across hosts, the spans on the secondary hosts must be linked together by setting `trace_id`, `parent_id` and `sampling_priority`.
+To trace requests across hosts, the spans on the secondary hosts must be linked together by setting `trace_id` and `parent_id`.
 
 - On the server side, it means to read propagated attributes and set them to the active tracing context.
 - On the client side, it means to propagate the attributes, commonly as a header/metadata.
@@ -89,14 +89,12 @@ propagate a `rpc_metadata` dictionary over the wire::
             rpc_metadata.update({
                 'trace_id': span_context.trace_id,
                 'span_id': span_context.span_id,
-                'sampling_priority': span_context.sampling_priority,
             })
 
         def extract(self, rpc_metadata):
             return Context(
                 trace_id=rpc_metadata['trace_id'],
                 span_id=rpc_metadata['span_id'],
-                sampling_priority=rpc_metadata['sampling_priority'],
             )
 
     # On the parent side
@@ -121,52 +119,6 @@ propagate a `rpc_metadata` dictionary over the wire::
 Sampling
 --------
 
-.. _`Priority Sampling`:
-
-Priority Sampling
-^^^^^^^^^^^^^^^^^
-
-To learn about what sampling is check out our documentation `here
-<https://docs.datadoghq.com/tracing/getting_further/trace_sampling_and_storage/#priority-sampling-for-distributed-tracing>`_.
-
-By default priorities are set on a trace by a sampler. The sampler can set the
-priority to the following values:
-
-- ``AUTO_REJECT``: the sampler automatically rejects the trace
-- ``AUTO_KEEP``: the sampler automatically keeps the trace
-
-Priority sampling is enabled by default.
-When enabled, the sampler will automatically assign a priority to your traces,
-depending on their service and volume.
-This ensures that your sampled distributed traces will be complete.
-
-You can also set this priority manually to either drop an uninteresting trace or
-to keep an important one.
-To do this, set the ``context.sampling_priority`` to one of the following:
-
-- ``USER_REJECT``: the user asked to reject the trace
-- ``USER_KEEP``: the user asked to keep the trace
-
-When not using distributed tracing, you may change the priority at any time, as
-long as the trace is not finished yet.
-But it has to be done before any context propagation (fork, RPC calls) to be
-effective in a distributed context.
-Changing the priority after context has been propagated causes different parts
-of a distributed trace to use different priorities. Some parts might be kept,
-some parts might be rejected, and this can cause the trace to be partially
-stored and remain incomplete.
-
-If you change the priority, we recommend you do it as soon as possible, when the
-root span has just been created::
-
-    from ddtrace.ext.priority import USER_REJECT, USER_KEEP
-
-    context = tracer.context_provider.active()
-
-    # indicate to not keep the trace
-    context.sampling_priority = USER_REJECT
-
-
 Client Sampling
 ^^^^^^^^^^^^^^^
 
@@ -184,103 +136,6 @@ The ``RateSampler`` randomly samples a percentage of traces::
     tracer.sampler = RateSampler(sample_rate)
 
 
-App Analytics
-------------------------
-
-Use `App Analytics <https://docs.datadoghq.com/tracing/visualization/search/>`_ to filter application performance metrics and analyzed spans by user-defined tags. An APM event is generated every time a trace is generated.
-
-Enabling analyzed spans for all web frameworks can be accomplished by setting the environment variable ``DD_TRACE_ANALYTICS_ENABLED=true``:
-
-* :ref:`aiohttp`
-* :ref:`bottle`
-* :ref:`django`
-* :ref:`falcon`
-* :ref:`flask`
-* :ref:`molten`
-* :ref:`pylons`
-* :ref:`pyramid`
-* :ref:`requests`
-* :ref:`tornado`
-
-
-For most libraries, analyzed spans can be enabled with the environment variable ``DD_TRACE_{INTEGRATION}_ANALYTICS_ENABLED=true``:
-
-+----------------------+----------------------------------------------+
-|       Library        |              Environment Variable            |
-+======================+==============================================+
-| :ref:`aiobotocore`   | ``DD_TRACE_AIOBOTOCORE_ANALYTICS_ENABLED``   |
-+----------------------+----------------------------------------------+
-| :ref:`aiopg`         | ``DD_TRACE_AIOPG_ANALYTICS_ENABLED``         |
-+----------------------+----------------------------------------------+
-| :ref:`boto2`          | ``DD_TRACE_BOTO_ANALYTICS_ENABLED``         |
-+----------------------+----------------------------------------------+
-| :ref:`botocore`      | ``DD_TRACE_BOTOCORE_ANALYTICS_ENABLED``      |
-+----------------------+----------------------------------------------+
-| :ref:`bottle`        | ``DD_TRACE_BOTTLE_ANALYTICS_ENABLED``        |
-+----------------------+----------------------------------------------+
-| :ref:`cassandra`     | ``DD_TRACE_CASSANDRA_ANALYTICS_ENABLED``     |
-+----------------------+----------------------------------------------+
-| :ref:`celery`        | ``DD_TRACE_CELERY_ANALYTICS_ENABLED``        |
-+----------------------+----------------------------------------------+
-| :ref:`elasticsearch` | ``DD_TRACE_ELASTICSEARCH_ANALYTICS_ENABLED`` |
-+----------------------+----------------------------------------------+
-| :ref:`falcon`        | ``DD_TRACE_FALCON_ANALYTICS_ENABLED``        |
-+----------------------+----------------------------------------------+
-| :ref:`flask`         | ``DD_TRACE_FLASK_ANALYTICS_ENABLED``         |
-+----------------------+----------------------------------------------+
-| :ref:`flask_cache`   | ``DD_TRACE_FLASK_CACHE_ANALYTICS_ENABLED``   |
-+----------------------+----------------------------------------------+
-| :ref:`grpc`          | ``DD_TRACE_GRPC_ANALYTICS_ENABLED``          |
-+----------------------+----------------------------------------------+
-| :ref:`httplib`       | ``DD_TRACE_HTTPLIB_ANALYTICS_ENABLED``       |
-+----------------------+----------------------------------------------+
-| :ref:`kombu`         | ``DD_TRACE_KOMBU_ANALYTICS_ENABLED``         |
-+----------------------+----------------------------------------------+
-| :ref:`molten`        | ``DD_TRACE_MOLTEN_ANALYTICS_ENABLED``        |
-+----------------------+----------------------------------------------+
-| :ref:`pylibmc`       | ``DD_TRACE_PYLIBMC_ANALYTICS_ENABLED``       |
-+----------------------+----------------------------------------------+
-| :ref:`pylons`        | ``DD_TRACE_PYLONS_ANALYTICS_ENABLED``        |
-+----------------------+----------------------------------------------+
-| :ref:`pymemcache`    | ``DD_TRACE_PYMEMCACHE_ANALYTICS_ENABLED``    |
-+----------------------+----------------------------------------------+
-| :ref:`pymongo`       | ``DD_TRACE_PYMONGO_ANALYTICS_ENABLED``       |
-+----------------------+----------------------------------------------+
-| :ref:`redis`         | ``DD_TRACE_REDIS_ANALYTICS_ENABLED``         |
-+----------------------+----------------------------------------------+
-| :ref:`rediscluster`  | ``DD_TRACE_REDISCLUSTER_ANALYTICS_ENABLED``  |
-+----------------------+----------------------------------------------+
-| :ref:`sqlalchemy`    | ``DD_TRACE_SQLALCHEMY_ANALYTICS_ENABLED``    |
-+----------------------+----------------------------------------------+
-| :ref:`vertica`       | ``DD_TRACE_VERTICA_ANALYTICS_ENABLED``       |
-+----------------------+----------------------------------------------+
-
-For datastore libraries that extend another, use the setting for the underlying library:
-
-+------------------------+----------------------------------------+
-|        Library         |          Environment Variable          |
-+========================+========================================+
-| :ref:`mongoengine`     | ``DD_TRACE_PYMONGO_ANALYTICS_ENABLED`` |
-+------------------------+----------------------------------------+
-| :ref:`mysql-connector` | ``DD_TRACE_DBAPI2_ANALYTICS_ENABLED``  |
-+------------------------+----------------------------------------+
-| :ref:`mysqldb`         | ``DD_TRACE_DBAPI2_ANALYTICS_ENABLED``  |
-+------------------------+----------------------------------------+
-| :ref:`psycopg2`        | ``DD_TRACE_DBAPI2_ANALYTICS_ENABLED``  |
-+------------------------+----------------------------------------+
-| :ref:`pymysql`         | ``DD_TRACE_DBAPI2_ANALYTICS_ENABLED``  |
-+------------------------+----------------------------------------+
-| :ref:`sqllite`         | ``DD_TRACE_DBAPI2_ANALYTICS_ENABLED``  |
-+------------------------+----------------------------------------+
-
-Where environment variables are not used for configuring the tracer, the instructions for configuring app analytics are provided in the library documentation:
-
-* :ref:`aiohttp`
-* :ref:`django`
-* :ref:`pyramid`
-* :ref:`requests`
-* :ref:`tornado`
-
 Resolving deprecation warnings
 ------------------------------
 Before upgrading, it’s a good idea to resolve any deprecation warnings raised by your project.
@@ -451,8 +306,6 @@ for usage.
 +---------------------+----------------------------------------+---------------+
 | `sampler`           | see `Sampling`_                        | `AllSampler`  |
 +---------------------+----------------------------------------+---------------+
-| `priority_sampling` | see `Priority Sampling`_               | `True`        |
-+---------------------+----------------------------------------+---------------+
 | `uds_path`          | unix socket of agent to connect to     | `None`        |
 +---------------------+----------------------------------------+---------------+
 | `settings`          | see `Advanced Usage`_                  | `{}`          |
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -61,10 +61,6 @@ below:
      - Override the modules patched for this execution of the program. Must be
        a list in the ``module1:boolean,module2:boolean`` format. For example,
        ``boto:true,redis:false``.
-   * - ``DATADOG_PRIORITY_SAMPLING``
-     - Boolean
-     - True
-     - Enables :ref:`Priority Sampling`.
    * - ``DD_LOGS_INJECTION``
      - Boolean
      - True
@@ -75,6 +71,14 @@ below:
      - The URL to use to connect the Datadog agent. The url can starts with
        ``http://`` to connect using HTTP or with ``unix://`` to use a Unix
        Domain Socket.
+   * - ``DD_TRACE_STARTUP_LOGS``
+     - Boolean
+     - True
+     - Enable or disable start up diagnostic logging.
+   * - ``DD_TRACE_SAMPLE_RATE``
+     - Float
+     - 1.0
+     - A float, f, 0.0 <= f <= 1.0. f*100% of traces will be sampled.
    * - ``DD_PROFILING_ENABLED``
      - Boolean
      - False
@@ -112,7 +116,3 @@ below:
      -
      - The tags to apply to uploaded profile. Must be a list in the
        ``key1:value,key2:value2`` format.
-   * - ``DD_TRACE_STARTUP_LOGS``
-     - Boolean
-     - True
-     - Enable or disable start up diagnostic logging.
