Profiling Node.js applications

This page describes how to modify your Node.js application to capture profiling data and have that data sent to your Google Cloud project. For general information about profiling, see Profiling concepts.

Profile types for Node.js:

• Heap
• Wall time

Supported Node.js language versions:

• Node.js 14 or higher
• For the Node.js release policy, see Release schedule.

Supported profiling agent versions:

• The most recent release of the agent is supported. In general, releases older than one year aren't supported. We recommend that you use the most recently released version of the agent.

Supported operating systems:

• Linux. Profiling Node.js applications is supported for Linux kernels whose standard C library is implemented with glibc or with musl. For configuration information specific to Linux Alpine kernels, see Running on Linux Alpine.

Supported environments:

• Compute Engine
• Google Kubernetes Engine (GKE)
• App Engine flexible environment
• App Engine standard environment
• Outside of Google Cloud (For information on the additional configuration requirements, see Profiling applications running outside of Google Cloud.)

Enabling the Profiler API

Before you use the profiling agent, ensure that the underlying Profiler API is enabled. You can check the status of the API and enable it if necessary by using either the Google Cloud CLI or the Google Cloud console: