The Datadog Python library
Project description
The Datadog Python library
Datadogpy is a collection of tools suitable for inclusion in existing Python projects or for development of standalone scripts. It provides an abstraction on top of Datadog's raw HTTP interface and the Agent's StatsD metrics aggregation server, to interact with Datadog and efficiently report events and metrics.
For usage of StatsD metrics, the Agent must be running and available.
- Library Documentation: http://datadogpy.readthedocs.org/en/latest/
- HTTP API Documentation: http://docs.datadoghq.com/api/
- DatadogHQ: http://datadoghq.com
See CHANGELOG.md for changes.
Installation
To install from pip:
pip install datadog
To install from source:
python setup.py install
Quick Start Guide
# Configure the module according to your needs
from datadog import initialize
options = {
'api_key':'api_key',
'app_key':'app_key'
}
initialize(**options)
# Use Datadog REST API client
from datadog import api
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)
# Use Statsd, a Python client for DogStatsd
from datadog import statsd
# Uncomment to set namespace or add tags to everything
# statsd.namespace = 'localdev'
# statsd.constant_tags = ['testing', 'dogstats']
statsd.increment('whatever')
statsd.gauge('foo', 42)
# Or ThreadStats, an alternative tool to collect and flush metrics, using Datadog REST API
from datadog import ThreadStats
stats = ThreadStats()
stats.start()
stats.increment('home.page.hits')
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 will attempt to fall back to Datadog's APM environmnent 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)
Thread Safety
DogStatsD and ThreadStats are thread-safe.
Origin detection over UDP
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.
This tag will be used by the Datadog Agent to insert container tags to the metrics. You should only append to the constant_tags list to avoid overwriting this global tag.
To enable origin detection over UDP, add the following lines to your application manifest
env:
- name: DD_ENTITY_ID
valueFrom:
fieldRef:
fieldPath: metadata.uid
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file datadog-0.32.0.tar.gz.
File metadata
- Download URL: datadog-0.32.0.tar.gz
- Upload date:
- Size: 278.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2746dd41055805e7b41610de887444ccbe5ee38ed7cf118bc6ba34e23c5a2e73 |
|
| MD5 | 9aa5bb8e5cc296665aaf8b756278b759 |
|
| BLAKE2b-256 | 7531145522d23fa0b5d4d87e9bfc57f5361cadaa03e955daae307b639e400f6b |
File details
Details for the file datadog-0.32.0-py2.py3-none-any.whl.
File metadata
- Download URL: datadog-0.32.0-py2.py3-none-any.whl
- Upload date:
- Size: 82.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d97d85a8d2b90fe01f00b637a943c8b4a2d31928d7d4248610c8aab2292e8407 |
|
| MD5 | df5488b5046b4ea032c9e311cef537f5 |
|
| BLAKE2b-256 | b297595140f6f03a0196c702f79612383aeaf44198ad547f834c47d98cdd6945 |
