This is a guide for using integrations, if you are looking for information about building a new integration, see the Create a new integration page.
An integration, at the highest level, is when you assemble a unified system from units that are usually considered separately. At Datadog, you can use integrations to bring together all of the metrics and logs from your infrastructure and gain insight into the unified system as a whole — you can see pieces individually and also how individual pieces are impacting the whole.
Note: It’s best to start collecting metrics on your projects as early in the development process as possible, but you can start at any stage.
Datadog provides three main types of integrations:
checkto define the metrics to collect.
You can also build a custom check to define and send metrics to Datadog from your unique in-house system.
The Datadog Agent package includes integrations officially supported by Datadog, in integrations core. To use the integrations in integrations core, download the Datadog agent. Community-based integrations are in integrations extras, and to use those, you need to download the developer toolkit. For more information on installing or managing these integrations, see the integrations management guide.
In order to install the Datadog Agent, you need an API key. If the Agent is already downloaded, make sure to set up the API key in the
datadog.yaml file. To use most additional Datadog functionality besides submitting metrics and events, you need an application key. You can manage your accounts API and application keys in the API Settings page of the UI.
If you want to connect with a crawler or library based integration, navigate to that provider on the Integrations page for specific instructions on how to connect. For other supported integrations, install the Datadog Agent. Most integrations are supported on our containerized agents: Docker, and Kubernetes. After you’ve downloaded the Agent, go to the Integrations page section to find specific configuration instructions for individual integrations.
Configurations are specific to individual integrations. In the
conf.d/<INTEGRATION_NAME>.d folder at the root of your Agent’s configuration directory, there is a folder named
<INTEGRATION_NAME>.d for each officially supported Agent integration which contains a sample
conf.yaml.example that lists all available configuration options for this particular integration.
To activate a given integration:
conf.yaml.examplefile (in the corresponding
Note: All configuration files follow the format documented in the parameters documentation.
For example, this is the minimum
conf.yaml configuration file needed to collect metrics and logs from the apache integration:
init_config: instances: - apache_status_url: http://localhost/server-status?auto logs: - type: file path: /var/log/apache2/access.log source: apache sourcecategory: http_web_access service: apache - type: file path: /var/log/apache2/error.log source: apache sourcecategory: http_web_access
To create multiple instances in the same Agent check to monitor two Apache services, create a new instance with a
- in the
init_config: instances: - apache_status_url: http://localhost/server-status?auto - apache_status_url: http://<REMOTE_APACHE_ENDPOINT>/server-status?auto
Tagging is a key part of filtering and aggregating the data coming into Datadog across many sources. You can assign tags in configuration files, in environment variables, in the UI, the API, and in DogStatsD. If you define tags in the
datadog.yaml file, the tags are applied to all of your integrations data. Once you’ve defined the tag in
datadog.yaml, all new integrations inherit it. If you use a tag environment variable, it applies to all integrations. If you define tags in the corresponding integrations configuration file, it only applies to that specific integration. If you use tags in containers, it applies only to that container. For more information about tagging, see Getting started with tags.
To validate your Agent and integrations configuration, run the Agent’s
status subcommand, and look for new configuration under the Checks section.
Installing more than one integration is a matter of adding the configuration information to a new
conf.yaml file in the corresponding
<INTEGRATIONS>.d folder. Look up the required parameters for the new integration from the
conf.yaml.example file, add it into the new
conf.yaml file, and then follow the same steps to validate your configuration.
For information on how Datadog handles your data, and other security considerations, see our Security documentation.
Now that you have your first integrations set up, you can start exploring all of the metrics being sent by Datadog to your application, and use these metrics to begin setting up dashboards and alerts to monitor your data.
The first step to troubleshooting an integration is to use a plugin in your code editor or use one of the many online tools to verify that the YAML is valid. The next step is to run through all of the Agent troubleshooting steps.
If you continue to have problems, reach out to our awesome Support team.
|conf.yaml||You create the |
|custom check||If you have a unique system that you want to monitor, or if you’re going to expand the metrics already sent by an integration, you can build a custom check to define and send metrics to Datadog. However, if you want to monitor a generally available application, public service, or an open source project, and we don’t have an integration that already exists for it, you should consider building a new integration instead of a custom check.|
|datadog.yaml||This is the main configuration file where you’re defining how the Agent as a whole interacts with its own integrations and with your system. Use this file to update API keys, Proxys, host tags, and other global settings.|
|event||Events are informational messages about your system that are consumed by the events stream so that you can build monitors on them.|
|instance||You define and map the instance of whatever you are monitoring in the |
|integration_name.d||If you have a complex configuration, you can break it down into multiple |
|logging||If the system you are monitoring has logs, you can customize the logs you are sending to Datadog and use our Logging Management solution to manage and analyze them.|
|metadata.csv||The file that lists and stores the metrics collected by each integration.|
|metrics||The list of what is collected from your system by each integration. You can find the metrics for each integration in that integrations |
|parameters||Use the parameters in the |
|service check||Service checks are a type of monitor used to track the uptime status of the service. For more information, see the Service checks guide.|
|tagging||Tags are a way to add customization to metrics so that you can filter and visualize them in the most useful way to you.|