Skip to main content

The Datadog Python library

Unit Tests Integration Tests Documentation Status PyPI - Version PyPI - Downloads

The Datadog Python Library is a collection of tools suitable for inclusion in existing Python projects or for the development of standalone scripts. It provides an abstraction on top of Datadog's raw HTTP interface and the Agent's DogStatsD metrics aggregation server, to interact with Datadog and efficiently report events and metrics.

See CHANGELOG.md for changes.

Installation

To install from pip:

pip install datadog

To install from source:

python setup.py install

Datadog API

To support all Datadog HTTP APIs, a generated library is available which will expose all the endpoints: datadog-api-client-python.

Find below a working example for submitting an event to your Event Stream:

from datadog import initialize, api

options = {
    "api_key": "<YOUR_API_KEY>",
    "app_key": "<YOUR_APP_KEY>",
}

initialize(**options)

title = "Something big happened!"
text = "And let me tell you all about it here!"
tags = ["version:1", "application:web"]

api.Event.create(title=title, text=text, tags=tags)

Consult the full list of supported Datadog API endpoints with working code examples in the Datadog API documentation.

Note: The full list of available Datadog API endpoints is also available in the Datadog Python Library documentation

Environment Variables

As an alternate method to using the initialize function with the options parameters, set the environment variables DATADOG_API_KEY and DATADOG_APP_KEY within the context of your application.

If DATADOG_API_KEY or DATADOG_APP_KEY are not set, the library attempts to fall back to Datadog's APM environment variable prefixes: DD_API_KEY and DD_APP_KEY.

from datadog import initialize, api

# Assuming you've set `DD_API_KEY` and `DD_APP_KEY` in your env,
# initialize() will pick it up automatically
initialize()

title = "Something big happened!"
text = "And let me tell you all about it here!"
tags = ["version:1", "application:web"]

api.Event.create(title=title, text=text, tags=tags)

In development, you can disable any statsd metric collection using DD_DOGSTATSD_DISABLE=True (or any not-empty value).

DogStatsD

In order to use DogStatsD metrics, the Agent must be running and available.

Instantiate the DogStatsD client with UDP

Once the Datadog Python Library is installed, instantiate the StatsD client using UDP in your code:

from datadog import initialize, statsd

options = {
    "statsd_host": "127.0.0.1",
    "statsd_port": 8125,
}

initialize(**options)

Alternatively, the environment variable DD_DOGSTATSD_URL can be used to define a UDP connection: DD_DOGSTATSD_URL=udp://localhost:8125

Manually supplying a host/port takes precedence over this environment variable.

See the full list of available DogStatsD client instantiation parameters.

Instantiate the DogStatsd client with UDS

Once the Datadog Python Library is installed, instantiate the StatsD client using UDS in your code:

from datadog import initialize, statsd

options = {
    "statsd_socket_path": PATH_TO_SOCKET,
}

initialize(**options)

Alternatively, the environment variable DD_DOGSTATSD_URL can be used to define a UDS connection: DD_DOGSTATSD_URL=unix:///var/run/datadog/dsd.socket

As with the UDP variant, manually supplying a statsd_socket_path takes precedence over this environment variable.

Origin detection over UDP and UDS

Origin detection is a method to detect which pod DogStatsD packets are coming from in order to add the pod's tags to the tag list. The DogStatsD client attaches an internal tag, entity_id. The value of this tag is the content of the DD_ENTITY_ID environment variable if found, which is the pod's UID. The Datadog Agent uses this tag to add container tags to the metrics. To avoid overwriting this global tag, make sure to only append to the constant_tags list.

To enable origin detection over UDP, add the following lines to your application manifest

env:
  - name: DD_ENTITY_ID
    valueFrom:
      fieldRef:
        fieldPath: metadata.uid

Usage

Metrics

After the client is created, you can start sending custom metrics to Datadog. See the dedicated Metric Submission: DogStatsD documentation to see how to submit all supported metric types to Datadog with working code examples:

Some options are supported when submitting metrics, like applying a Sample Rate to your metrics or tagging your metrics with your custom tags.

Events

After the client is created, you can start sending events to your Datadog Event Stream. See the dedicated Event Submission: DogStatsD documentation to see how to submit an event to your Datadog Event Stream.

Service Checks

After the client is created, you can start sending Service Checks to Datadog. See the dedicated Service Check Submission: DogStatsD documentation to see how to submit a Service Check to Datadog.

Monitoring this client

