This buildpack installs the Datadog Agent in your Heroku Dyno to collect system metrics, custom application metrics and traces. To collect custom application metrics or traces, include the language appropriate DogStatsD or Datadog APM library in your application. Note: Heroku buildpacks cannot be used with Docker images. To build a Docker image with Datadog, reference the Datadog Agent docker files.
To add this buildpack to your project, as well as set the required environment variables:
cd <root of my project> # If this is a new Heroku project heroku create # Add the appropriate language-specific buildpack. For example: heroku buildpacks:add heroku/ruby # Enable Heroku Labs Dyno Metadata heroku labs:enable runtime-dyno-metadata -a $(heroku apps:info|grep ===|cut -d' ' -f2) # Add this buildpack and set your Datadog API key heroku buildpacks:add --index 1 https://github.com/DataDog/heroku-buildpack-datadog.git heroku config:add DD_API_KEY=<your API key> # Deploy to Heroku git push heroku master
Once complete, the Datadog Agent is started automatically when each Dyno starts.
The Datadog Agent provides a listening port on 8125 for statsd/dogstatsd metrics and events. Traces are collected on port 8126.
In addition to the environment variables shown above, there are a number of others you can set:Setting Description
DD_API_KEYRequired. Your API key is available from the Datadog API integrations page. Note that this is the API key, not the application key.
DD_HOSTNAMEDeprecated. WARNING: Setting the hostname manually may result in metrics continuity errors. It is recommended that you do not set this variable. Because dyno hosts are ephemeral it is recommended that you monitor based on the tags
DD_DYNO_HOSTOptional. Set to
trueto use the app and dyno name (e.g.
appname.run.1234) as the hostname. See the hostname section below for more information. You must enable Heroku Labs Dyno Metadata to use this feature. Defaults to
DD_TAGSOptional. Sets additional tags provided as a comma-delimited string. For example,
heroku config:set DD_TAGS=simple-tag-0,tag-key-1:tag-value-1. The buildpack automatically adds the tags
dyno(the dyno name, e.g.
dynotype(the type of dyno, e.g
web). See the "Guide to tagging" for more information.
DD_HISTOGRAM_PERCENTILESOptional. Optionally set additional percentiles for your histogram metrics. See the Histogram percentiles article for more information.
DISABLE_DATADOG_AGENTOptional. When set, the Datadog Agent will not be run.
DD_APM_ENABLEDOptional. The Datadog Trace Agent (APM) is run by default. Set this to
falseto disable the Trace Agent.
DD_AGENT_VERSIONOptional. By default, the buildpack installs the latest version of the Datadog Agent available in the package repository. Use this variable to install older versions of the Datadog Agent (note that not all versions of the Agent may be available).
DD_SERVICE_ENVOptional. The Datadog Agent automatically tries to identify your environment by searching for a tag in the form
env:<environment name>. For more information, see the Datadog Tracing environments page.
For additional documentation, refer to the Datadog Agent documentation.
Heroku dynos are ephemeral—they can move to different host machines whenever new code is deployed, configuration changes are made, or resouce needs/availability changes. This makes Heroku flexible and responsive, but can potentially lead to a high number of reported hosts in Datadog. Datadog bills on a per-host basis, and the buildpack default is to report actual hosts, which can lead to higher than expected costs.
Depending on your use case, you may want to set your hostname so that hosts are aggregated and report a lower number. To do this, Set
true. This will cause the Agent to report the hostname as the app and dyno name (e.g.
appname.run.1234) and your host count will closely match your dyno usage. One drawback is that you may see some metrics continuity errors whenever a dyno is cycled.
You can enable Datadog Agent integrations by including an appropriately named YAML file inside a
datadog/conf.d directory in the root of your application.
For example, to enable the PostgreSQL integration, create a file
/datadog/conf.d/postgres.yaml in your application containing:
init_config: instances: - host: <YOUR POSTGRESQL SERVER HOSTNAME> port: 5432
During the Dyno start up, your YAML files will be copied to the appropriate Datadog Agent configuration directories.
This project is open source (Apache 2 License), which means we're happy for you to fork it, but we'd be even more excited to have you contribute back to it.
If you can't find anything useful, please contact our support team and send a flare. To send a flare, you'll need get to your Dyno's command line:
# From your project directory: heroku run bash # Once your Dyno has started and you are at the command line, send a flare: agent -c /app/.apt/etc/datadog-agent/datadog.yaml flare
It can also be helpful to send logs from your running dyno:
# Download Datadog Agent logs heroku ps:copy /app/.apt/var/log/datadog/datadog.log --dyno=<YOUR DYNO NAME> # Download Datadog Trace Agent logs heroku ps:copy /app/.apt/var/log/datadog/datadog-apm.log --dyno=<YOUR DYNO NAME>
Finally, you can open a Github issue.
Have you fixed a bug or written a new check and want to share it? Many thanks!
In order to ease/speed up our review, here are some items you can check/improve when submitting your PR:
Earlier versions of this project were forked from the miketheman heroku-buildpack-datadog project. It was largely rewritten for Datadog's Agent version 6. Changes and more information can be found in the changelog.
Copy the snippet above into CLI.