Prelude

The Datadog APM Python team is happy to announce the release of v1.0.0 of ddtrace.

The first commit to the library was made on June 20, 2016. Nearly sixty minor releases later, the library has grown immensely. The library now includes over 60 integrations for libraries. Moreover, the library has expanded out from tracing to support the Continuous Profiler and CI Visibility.

Our motivations for this major version release were:

• Clarify and simplify the public API.
• Introduce a versioning policy.
• Provide users a painless upgrade path.

Upgrading and deprecation warnings

Before upgrading, we recommend resolving any deprecation warnings raised in your application. The messages for the deprecation warnings include the version when the API will be changed or removed.

As of v0.59.0, you can enable warning filters for ddtrace library deprecations.

For those using pytest, add a filter for the ddtrace.DDTraceDeprecationWarning warning category:

pytest -W "error::ddtrace.DDTraceDeprecationWarning" tests.py

Otherwise, you must set the environment variable DD_TRACE_RAISE_DEPRECATIONWARNING which will configure the warning filter:

DD_TRACE_RAISE_DEPRECATIONWARNING=1 python app.py

Before v0.59.0, you can still enable all deprecation warnings and filter the application or tests logs for deprecations specific the ddtrace library:

$ python -Wall app.py

# or

$ PYTHONWARNINGS=all python app.py  

Summary of 0.x deprecations

New Features

• HTTP connections for trace payloads to the agent will be reused when possible.

Upgrade Notes

• The deprecated attribute ddtrace.Sampler.default_sampler is removed.
• Default value of DD_CALL_BASIC_CONFIG was updated from True to False. Call logging.basicConfig() to configure logging in your application.
• ddtrace.settings.Config.HTTPServerConfig is removed.
• cassandra: get_traced_cassandra is removed. Use ddtrace.patch(cassandra=True) or ddtrace.patch_all() instead.
• celery: ddtrace.contrib.celery.patch_task is removed. Use ddtrace.patch(celery=True) or ddtrace.patch_all() instead.
• celery: ddtrace.contrib.celery.unpatch_task is removed. Use ddtrace.contrib.celery.unpatch() instead.
• ddrace.context.Context.clone is removed. This is no longer needed since the tracer now supports asynchronous frameworks out of the box.
• The deprecated module ddtrace.contrib.util is removed.
• The deprecated module ddtrace.compat is removed.
• The deprecated module ddtrace.encoding is removed.
• The deprecated modules ddtrace.http and ddtrace.http.headers are removed. Use ddtrace.contrib.trace_utils.set_http_meta to store request and response headers on a span.
• Remove deprecated ddtrace.install_excepthook.
• Remove deprecated ddtrace.uninstall_excepthook.
• The deprecated module ddtrace.monkey is removed. Use ddtrace.patch or ddtrace.patch_all instead.
• The deprecated module ddtrace.propagation.utils is removed.
• The deprecated module ddtrace.utils and its submodules are removed:
  • ddtrace.utils.attr
  • ddtrace.utils.attrdict
  • ddtrace.utils.cache
  • ddtrace.utils.config
  • ddtrace.utils.deprecation
  • ddtrace.utils.formats
  • ddtrace.utils.http
  • ddtrace.utils.importlib
  • ddtrace.utils.time
  • ddtrace.utils.version
  • ddtrace.utils.wrappers
• ddtrace.Tracer.sampler is removed.
• ddtrace.Tracer.priority_sampler is removed.
• ddtrace.Tracer.tags is removed. Use the environment variable DD_TAGS to set the global tags instead.
• ddtrace.Tracer.log was removed.
• The deprecated module ddtrace.ext.errors is removed. Use the ddtrace.constants module instead:

  from ddtrace.constants import ERROR_MSG
  from ddtrace.constants import ERROR_STACK
  from ddtrace.constants import ERROR_TYPE
  

• The deprecated module ddtrace.ext.priority is removed. Use the ddtrace.constants module instead for setting sampling priority tags:

  from ddtrace.constants import USER_KEEP
  from ddtrace.constants import USER_REJECT
  

• The deprecated module ddtrace.ext.system is removed. Use ddtrace.constants.PID instead.
• The deprecated method ddtrace.helpers.get_correlation_ids is removed. Use ddtrace.Tracer.get_log_correlation_context() instead.
• The legacy environment variables DD_SERVICE_NAME and DATADOG_SERVICE_NAME are removed. Use DD_SERVICE instead.
• mongoengine: The deprecated method ddtrace.contrib.mongoengine.trace_mongoengine is removed. Use ddtrace.patch(mongoengine=True) or ddtrace.patch() instead.
• mysql: The deprecated method ddtrace.contrib.mysql.get_traced_mysql_connection is removed. Use ddtrace.patch(mysql=True) or ddtrace.patch_all() instead.
• Pin.app is removed.
• Pin.app_type is removed.
• psycopg: ddtrace.contrib.psycopg.connection_factory is removed. Use ddtrace.patch(psycopg=True) or ddtrace.patch_all() instead.
• requests: The legacy distributed tracing configuration is removed. Use ddtrace.config.requests[‘distributed_tracing’] instead.
• ddtrace.Span.meta is removed. Use ddtrace.Span.get_tag() and ddtrace.Span.set_tag() instead.
• ddtrace.Span.metrics is removed. Use ddtrace.Span.get_metric() and ddtrace.Span.set_metric() instead.
• ddtrace.Span.pprint is removed.
• Span.tracer is removed.
• The deprecated tracer argument is removed from ddtrace.Span.__init__().
• sqlite3: ddtrace.contrib.sqlite3.connection_factory is removed. Use ddtrace.patch(sqlite3=True) or ddtrace.patch_all() instead.
• Remove deprecated attribute ddtrace.Tracer.debug_logging. Set the logging level for the ddtrace.tracer logger instead:

  import logging
  log = logging.getLogger("ddtrace.tracer")
  log.setLevel(logging.DEBUG)
  

• ddtrace.Tracer.__call__ is removed.
• ddtrace.Tracer.global_excepthook is removed.
• ddtrace.Tracer.get_call_context is removed. Use ddtrace.Tracer.current_trace_context() instead.
• ddtrace.Tracer.set_service_info is removed.
• ddtrace.Tracer.writer is removed. To force flushing of buffered traces to the agent, use ddtrace.Tracer.flush() instead.
• The environment variables prefixed with DATADOG_ are removed. Use environment variables prefixed with DD_ instead.
• The environment variable DD_LOGGING_RATE_LIMIT is removed. Use DD_TRACE_LOGGING_RATE instead.
• The environment variable DD_TRACER_PARTIAL_FLUSH_ENABLED is removed. Use DD_TRACE_PARTIAL_FLUSH_ENABLED instead.
• The environment variable DD_TRACER_PARTIAL_FLUSH_MIN_SPANS is removed. Use DD_TRACE_PARTIAL_FLUSH_MIN_SPANS instead.
• ddtrace.util is removed.
• ddtrace.ext.SpanTypes is no longer an Enum. Use SpanTypes.TYPE instead of SpanTypes.TYPE.value.
• Tracer.write has been removed.
• Removed deprecated middleware ddtrace.contrib.flask.middleware.py:TraceMiddleware. Use ddtrace.patch_all() or ddtrace.patch() instead.
• Removed deprecated function ddtrace.contrib.pymongo.patch.py:trace_mongo_client. Use ddtrace.patch_all() or ddtrace.patch() instead.
• Removed deprecated function ddtrace.contrib.pymysql.tracers.py:get_traced_pymysql_connection. Use ddtrace.patch_all() or ddtrace.patch() instead.
• Removed deprecated function ddtrace.contrib.redis.tracers.py:get_traced_redis. Use ddtrace.patch_all() or ddtrace.patch() instead.
• Removed deprecated function ddtrace.contrib.redis.tracers.py:get_traced_redis_from. Use ddtrace.patch_all() or ddtrace.patch() instead.

Deprecation Notes

• DD_CALL_BASIC_CONFIG is deprecated.

Bug Fixes

• tracing/internal: fix encoding of propagated internal tags.