From d9434c760f737329f87919a75b15080df41ef83a Mon Sep 17 00:00:00 2001 From: kyle-verhoog Date: Tue, 15 Dec 2020 13:17:23 -0500 Subject: [PATCH] v0.45 documentation fixes --- docs/installation_quickstart.rst | 11 +++++------ .../notes/current-span-reset-a860bbbad3acda5c.yaml | 2 +- ...ango-request-uri-safe-guards-fdd8bd664374ded1.yaml | 2 +- .../notes/django-view-mro-check-782374fb9c427305.yaml | 2 +- .../notes/fix-aiobotocore-9eeac808a3bf0f63.yaml | 2 +- .../notes/fix-elasticsearch-a3f89a915ccc36c4.yaml | 2 +- .../notes/fix-span-type-web-20122b5c57c50341.yaml | 2 +- 7 files changed, 11 insertions(+), 12 deletions(-) diff --git a/docs/installation_quickstart.rst b/docs/installation_quickstart.rst index ec824258051..39e56e6c3a7 100644 --- a/docs/installation_quickstart.rst +++ b/docs/installation_quickstart.rst @@ -38,7 +38,7 @@ For more advanced usage of ``ddtrace-run`` refer to the documentation :ref:`here If ``ddtrace-run`` isn't suitable for your application then :ref:`patch_all` can be used:: import ddtrace - + ddtrace.patch_all() @@ -47,14 +47,13 @@ For information on how to manually create traces refer to the documentation :ref Profiling ~~~~~~~~~ -Getting started for profiling is as easy as prefixing your python entry-point -command with ``pyddprofile``. - -For example if you start your application with ``python app.py`` then run:: +Profiling can also be auto enabled with :ref:`ddtracerun` by providing the +``DD_PROFILING_ENABLED`` environment variable:: DD_PROFILING_ENABLED=true ddtrace-run python app.py -If ``ddtrace-run`` isn't suitable for your application then ``ddtrace.profiling.auto`` can be used:: +If ``ddtrace-run`` isn't suitable for your application then +``ddtrace.profiling.auto`` can be used:: import ddtrace.profiling.auto diff --git a/releasenotes/notes/current-span-reset-a860bbbad3acda5c.yaml b/releasenotes/notes/current-span-reset-a860bbbad3acda5c.yaml index b394fbf4805..e07768f9270 100644 --- a/releasenotes/notes/current-span-reset-a860bbbad3acda5c.yaml +++ b/releasenotes/notes/current-span-reset-a860bbbad3acda5c.yaml @@ -1,4 +1,4 @@ --- fixes: - | - core: always reset the current_span in the context + core: always reset the current_span in the context. diff --git a/releasenotes/notes/django-request-uri-safe-guards-fdd8bd664374ded1.yaml b/releasenotes/notes/django-request-uri-safe-guards-fdd8bd664374ded1.yaml index 2d552858a3b..c1fa063b00f 100644 --- a/releasenotes/notes/django-request-uri-safe-guards-fdd8bd664374ded1.yaml +++ b/releasenotes/notes/django-request-uri-safe-guards-fdd8bd664374ded1.yaml @@ -1,4 +1,4 @@ --- fixes: - | - Add safe guards for building Django http.url span tag + django: add safe guards for building http.url span tag. diff --git a/releasenotes/notes/django-view-mro-check-782374fb9c427305.yaml b/releasenotes/notes/django-view-mro-check-782374fb9c427305.yaml index d61401b33a1..d097bf3b12d 100644 --- a/releasenotes/notes/django-view-mro-check-782374fb9c427305.yaml +++ b/releasenotes/notes/django-view-mro-check-782374fb9c427305.yaml @@ -1,4 +1,4 @@ --- fixes: - | - Check Django view before instrumenting MRO + django: check view before instrumenting MRO. diff --git a/releasenotes/notes/fix-aiobotocore-9eeac808a3bf0f63.yaml b/releasenotes/notes/fix-aiobotocore-9eeac808a3bf0f63.yaml index 481f3be83fc..5caba5c679c 100644 --- a/releasenotes/notes/fix-aiobotocore-9eeac808a3bf0f63.yaml +++ b/releasenotes/notes/fix-aiobotocore-9eeac808a3bf0f63.yaml @@ -1,4 +1,4 @@ --- fixes: - | - Set span error to 1 for 5xx status codes for aiobotocore. + aiobotocore: set span error for 5xx status codes. diff --git a/releasenotes/notes/fix-elasticsearch-a3f89a915ccc36c4.yaml b/releasenotes/notes/fix-elasticsearch-a3f89a915ccc36c4.yaml index ef308f2a816..1cbf40bc534 100644 --- a/releasenotes/notes/fix-elasticsearch-a3f89a915ccc36c4.yaml +++ b/releasenotes/notes/fix-elasticsearch-a3f89a915ccc36c4.yaml @@ -1,4 +1,4 @@ --- fixes: - | - Set span error to 1 for 5xx status codes for elasticsearch. + elasticsearch: set span error for 5xx status codes. diff --git a/releasenotes/notes/fix-span-type-web-20122b5c57c50341.yaml b/releasenotes/notes/fix-span-type-web-20122b5c57c50341.yaml index 862d2339e70..a88d41acaef 100644 --- a/releasenotes/notes/fix-span-type-web-20122b5c57c50341.yaml +++ b/releasenotes/notes/fix-span-type-web-20122b5c57c50341.yaml @@ -1,4 +1,4 @@ --- fixes: - | - Fix span type for web request spans in Django, DRF and ASGI + django, DRF, ASGI: fix span type for web request spans.