The Datadog Python library
Project description
The Datadog Python library
===========================
[](https://travis-ci.org/DataDog/datadogpy)
[](https://readthedocs.org/projects/datadogpy/?badge=latest)
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](https://docs.datadoghq.com/developers/dogstatsd/).
- Library Documentation: http://datadogpy.readthedocs.org/en/latest/
- HTTP API Documentation: http://docs.datadoghq.com/api/
- DatadogHQ: http://datadoghq.com
See [CHANGELOG.md](CHANGELOG.md) for changes.
Installation
------------
To install from pip:
pip install datadog
To install from source:
python setup.py install
Quick Start Guide
-----------------
```python
# 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
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')
```
Thread Safety
-------------
`DogStatsD` and `ThreadStats` are thread-safe.
===========================
[](https://travis-ci.org/DataDog/datadogpy)
[](https://readthedocs.org/projects/datadogpy/?badge=latest)
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](https://docs.datadoghq.com/developers/dogstatsd/).
- Library Documentation: http://datadogpy.readthedocs.org/en/latest/
- HTTP API Documentation: http://docs.datadoghq.com/api/
- DatadogHQ: http://datadoghq.com
See [CHANGELOG.md](CHANGELOG.md) for changes.
Installation
------------
To install from pip:
pip install datadog
To install from source:
python setup.py install
Quick Start Guide
-----------------
```python
# 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
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')
```
Thread Safety
-------------
`DogStatsD` and `ThreadStats` are thread-safe.
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
datadog-0.24.0.tar.gz
(151.5 kB
view details)
File details
Details for the file datadog-0.24.0.tar.gz.
File metadata
- Download URL: datadog-0.24.0.tar.gz
- Upload date:
- Size: 151.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/2.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ed60b5f6058cd1706ab4da0dcde336d6851bf52f64206d3063fe30a7f0022b9c |
|
| MD5 | a6d42519a79ac2ad844b8275f966dae0 |
|
| BLAKE2b-256 | b1e5260810dfbf475c9c3d5c64027aecaad2d7e5d5b13c1211efb6d449577285 |
