Automatic configuration

Runtime metrics collection can be enabled with one configuration parameter in the tracing client either through the tracer option: tracer.init({ runtimeMetrics: true }) or through the environment variable: DD_RUNTIME_METRICS_ENABLED=true

export DD_RUNTIME_METRICS_ENABLED=true
export DD_ENV=prod
export DD_SERVICE=my-web-app
export DD_VERSION=1.0.3

const tracer = require('dd-trace').init({
  env: 'prod',
  service: 'my-web-app',
  version: '1.0.3',
  runtimeMetrics: true
})

Runtime metrics can be viewed in correlation with your Node services. See the Service Catalog in Datadog.

By default, runtime metrics from your application are sent to the Datadog Agent with DogStatsD over port 8125. Make sure that DogStatsD is enabled for the Agent. If you are running the Agent as a container, ensure that DD_DOGSTATSD_NON_LOCAL_TRAFFIC is set to true, and that port 8125 is open on the Agent. In Kubernetes, bind the DogstatsD port to a host port; in ECS, set the appropriate flags in your task definition.

Alternatively, the Agent can ingest metrics with a Unix Domain Socket (UDS) as an alternative to UDP transport. For more information, read DogStatsD over Unix Domain Socket.

Data Collected

The following metrics are collected by default after enabling runtime metrics.

Along with displaying these metrics in your APM Service Page, Datadog provides a default Node Runtime Dashboard.

Further Reading

Additional helpful documentation, links, and articles:

Connect your Logs and Traces togetherDOCUMENTATION Manually instrument your application to create traces.DOCUMENTATION Explore your services, resources, and tracesDOCUMENTATION