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 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.

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.5.0-py2.py3-none-any.whl (68.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file datadog_checks_base-1.5.0-py2.py3-none-any.whl.

File metadata

  • Download URL: datadog_checks_base-1.5.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 68.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.6.5

File hashes

Hashes for datadog_checks_base-1.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f6c6b563e8230d8a0d23f0fc220ac75278a56c28ad9b624a0c8861d785f14444
MD5 35e8bdcb1baf17764a92517e25a0abb7
BLAKE2b-256 4b27567e4e1dc8d0032414d12c3ce1a00db7564e220625197594008dede292fc

See more details on using hashes here.

Provenance

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