Skip to main content

The Datadog Check Toolkit

Project description

Datadog Checks Base

Latest PyPI version Supported Python versions Documentation Status

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:

  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.

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

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

Built Distribution

datadog_checks_base-9.0.0-py2.py3-none-any.whl (115.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: datadog_checks_base-9.0.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 115.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for datadog_checks_base-9.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c924a7e812a6b91e1f9411d2b228885d34b4e529d764e6b2fe235b164e8ea84d
MD5 bb66dec589d902eed999caf8aa9f0895
BLAKE2b-256 3eae0fccc51e6aaead0063c73876c085b516313e3ece13787efb151eeb05457f

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