Enable Autocomplete and Search for Python

Join the Preview!

Autocomplete and search are in Preview.

Requirements

Installation

Run your service with Dynamic Instrumentation enabled, and additionally enable autocomplete and search:

  1. Run your service with Dynamic Instrumentation enabled by setting the DD_DYNAMIC_INSTRUMENTATION_ENABLED environment variable to true.
  2. Specify DD_SERVICE and DD_VERSION Unified Service Tags.
  3. Invoke your service:
export DD_SERVICE=<YOUR_SERVICE>
export DD_ENV=<YOUR_ENV>
export DD_VERSION=<YOUR_VERSION>
export DD_DYNAMIC_INSTRUMENTATION_ENABLED=true
export DD_SYMBOL_DATABASE_UPLOAD_ENABLED=true
ddtrace-run python -m myapp

After starting your service with the required features enabled, you can use Dynamic Instrumentation’s IDE-like features on the APM > Dynamic Instrumentation page.

Additional configuration

Third party detection

If autocomplete suggestions do not appear for your package or module, it may be incorrectly recognized as third-party code. The autocomplete and search features use a heuristic to filter out third-party code, which can sometimes lead to accidental misclassification.

To ensure that your code is properly recognized, and to enable accurate autocomplete and search functionality, configure your third-party detection settings to use the following options:

export DD_THIRD_PARTY_DETECTION_EXCLUDES=<LIST_OF_USER_CODE_MODULES>
export DD_THIRD_PARTY_DETECTION_INCLUDES=<LIST_OF_ADDITIONAL_THIRD_PARTY_MODULES>

where <LIST_OF_USER_CODE_MODULES> and <LIST_OF_ADDITIONAL_THIRD_PARTY_MODULES> are comma separated lists of package prefixes. For example:

export DD_THIRD_PARTY_DETECTION_EXCLUDES=shopping,database