Setting Up Stackdriver Debugger for Node.js

Beta

This is a beta release of the Stackdriver Debugger agent for Node.js. This library might be changed in backward-incompatible ways and is not subject to any SLA or deprecation policy.

Note: Stackdriver Debugger is compatible with Node.js version 6 or greater. We recommend using the long-term support version.

This page describes how to configure your environment and your Node.js application to use Stackdriver Debugger. For some environments, you must explicitly specify the access scope to let the Stackdriver Debugger agent send data. We recommend setting the broadest possible access scope and then using Cloud Identity and Access Management to restrict access. In keeping with this best practice, set the access scope to be all Cloud APIs with the option cloud-platform.

App Engine

1. Use npm to install the package:

   npm install --save @google-cloud/debug-agent
   

2. Enable agent at the top of your app's main script or entry point (but after @google/cloud-trace if you are also using it):

   require('@google-cloud/debug-agent').start();
   

The debugger is now ready for use with your app.

To have the Debug page in the GCP Console automatically display source code matching the deployed app, see Selecting Source Code Automatically.

Google Kubernetes Engine

1. Create your cluster, with one of the following access scopes:
   • https://www.googleapis.com/auth/cloud-platform
   • https://www.googleapis.com/auth/cloud_debugger
   Note: You cannot change the access scopes of a cluster after creation.

   To create a cluster using gcloud, do the following:

   1. (Optional) Update gcloud to the latest version:

      gcloud components update

   2. Set your default project ID:

      gcloud config set project [PROJECT_ID]

   3. If you're working with zonal clusters, set your default compute zone:

      gcloud config set compute/zone [COMPUTE_ZONE]

   4. If you're working with regional clusters, set your default compute region:

      gcloud config set compute/region [COMPUTE_REGION]

   5. Issue the create command:

      gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/cloud-platform

   For more detailed information on creating a cluster, see Creating a cluster.

2. Follow the instructions for Compute Engine.

Compute Engine

1. Make sure your Compute Engine instances are created with the access scope option Allow full access to all Cloud APIs, or have one of the following access scopes:

   • https://www.googleapis.com/auth/cloud-platform
   • https://www.googleapis.com/auth/cloud_debugger

2. Use npm to install the package:

   npm install --save @google-cloud/debug-agent
   

3. Enable agent at the top of your app's main script or entry point (but after @google/cloud-trace if you are also using it):

   require('@google-cloud/debug-agent').start({
     serviceContext: {
       service: 'SERVICE',
       version: 'VERSION'
     }
   });
   

   Where:

   • SERVICE is a name for your app, such as MyApp, Backend, or Frontend.
   • VERSION is a version, such as v1.0, build_147, or v20170714.

   We recommend setting these from environment variables so you do not need to change the source code with each deployment.

The debugger is now ready for use with your app.

To have the Debug page in the GCP Console automatically display source code matching the deployed app, see Selecting Source Code Automatically.

Local and Elsewhere

1. Use npm to install the package:

   npm install --save @google-cloud/debug-agent
   

2. Download service account credentials.

   To use the Stackdriver Debugger agent for Node.js on machines not hosted by Google Cloud Platform, the agent must use a GCP service account credentials to authenticate with the Stackdriver Debugger Service.

   Use the GCP Console Service Accounts page to create a credentials file for an existing or new service account. The service account must have at least the Stackdriver Debugger Agent role.

3. Configure and enable the agent with the downloaded credentials:

   require('@google-cloud/debug-agent').start({
     projectId: 'your-project-id',
     keyFilename: '/path/to/key.json',
     serviceContext: {
       service: 'SERVICE',
       version: 'VERSION'
     }
   });
   

   Where:

   • SERVICE is a name for your app, such as MyApp, Backend, or Frontend.
   • VERSION is a version, such as v1.0, build_147, or v20170714.

   We recommend setting these from environment variables so you do not need to change the source code with each deployment.

The debugger is now ready for use with your app.

The Debug page in the GCP Console can display local source files, without upload, for local development. See Selecting Source Code Manually.

Note: You can find the debugger agent's code and documentation on GitHub.