Skip to main content

The Datadog Check Toolkit

Project description

Datadog Checks Base

Latest PyPI version Supported Python versions

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 docs for details.

Installation

Checks from integrations-core already use the toolkit in a transparent way when you run the tests but you can install the toolkit locally and play with it:

pip install datadog-checks-base

Performance Optimizations

We strive to balance lean resource usage with a "batteries included" user experience. We employ a few tricks to achieve this.

One of them is the lazy-loader library that allows us to expose a nice API (simple, short imports) without the baseline memory overhead of importing everything all the time.

Another trick is to import some of our dependencies inside functions that use them instead of the more conventional import section at the top of the file. We rely on this the most in the AgentCheck base class.

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

If you're not sure about the file name format, learn more about wheel file names.

datadog_checks_base-37.37.0-py2.py3-none-any.whl (283.9 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for datadog_checks_base-37.37.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d3052c70d7cd8d98fcbd5c70d8b5c7d19429cd72d6fde283e334462f1a83c7b4
MD5 6eb1327754f8d2851bfd8f5c7e56c91a
BLAKE2b-256 5ee8cc6651a74c98f24bd02d4cc151fb26c1006e32df6f4da534a93554a634dd

See more details on using hashes here.

Provenance

The following attestation bundles were made for datadog_checks_base-37.37.0-py2.py3-none-any.whl:

Publisher: release-base.yml on DataDog/integrations-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page