Configuration

ddtrace can be configured using environment variables. They are listed below:

Variable Name

Type

Default value

Description

DD_ENV

String

Set an application’s environment e.g. prod, pre-prod, staging. Added in v0.36.0. See Unified Service Tagging for more information.

DD_SERVICE

String

(autodetected)

Set the service name to be used for this application. A default is provided for these integrations: Bottle, Flask, Grpc, Pyramid, Pylons, Tornado, Celery, Django and Falcon. Added in v0.36.0. See Unified Service Tagging for more information.

DD_SERVICE_MAPPING

String

Define service name mappings to allow renaming services in traces, e.g. postgres:postgresql,defaultdb:postgresql.

DD_TAGS

String

Set global tags to be attached to every span. Value must be either comma or space separated. e.g. key1:value1,key2,value2 or key1:value key2:value2. Comma separated support added in v0.38.0 and space separated support added in v0.48.0.

DD_VERSION

String

Set an application’s version in traces and logs e.g. 1.2.3, 6c44da20, 2020.02.13. Generally set along with DD_SERVICE. Added in v0.36.0. See Unified Service Tagging for more information.

DD_SITE

String

datadoghq.com

Specify which site to use for uploading profiles. Set to datadoghq.eu to use EU site.

DD_TRACE_ENABLED

Boolean

True

Enable sending of spans to the Agent. Note that instrumentation will still be installed and spans will be generated. Added in v0.41.0 (formerly named DATADOG_TRACE_ENABLED).

DD_TRACE_DEBUG

Boolean

False

Enables debug logging in the tracer. Setting this flag will cause the library to create a root logging handler if one does not already exist. Added in v0.41.0 (formerly named DATADOG_TRACE_DEBUG). Can be used with DD_TRACE_LOG_FILE to route logs to a file.

DD_TRACE_LOG_FILE_LEVEL

String

DEBUG

Configures the RotatingFileHandler used by the ddtrace logger to write logs to a file based on the level specified. Defaults to DEBUG, but will accept the values found in the standard logging library, such as WARNING, ERROR, and INFO, if further customization is needed. Files are not written to unless DD_TRACE_LOG_FILE has been defined.

DD_TRACE_LOG_FILE

String

None

Directs ddtrace logs to a specific file. Note: The default backup count is 1. For larger logs, use with DD_TRACE_LOG_FILE_SIZE_BYTES. To fine tune the logging level, use with DD_TRACE_LOG_FILE_LEVEL.

DD_TRACE_LOG_FILE_SIZE_BYTES

Int

15728640

Max size for a file when used with DD_TRACE_LOG_FILE. When a log has exceeded this size, there will be one backup log file created. In total, the files will store 2 * DD_TRACE_LOG_FILE_SIZE_BYTES worth of logs.

DD_TRACE_<INTEGRATION>_ENABLED

Boolean

True

Enables <INTEGRATION> to be patched. For example, DD_TRACE_DJANGO_ENABLED=false will disable the Django integration from being installed. Added in v0.41.0.

DD_PATCH_MODULES

String

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. Added in v0.55.0 (formerly named DATADOG_PATCH_MODULES).

DD_LOGS_INJECTION

Boolean

False

Enables Logs Injection.

DD_CALL_BASIC_CONFIG

Boolean

False

Controls whether logging.basicConfig is called in ddtrace-run or when debug mode is enabled.

DD_TRACE_AGENT_URL

URL

unix:///var/run/datadog/apm.socket if available otherwise http://localhost:8126

The URL to use to connect the Datadog agent for traces. The url can start with http:// to connect using HTTP or with unix:// to use a Unix Domain Socket. Example for http url: DD_TRACE_AGENT_URL=http://localhost:8126 Example for UDS: DD_TRACE_AGENT_URL=unix:///var/run/datadog/apm.socket

DD_DOGSTATSD_URL

URL

unix:///var/run/datadog/dsd.socket if available otherwise udp://localhost:8125

The URL to use to connect the Datadog agent for Dogstatsd metrics. The url can start with udp:// to connect using UDP or with unix:// to use a Unix Domain Socket. Example for UDP url: DD_TRACE_AGENT_URL=udp://localhost:8125 Example for UDS: DD_TRACE_AGENT_URL=unix:///var/run/datadog/dsd.socket

