Use Community Integrations

Use Community Integrations

Overview

Community developed integrations for the Datadog Agent are stored in the Datadog integrations-extra Github repository. They are not packaged with the Agent, but can be installed as add-ons.

Setup

For new users, download and install the latest version of the Datadog Agent.

Installation

Choose your version of the Agent:

For Agent v7.21+ / v6.21+:

  1. Run the following command to install the Agent integration:

    datadog-agent integration install -t datadog-<INTEGRATION_NAME>==<INTEGRATION_VERSION>
    
  2. Configure your integration similar to core integrations.

  3. Restart the Agent.

Note: If necessary, prepend sudo -u dd-agent to the install command.

The recommended way to use a community integration with the Docker Agent is to build the Agent with the integration installed. Use the following Dockerfile to build an updated version of the Agent that includes the <INTEGRATION_NAME> from integrations-extras.

FROM gcr.io/datadoghq/agent:latest
RUN agent integration install -r -t datadog-<INTEGRATION_NAME>==<INTEGRATION_VERSION>

The agent integration install command run inside Docker issues the following harmless warning: Error loading config: Config File "datadog" Not Found in "[/etc/datadog-agent]": warn. This warning can be ignored.

Use this new Agent image in combination with Autodiscovery to enable the <INTEGRATION_NAME>.

For Agent < v7.21 / v6.21:

  1. Download the files in the <INTEGRATION_NAME>/datadog_checks/<INTEGRATION_NAME>/ folder from the integrations-extra repository.
  2. Place <INTEGRATION_NAME>.py and any other Python files in the Agent’s checks.d directory.
  3. Create a new <INTEGRATION_NAME>.d/ folder in your Agent configuration directory.
  4. Place the conf.yaml.example file from the <INTEGRATION_NAME>/datadog_checks/<INTEGRATION_NAME>/data/ folder in the created directory.
  5. Rename this file to conf.yaml.
  6. Configure your integration similar to core integrations.
  7. Restart the Agent.

Further Reading

Additional helpful documentation, links, and articles: