The Datadog Check Toolkit
Project description
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 package is used in two scenarios:
-
When used from within the Python interpreter embedded in the Agent, it provides all the base classes and utilities needed by any Check.
-
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.
Please refer to the API docs for details.
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 datadog-checks-base
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.
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
Built Distribution
Hashes for datadog_checks_base-4.6.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4fed7e461e933fcd962537f51b286ddda6e572e72aab5e881808c23e6b3a5f39 |
|
MD5 | 487f5e65d186de85da71c1b7cd19d951 |
|
BLAKE2b-256 | 9b9abfa65fb254dd0f4fa6eea5b282fe84d62bf8e49ab75fbbbedf524b7e096f |