DD_TRACE_AGENT_TIMEOUT_SECONDS

Float

2.0

The timeout in float to use to connect to the Datadog agent.

DD_TRACE_WRITER_BUFFER_SIZE_BYTES

Int

8388608

The max size in bytes of traces to buffer between flushes to the agent.

DD_TRACE_WRITER_MAX_PAYLOAD_SIZE_BYTES

Int

8388608

The max size in bytes of each payload item sent to the trace agent. If the max payload size is greater than buffer size, then max size of each payload item will be the buffer size.

DD_TRACE_WRITER_INTERVAL_SECONDS

Float

1.0

The time between each flush of traces to the trace agent.

DD_TRACE_STARTUP_LOGS

Boolean

False

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_TRACE_SAMPLING_RULES

JSON array

A JSON array of objects. Each object must have a “sample_rate”, and the “name” and “service” fields are optional. The “sample_rate” value must be between 0.0 and 1.0 (inclusive). Example: DD_TRACE_SAMPLING_RULES='[{"sample_rate":0.5,"service":"my-service"}]' Note that the JSON object must be included in single quotes (’) to avoid problems with escaping of the double quote (”) character.

DD_TRACE_HEADER_TAGS

String

A map of case-insensitive header keys to tag names. Automatically applies matching header values as tags on root spans. For example, User-Agent:http.useragent,content-type:http.content_type.

DD_TRACE_API_VERSION

String

v0.4 if priority sampling is enabled, else v0.3

The trace API version to use when sending traces to the Datadog agent. Currently, the supported versions are: v0.3, v0.4 and v0.5.

DD_TRACE_PROPAGATION_STYLE_EXTRACT

String

datadog

Comma separated list of propagation styles used for extracting trace context from inbound request headers.

The supported values are datadog, b3, and b3 single header.

When checking inbound request headers we will take the first valid trace context in the order datadog, b3, then b3 single header.

Example: DD_TRACE_PROPAGATION_STYLE_EXTRACT="datadog,b3" to check for both x-datadog-* and x-b3-* headers when parsing incoming request headers for a trace context.

DD_TRACE_PROPAGATION_STYLE_INJECT

String

datadog

Comma separated list of propagation styles used for injecting trace context into outbound request headers.

The supported values are datadog, b3, and b3 single header.

All provided styles are injected into the headers of outbound requests.

Example: DD_TRACE_PROPAGATION_STYLE_INJECT="datadog,b3" to inject both x-datadog-* and x-b3-* headers into outbound requests.

DD_TRACE_X_DATADOG_TAGS_MAX_LENGTH

Integer

512

The maximum length of x-datadog-tags header allowed in the Datadog propagation style. Must be a value between 0 to 512. If 0, propagation of x-datadog-tags is disabled.

DD_PROFILING_ENABLED

Boolean

False

Enable Datadog profiling when using ddtrace-run.

DD_PROFILING_API_TIMEOUT

Float

10

The timeout in seconds before dropping events if the HTTP API does not reply.

DD_PROFILING_MAX_TIME_USAGE_PCT

Float

1

The percentage of maximum time the stack profiler can use when computing statistics. Must be greater than 0 and lesser or equal to 100.

DD_PROFILING_MAX_FRAMES

Integer

64

The maximum number of frames to capture in stack execution tracing.

DD_PROFILING_MEMORY_ENABLED

Boolean

True

Whether to enable the memory profiler.

DD_PROFILING_HEAP_ENABLED

Boolean

True

Whether to enable the heap memory profiler.

DD_PROFILING_CAPTURE_PCT

Float

1

The percentage of events that should be captured (e.g. memory allocation). Greater values reduce the program execution speed. Must be greater than 0 lesser or equal to 100.

DD_PROFILING_UPLOAD_INTERVAL

Float

60

The interval in seconds to wait before flushing out recorded events.

DD_PROFILING_IGNORE_PROFILER

Boolean

False

Deprecated: whether to ignore the profiler in the generated data.

DD_PROFILING_TAGS

String

The tags to apply to uploaded profile. Must be a list in the key1:value,key2:value2 format.

DD_PROFILING_ENDPOINT_COLLECTION_ENABLED

Boolean

True

Whether to enable the endpoint data collection in profiles.