DataDog/integrations-core

Name: integrations-core

Owner: Datadog, Inc.

Description: Core integrations of the datadog agent

Created: 2015-12-01 16:41:45.0

Updated: 2018-05-24 17:18:52.0

Pushed: 2018-05-24 16:56:05.0

Homepage: null

Size: 10001

Language: Python

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Datadog Agent Integrations - Core

Build Status Build status

This repository contains the Agent Integrations (also known as checks) that Datadog officially develops and supports. To add a new integration, please see the Integrations Extras repository and the accompanying documentation.

The Datadog Agent packages are equipped with all the checks from this repository, so to get started using them, you can simply install the Agent for your operating system.

General documentation about the project can be found here

Integrations as Python wheels

When working with an integration, you will now be dealing with a more structured python project. The new structure should help keep a more sane and modular codebase. To help with the transition, please take a look at the following map to understand where everything falls into place in the new approach.

| FORMER LOCATION | NEW LOCATION | | ————— | ———— | | {integration}/check.py | {integration}/datadog_checks/{integration}/{integration}.py | | {integration}/conf.yaml.example | {integration}/datadog_checks/{integration}/conf.yaml.example | | n/a | {integration}/datadog_checks/{integration}/__init__.py | | {integration}/test_check.py | {integration}/test/test_{integration}.py | | n/a | {integration}/test/__init__.py | | n/a | {integration}/setup.py |

A note about installing

Now that integrations are cleanly defined as python packages, we will soon be able to ship them as Python wheels that will be pip-installable in the Python environment embedded into the Datadog Agent. This presents a paradigm change in the way we will be delivering standalone integration upgrades, moving away from OS-specific packages to idiomatic Python package delivery.

Agent releases starting from version 5.21 bundle the latest wheels for any integration, but at the moment you can't upgrade or downgrade between releases.

Quick Start

Working with integrations is easy, the main page of the development docs contains all the info you need to get your dev enviroment up and running in minutes to run, test and build a Check.

Important: the instructions are only valid for a subset of the Checks in this repository. Making all the checks work with the new build and test strategy is a work in progress. You can find the list of the checks already updated here

Reporting Issues

For more information on integrations, please reference our documentation and knowledge base. You can also visit our help page to connect with us.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.