Skip to main content

The Datadog Check Toolkit

Project description

# Datadog Checks Base

## Overview

This package provides the Python bits needed by the [Datadog Agent][1]
to run Agent-based Integrations (also known as _Checks_).

This _Check toolkit_ is used in two scenarios:

1. When used from within the Python interpreter embedded in the Agent, it
provides all the base classes and utilities needed by any Check.

2. When installed in a local environment with a regular Python interpreter, it
mocks the presence of a running Agent so checks can work in standalone mode,
mostly useful for testing and development.

## Installation

Checks from [integrations-core][2] already
use the toolkit in a transparent way when you run the tests with Tox but you can
install the toolkit locally and play with it:
```
pip install git+https://github.com/DataDog/datadog-agent-tk.git
```

## Development

Create a dedicated virtualenv and follow the instructions in this paragraph
to work with the check.

To install the check in dev mode:
```
pip install -e .[dev]
```

To build the wheel package:
```
python setup.py bdist_wheel
```

To run the tests, [install tox][3] and just run:
```
tox
```

## Troubleshooting
Need help? Contact [Datadog Support][4].

## Further Reading
Learn more about infrastructure monitoring and all our integrations on [our blog][5]


[1]: https://github.com/DataDog/datadog-agent
[2]: https://github.com/DataDog/integrations-core
[3]: http://tox.readthedocs.io/en/latest/install.html
[4]: http://docs.datadoghq.com/help/
[5]: https://www.datadoghq.com/blog/


Project details


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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

datadog_checks_base-1.3.2-py2-none-any.whl (66.6 kB view details)

Uploaded Python 2

File details

Details for the file datadog_checks_base-1.3.2-py2-none-any.whl.

File metadata

File hashes

Hashes for datadog_checks_base-1.3.2-py2-none-any.whl
Algorithm Hash digest
SHA256 08ea3d16bfc6d2529756a88715d82dc8e7af9897655985d0c24d18294151f8a2
MD5 bf99bf6dcfe177e148ba9c4284aebe50
BLAKE2b-256 2b887c3556ffe381bd2ebbf07f1604797cef701c63cb3b6f194cf5a4a4966876

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page