VOOZH about

URL: https://docs.datadoghq.com/extend/integrations/build_integration/

⇱ Build an Integration with Datadog

For AI agents: A markdown version of this page is available at https://docs.datadoghq.com/extend/integrations/build_integration.md. A documentation index is available at /llms.txt.

Build an Integration with Datadog

Overview

This page walks Technology Partners through the specific steps to create and submit an integration or Marketplace offering to Datadog.

Getting started

Create a listing

  1. Navigate to Integrations > Developer Platform > Publishing and click New Listing.
  2. Select your offering type.
  3. Add a name for your offering.
  4. Click Create.

Fill out the overview

  1. Fill in the relevant details on the overview section such as your vendor name, vendor URL, short description, and apply appropriate tags.
  2. Upload a wordmark version of your logo in SVG format.
  3. Set your unique integration ID, which is used as the identifier for your integration.

Define and write your integration code

Follow the instructions to create either an Agent-based integration, or an API-based integration.

If you are creating an Agent-based integration, follow the steps outlined.

Agent-based integrations use the Datadog Agent to submit data through checks written by the developer.

Checks can emit metrics, events, and service checks into a customer’s Datadog account. The Agent itself can submit logs as well, but that is configured outside of the check. This code is hosted in GitHub.

The implementation code for these integrations is hosted by Datadog. Agent integrations are best suited for collecting data from systems or applications that live in a local area network (LAN) or virtual private cloud (VPC). Creating an Agent integration requires you to publish and deploy your solution as a Python wheel (.whl).

See Agent Check Documentation to learn how to set up an Agent Check and return to this page to proceed with the rest of the steps.

If you are creating an API-based integration, you are required to use OAuth. Follow the steps outlined.

OAuth is a standard that integrations can use to provide client applications with secure delegated access. OAuth works over HTTPS and authorizes devices, APIs, servers, and applications with access tokens rather than credentials.

See OAuth Client Documentation to set up your OAuth Integration and return to this page to proceed with the rest of the steps.

If your platform is incompatible with OAuth, reach out to the Datadog Ecosystems team for an exception.

Provide setup and uninstallation instructions

  1. Setup instructions guide users through the installation process; include any necessary configuration, authentication steps, or initial set up actions using a numbered list
  2. Uninstallation instructions guide users on how to properly uninstall the integration.

Define the data your integration interacts with

Information about the Datadog data types helps users understand what your integration does. If you are pulling data out of Datadog, specify the specific data type under the queried data section. If you are sending data to Datadog, specify the specific data type under the submitted data section. Certain fields may require more information.

If your integration sends in metrics:

  1. Set the metric check - a metric emitted on every run to inform users the integration is running.
  2. Upload a list of your metrics by filling in the metadata.csv file.

Example:

metric_namemetric_typeintervalunit_nameper_unit_namedescriptionorientationintegrationshort_namecurated_metricsample_tags
<partner_name>.<category>.<measurement>Select from the following listCollection interval in secondsSelect from following listUnit sub-divisionShort descriptionValue indicating trendintegration IDhuman-readable abbreviated version without integration nameinternal use, leave blanklist of example tags
datadog.system.cpu.usagegauge60percentThe percentage of total CPU used0datadogsys cpu usage“host_name,region”

If your integration sends in logs, a log pipeline is required.

  1. Follow the instructions to create a log pipeline.
  2. Upload the two exported files from the prior step.

Create integration-specific content

Datadog Integrations support out-of-the-box content that is ready to use upon installation. Include content such as dashboards, monitor templates, and SIEM detection rules to help users find value in your integration.

  1. Create and attach at least one dashboard to be offered with your integration.
    • Dashboards are required for all integrations. Follow Datadog’s best practices when creating a new dashboard.
  2. Create and attach other content.

Add support details

Provide contact details to your support team.

Add release notes

For the initial launch, leave it as is. For future updates, specify feature additions, changes, fixes, and removals as new versions.

Review and submit

  1. Preview your integration to ensure everything appears correctly.
  2. Once complete, submit it for review.
  3. The Datadog team will review and respond with feedback.

Further reading