Skip to content

Commit

Permalink
Add 2.x upgrading guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Yun-Kim committed Aug 31, 2023
1 parent aac21e9 commit 3e10101
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 7 deletions.
37 changes: 30 additions & 7 deletions docs/upgrading.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
Upgrading
---------

.. _upgrade-0.x:

Upgrade 0.x
^^^^^^^^^^^

.. _`Upgrading and deprecation warnings`:

Deprecation warnings
********************

As of v0.60.0, the library provides `Python
As of v0.60.0, the ddtrace library provides `Python
warnings <https://docs.python.org/3/library/warnings.html>`_ for deprecations
with an additional warning category ``ddtrace.DDTraceDeprecationWarning``.

Expand All @@ -34,8 +29,14 @@ Before v0.60.0, you must enable all deprecation warnings and filter the applicat
$ PYTHONWARNINGS=all python app.py



.. _upgrade-0.x:

Upgrade to 1.x
**************

Environment variables
*********************
^^^^^^^^^^^^^^^^^^^^^

Use the following patterns to identify the deprecated environment variables in a code base::

Expand All @@ -46,3 +47,25 @@ Use the following patterns to identify the deprecated environment variables in a
-e "DD_SERVICE_NAME" \
-e "DD_TRACER_PARTIAL_FLUSH_ENABLED" \
-e "DD_TRACER_PARTIAL_FLUSH_MIN_SPANS"


.. _upgrade-1.x:

Upgrade to 2.x
**************

Environment variables
^^^^^^^^^^^^^^^^^^^^^

Use the following patterns to identify the deprecated environment variables in a code base::

git grep -e "DD_GEVENT_PATCH_ALL" \
-e "DD_AWS_TAG_ALL_PARAMS" \
-e "DD_REMOTECONFIG_POLL_SECONDS" \
-e "DD_CALL_BASIC_CONFIG" \


Legacy tracing interfaces
^^^^^^^^^^^^^^^^^^^^^^^^^

Reference the :ref:`2.x release note <removed-2.0-tracing-interfaces>` to identify and remove the deprecated legacy tracing interfaces in a code base.
2 changes: 2 additions & 0 deletions releasenotes/notes/release-2.0-3af0045e2261bd02.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ prelude: >
- :ref:`📝<remove-basic-config>`
.. _removed-2.0-tracing-interfaces:
Removed legacy tracing interfaces
Expand Down

0 comments on commit 3e10101

Please sign in to comment.