This client automatically injects telemetry about itself in the DogStatsD stream. Those metrics will not be counted as custom and will not be billed. This feature can be disabled using the statsd.disable_telemetry() method.

See Telemetry documentation to learn more about it.

Benchmarks

Note: You will need to install psutil package before running the benchmarks.

If you would like to get an approximate idea on the throughput that your DogStatsD library can handle on your system, you can run the included local benchmark code:

$ # Python 2 Example
$ python2 -m unittest -vvv tests.performance.test_statsd_throughput

$ # Python 3 Example
$ python3 -m unittest -vvv tests.performance.test_statsd_throughput

You can also add set BENCHMARK_* to customize the runs:

$ # Example #1
$ BENCHMARK_NUM_RUNS=10 BENCHMARK_NUM_THREADS=1 BENCHMARK_NUM_DATAPOINTS=5000 BENCHMARK_TRANSPORT="UDP" python2 -m unittest -vvv tests.performance.test_statsd_throughput

$ # Example #2
$ BENCHMARK_NUM_THREADS=10 BENCHMARK_TRANSPORT="UDS" python3 -m unittest -vvv tests.performance.test_statsd_throughput

Maximum packets size in high-throughput scenarios

In order to have the most efficient use of this library in high-throughput scenarios, default values for the maximum packets size have already been set for both UDS (8192 bytes) and UDP (1432 bytes) in order to have the best usage of the underlying network. However, if you perfectly know your network and you know that a different value for the maximum packets size should be used, you can set it with the parameter max_buffer_len. Example:

from datadog import initialize

options = {
    "api_key": "<YOUR_API_KEY>",
    "app_key": "<YOUR_APP_KEY>",
    "max_buffer_len": 4096,
}

initialize(**options)

Thread Safety

DogStatsD and ThreadStats are thread-safe.

Release files for datadog 0.53.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for datadog 0.53.0
File Size Uploaded
datadog-0.53.0.tar.gz 378.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for datadog 0.53.0
File Interpreter ABI Platform
datadog-0.53.0-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size:517.0 kB

Release files / datadog-0.53.0.tar.gz

Download URL datadog-0.53.0.tar.gz
Size 378.0 kB
Tags Source
SHA-256 checksum
How to use checksums
9f69a18089c852e20edff7e55226a6f4ca9749e162cfa4ae88c949dd722ebef8
BLAKE2b-256 checksum
How to use checksums
774a8c61a6bd82be61a7b2a1f9dd77104f52299aa81d377fe6a35f9477167361
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.13

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 24, 2026.

Transparency log

Release files / datadog-0.53.0-py2.py3-none-any.whl

Download URL datadog-0.53.0-py2.py3-none-any.whl
Size 139.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
e42467bad752c4739a232986e4ebdb8e4690134e901965557f2eaff0f40eb177
BLAKE2b-256 checksum
How to use checksums
da831fda660aef15fa7f80fc9ad0f056d45dbe8dd09b1774a9cd6c4cfc6cf24d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.13

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 24, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.53.0 This release

2 release files

0.52.2

2 release files

0.52.1

2 release files

0.51.0

2 release files

0.50.2

2 release files

0.50.1

2 release files

0.50.0

2 release files

0.49.1

2 release files

0.49.0

2 release files

0.48.0

2 release files

0.46.0

2 release files

0.45.0

2 release files

0.41.0

2 release files

0.39.0

2 release files

0.37.1

2 release files

0.37.0

2 release files

0.34.1

2 release files

0.33.0

2 release files

0.32.0

2 release files

0.31.0

2 release files

0.30.0

2 release files

0.29.3

2 release files

0.29.2

2 release files

0.29.0

1 release file

0.28.0

2 release files

0.26.0

1 release file

0.25.0

1 release file

0.24.0

1 release file

0.23.0

1 release file

0.22.0

1 release file

0.21.0

1 release file

0.20.0

1 release file

0.19.0

1 release file

0.18.0

1 release file

0.17.0

1 release file

0.16.0

1 release file

0.15.0

1 release file

0.14.0

1 release file

0.13.0

1 release file

0.12.0

1 release file

0.11.0

1 release file

0.10.0

1 release file

0.9.0

1 release file

0.8.0

1 release file

0.7.0

1 release file

0.6.1

1 release file

0.6.0

1 release file

0.5.0

1 release file

0.4.0

1 release file

0.3.0

1 release file

0.2.2

1 release file

0.2.0

1 release file

0.1.2

1 release file

0.1.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page