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/
## 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/
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
File details
Details for the file datadog_checks_base-1.3.1-py2-none-any.whl.
File metadata
- Download URL: datadog_checks_base-1.3.1-py2-none-any.whl
- Upload date:
- Size: 66.6 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a14b66687095c29cae1187395f342bd83c26d79e28ab0955f4a49a10817e105e |
|
| MD5 | 38adf43b1b0e7f7710b47b982de02ec4 |
|
| BLAKE2b-256 | 949133f4fc39fed0ed87053e02c0d748a86a9185b8da184c407aa5776094f4b6 |
