datadog-checks-base 3.0.0

The Datadog Check Toolkit

Datadog Checks Base

Overview

This package provides the Python bits needed by the Datadog Agent 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 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 and just run:

tox

Troubleshooting

Need help? Contact Datadog Support.