Overview

This check collects profiles from Go applications which expose the /debug/pprof endpoint.

NOTE: Prefer instrumenting services with the dd-trace-go profiling client library. The client library offers better integration with other Datadog services, such as through code hotspots and endpoint filtering. Use this integration for services for which you do not control the source code.

NOTE: Using this integration results in billing for hosts under Datadog’s Continuous Profiler service. For more on Continuous Profiler billing, consult our billing documentation.

Setup

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the Autodiscovery Integration Templates for guidance on applying these instructions.

Installation

If you are using an Agent version >= 7.21/6.21, follow the instructions below to install the go_pprof_scraper check on your host. See the dedicated Agent guide for installing community integrations to install checks with an Agent version < v7.21/v6.21 or the Docker Agent:

1. Download and launch the Datadog Agent.

2. Run the following command to install the integrations wheel with the Agent:

   datadog-agent integration install -t datadog-go-pprof-scraper==<INTEGRATION_VERSION>
   

You can find the latest version on the Datadog Integrations Release Page

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

Configuration

1. Edit the go_pprof_scraper.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your Go performance data. See the sample go_pprof_scraper.d/conf.yaml for all available configuration options.

2. Restart the Agent.

Validation

Run the Agent’s status subcommand and look for go_pprof_scraper under the Checks section.

Data Collected

Metrics

The Go-pprof-scraper integration does not create any metrics.

Events

The Go-pprof-scraper integration does not include any events.

Service Checks

go_pprof_scraper.can_connect
Returns CRITICAL if the check cannot reach the pprof endpoint or if APM is not enabled, returns OK otherwise.
Statuses: ok, critical

Troubleshooting

Need help? Contact Datadog support.